REST Resource: projects.locations.ullMirroringCollectors

Resource: UllMirroringCollector

Message describing UllMirroringCollector object

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "forwardingRule": string,
  "engine": string,
  "state": enum (State),
  "reconciling": boolean,
  "producerPolicy": enum (ProducerPolicy)
}
Fields
name

string

Immutable. Identifier. The name of the UllMirroringCollector.

createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

forwardingRule

string

Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}

engine

string

Required. Immutable. The engine resource to which the collector points to. Format is: projects/{project}/locations/{location}/ullMirroringEngines/{ullMirroringEngine}

state

enum (State)

Output only. Current state of the collector.

reconciling

boolean

Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.

producerPolicy

enum (ProducerPolicy)

Output only. Administrative policy set by the service producer.

State

UllMirroringCollector state. New values may be added to this enum in the future.

Enums
STATE_UNSPECIFIED Not set.
ACTIVE Ready.
CREATING Being created.
DELETING Being deleted.
CLOSED Indicates the collector is disabled due to a breaking change in another resource.
INACTIVE Inactive. Collector is not processing traffic.

ProducerPolicy

Policy state set administratively by the service producer. New values may be added to this enum in the future.

Enums
PRODUCER_POLICY_UNSPECIFIED Unspecified policy state.
ENABLED Normal operational state. Collector is enabled.
DISABLED Emergency override state. Packet delivery to the Collector is administratively disabled. Used in emergency situations to protect compute and network infrastructure from severe traffic overload.

Methods

create

Creates a new UllMirroringCollector in a given project and location.

delete

Deletes a single UllMirroringCollector.

disable

Disables a single UllMirroringCollector.

enable

Enables a single UllMirroringCollector.

get

Gets details of a single UllMirroringCollector.

list

Lists UllMirroringCollectors in a given project and location.

patch

Updates a single UllMirroringCollector.