Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::PacketMirroring (v1.7.1)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#collector_ilb

def collector_ilb() -> ::Google::Cloud::Compute::V1::PacketMirroringForwardingRuleInfo

Returns

(::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.

#collector_ilb=

def collector_ilb=(value) -> ::Google::Cloud::Compute::V1::PacketMirroringForwardingRuleInfo

Parameter

value (::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.

Returns

(::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

def creation_timestamp() -> ::String

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String

Parameter

value (::String) — [Output Only] Creation timestamp in RFC3339 text format.

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String

Returns

(::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String

Parameter

value (::String) — An optional description of this resource. Provide this property when you create the resource.

Returns

(::String) — An optional description of this resource. Provide this property when you create the resource.

#enable

def enable() -> ::String

Returns

(::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.

#enable=

def enable=(value) -> ::String

Parameter

value (::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.

Returns

(::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

def filter() -> ::Google::Cloud::Compute::V1::PacketMirroringFilter

Returns

(::Google::Cloud::Compute::V1::PacketMirroringFilter) — Filter for mirrored traffic. If unspecified, all traffic is mirrored.

#filter=

def filter=(value) -> ::Google::Cloud::Compute::V1::PacketMirroringFilter

Parameter

value (::Google::Cloud::Compute::V1::PacketMirroringFilter) — Filter for mirrored traffic. If unspecified, all traffic is mirrored.

Returns

(::Google::Cloud::Compute::V1::PacketMirroringFilter) — Filter for mirrored traffic. If unspecified, all traffic is mirrored.

#id

def id() -> ::Integer

Returns

(::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer

Parameter

value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns

(::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String

Returns

(::String) — [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.

Returns

(::String) — [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.

#mirrored_resources

def mirrored_resources() -> ::Google::Cloud::Compute::V1::PacketMirroringMirroredResourceInfo

Returns

(::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.

#mirrored_resources=

def mirrored_resources=(value) -> ::Google::Cloud::Compute::V1::PacketMirroringMirroredResourceInfo

Parameter

value (::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.

Returns

(::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

def name() -> ::String

Returns

(::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.

#name=

def name=(value) -> ::String

Parameter

value (::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.

Returns

(::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

def network() -> ::Google::Cloud::Compute::V1::PacketMirroringNetworkInfo

Returns

(::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.

#network=

def network=(value) -> ::Google::Cloud::Compute::V1::PacketMirroringNetworkInfo

Parameter

value (::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.

Returns

(::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

def priority() -> ::Integer

Returns

(::Integer) — 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.

#priority=

def priority=(value) -> ::Integer

Parameter

value (::Integer) — 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

(::Integer) — 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

def region() -> ::String

Returns

(::String) — [Output Only] URI of the region where the packetMirroring resides.

#region=

def region=(value) -> ::String

Parameter

value (::String) — [Output Only] URI of the region where the packetMirroring resides.

Returns

(::String) — [Output Only] URI of the region where the packetMirroring resides.

#self_link

def self_link() -> ::String

Returns

(::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String

Parameter

value (::String) — [Output Only] Server-defined URL for the resource.

Returns

(::String) — [Output Only] Server-defined URL for the resource.