Compute V1 Client - Class PacketMirroring (1.12.1)

Version 1.12.1

• 1.21.0 (latest)
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

Reference documentation and code samples for the Compute V1 Client class PacketMirroring.

Represents a Packet Mirroring resource. Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring.

Generated from protobuf message google.cloud.compute.v1.PacketMirroring

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ collector_ilb	Google\Cloud\Compute\V1\PacketMirroringForwardingRuleInfo The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
↳ creation_timestamp	string [Output Only] Creation timestamp in RFC3339 text format.
↳ description	string An optional description of this resource. Provide this property when you create the resource.
↳ enable	string Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. Check the Enable enum for the list of possible values.
↳ filter	Google\Cloud\Compute\V1\PacketMirroringFilter Filter for mirrored traffic. If unspecified, all traffic is mirrored.
↳ id	int|string [Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind	string [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
↳ mirrored_resources	Google\Cloud\Compute\V1\PacketMirroringMirroredResourceInfo PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
↳ name	string Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
↳ network	Google\Cloud\Compute\V1\PacketMirroringNetworkInfo Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
↳ priority	int The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
↳ region	string [Output Only] URI of the region where the packetMirroring resides.
↳ self_link	string [Output Only] Server-defined URL for the resource.

getCollectorIlb

The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.

Returns
Type	Description
Google\Cloud\Compute\V1\PacketMirroringForwardingRuleInfo|null

hasCollectorIlb

clearCollectorIlb

setCollectorIlb

The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\PacketMirroringForwardingRuleInfo

Returns
Type	Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type	Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type	Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEnable

Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.

Check the Enable enum for the list of possible values.

Returns
Type	Description
string

hasEnable

clearEnable

setEnable

Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.

Check the Enable enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Filter for mirrored traffic. If unspecified, all traffic is mirrored.

Returns
Type	Description
Google\Cloud\Compute\V1\PacketMirroringFilter|null

hasFilter

clearFilter

setFilter

Filter for mirrored traffic. If unspecified, all traffic is mirrored.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\PacketMirroringFilter

Returns
Type	Description
$this

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type	Description
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getKind

[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.

Returns
Type	Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMirroredResources

PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.

Returns
Type	Description
Google\Cloud\Compute\V1\PacketMirroringMirroredResourceInfo|null

hasMirroredResources

clearMirroredResources

setMirroredResources

PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\PacketMirroringMirroredResourceInfo

Returns
Type	Description
$this

getName

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type	Description
string

hasName

clearName

setName

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getNetwork

Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.

Returns
Type	Description
Google\Cloud\Compute\V1\PacketMirroringNetworkInfo|null

hasNetwork

clearNetwork

setNetwork

Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\PacketMirroringNetworkInfo

Returns
Type	Description
$this

getPriority

The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.

Returns
Type	Description
int

hasPriority

clearPriority

setPriority

The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getRegion

[Output Only] URI of the region where the packetMirroring resides.

Returns
Type	Description
string

hasRegion

clearRegion

setRegion

[Output Only] URI of the region where the packetMirroring resides.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSelfLink

[Output Only] Server-defined URL for the resource.

Returns
Type	Description
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this