Class: Google::Apis::ComputeBeta::PacketMirroring

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PacketMirroring

Returns a new instance of PacketMirroring.



24001
24002
24003
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24001

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#collector_ilb ⇒ Google::Apis::ComputeBeta::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. Corresponds to the JSON property collectorIlb

Returns:



23922
23923
23924
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23922

def collector_ilb
  @collector_ilb
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


23927
23928
23929
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23927

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


23933
23934
23935
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23933

def description
  @description
end

#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. Corresponds to the JSON property enable

Returns:

  • (String) 


23940
23941
23942
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23940

def enable
  @enable
end

#filter ⇒ Google::Apis::ComputeBeta::PacketMirroringFilter

Filter for mirrored traffic. If unspecified, all traffic is mirrored. Corresponds to the JSON property filter

Returns:



23945
23946
23947
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23945

def filter
  @filter
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


23951
23952
23953
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23951

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. Corresponds to the JSON property kind

Returns:

  • (String) 


23957
23958
23959
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23957

def kind
  @kind
end

#mirrored_resources ⇒ Google::Apis::ComputeBeta::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. Corresponds to the JSON property mirroredResources

Returns:



23964
23965
23966
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23964

def mirrored_resources
  @mirrored_resources
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


23974
23975
23976
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23974

def name
  @name
end

#network ⇒ Google::Apis::ComputeBeta::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. Corresponds to the JSON property network

Returns:



23981
23982
23983
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23981

def network
  @network
end

#priority ⇒ Fixnum

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. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


23989
23990
23991
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23989

def priority
  @priority
end

#region ⇒ String

[Output Only] URI of the region where the packetMirroring resides. Corresponds to the JSON property region

Returns:

  • (String) 


23994
23995
23996
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23994

def region
  @region
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


23999
24000
24001
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23999

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



24006
24007
24008
24009
24010
24011
24012
24013
24014
24015
24016
24017
24018
24019
24020
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24006

def update!(**args)
  @collector_ilb = args[:collector_ilb] if args.key?(:collector_ilb)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @enable = args[:enable] if args.key?(:enable)
  @filter = args[:filter] if args.key?(:filter)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @mirrored_resources = args[:mirrored_resources] if args.key?(:mirrored_resources)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @priority = args[:priority] if args.key?(:priority)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
end