REST Resource: projects.locations.ullMirroringCollectors.rules

Resource: UllMirroringCollectorRule

UllMirroringCollectorRule is a resource that defines what traffic should be mirrored.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "match": {
    object (Match)
  },
  "reconciling": boolean
}
Fields
name

string

Identifier. The name of the UllMirroringCollectorRule.

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" }.

match

object (Match)

Required. Match defines what traffic to mirror.

reconciling

boolean

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

Match

Match defines the traffic filtering criteria.

JSON representation
{
  "srcIpRanges": [
    string
  ],
  "dstIpRanges": [
    string
  ],
  "ipProtocols": [
    string
  ],
  "direction": enum (Direction),
  "primaryIpRanges": [
    string
  ]
}
Fields
srcIpRanges[]

string

Optional. Source IP ranges to match. When unset, matches any source IP range.

dstIpRanges[]

string

Optional. Destination IP ranges to match. When unset, matches any destination IP range.

ipProtocols[]

string

Optional. IP protocols to match. When unset, matches any IP protocol. Examples: "tcp", "udp", "icmp". If unset, matches any IP protocol.

direction

enum (Direction)

Optional. Direction of traffic to match. When unset, matches any direction.

primaryIpRanges[]

string

Optional. Primary IP ranges to match (for the capture point). When unset, matches any primary IP.

Direction

Direction defines the direction of traffic. This enum is frozen; no new values will be added.

Enums
DIRECTION_UNSPECIFIED Not set. Matches any direction.
INGRESS Traffic inbound to the capture point.
EGRESS Traffic outbound from the capture point.

Methods

create

Creates a new UllMirroringCollectorRule for a given UllMirroringCollector.

delete

Deletes a single UllMirroringCollectorRule for a given UllMirroringCollector.

get

Gets details of a single UllMirroringCollectorRule.

list

Lists UllMirroringCollectorRules for a given UllMirroringCollector.

patch

Updates a single UllMirroringCollectorRule.