Class: Google::Apis::ComputeAlpha::PacketMirroring

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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.



27615
27616
27617
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27615

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

Instance Attribute Details

#collector_ilb ⇒ Google::Apis::ComputeAlpha::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:



27531
27532
27533
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27531

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) 


27536
27537
27538
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27536

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) 


27542
27543
27544
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27542

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) 


27549
27550
27551
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27549

def enable
  @enable
end

#filter ⇒ Google::Apis::ComputeAlpha::PacketMirroringFilter

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

Returns:



27554
27555
27556
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27554

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) 


27560
27561
27562
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27560

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) 


27566
27567
27568
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27566

def kind
  @kind
end

#mirrored_resources ⇒ Google::Apis::ComputeAlpha::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:



27573
27574
27575
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27573

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) 


27583
27584
27585
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27583

def name
  @name
end

#network ⇒ Google::Apis::ComputeAlpha::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:



27590
27591
27592
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27590

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) 


27598
27599
27600
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27598

def priority
  @priority
end

#region ⇒ String

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

Returns:

  • (String) 


27603
27604
27605
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27603

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


27608
27609
27610
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27608

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


27613
27614
27615
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27613

def self_link_with_id
  @self_link_with_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27620
27621
27622
27623
27624
27625
27626
27627
27628
27629
27630
27631
27632
27633
27634
27635
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27620

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)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
end