Class: Google::Apis::ComputeAlpha::InterconnectAttachment

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

Overview

Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta. interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ InterconnectAttachment

Returns a new instance of InterconnectAttachment



12507
12508
12509
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12507

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

Instance Attribute Details

#admin_enabled ⇒ Boolean Also known as: admin_enabled?

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. Corresponds to the JSON property adminEnabled

Returns:

  • (Boolean) 


12325
12326
12327
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12325

def admin_enabled
  @admin_enabled
end

#availability_zone ⇒ String

[Deprecated] Replaced by edge_availability_domain. Corresponds to the JSON property availabilityZone

Returns:

  • (String) 


12331
12332
12333
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12331

def availability_zone
  @availability_zone
end

#bandwidth ⇒ String

Provisioned bandwidth capacity for the interconnectAttachment. Can be set by the partner to update the customer's provisioned bandwidth. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. Corresponds to the JSON property bandwidth

Returns:

  • (String) 


12338
12339
12340
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12338

def bandwidth
  @bandwidth
end

#candidate_subnets ⇒ Array<String>

Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be / 29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible / 29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. Corresponds to the JSON property candidateSubnets

Returns:

  • (Array<String>) 


12349
12350
12351
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12349

def candidate_subnets
  @candidate_subnets
end

#cloud_router_ip_address ⇒ String

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. Corresponds to the JSON property cloudRouterIpAddress

Returns:

  • (String) 


12355
12356
12357
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12355

def cloud_router_ip_address
  @cloud_router_ip_address
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


12360
12361
12362
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12360

def creation_timestamp
  @creation_timestamp
end

#customer_router_ip_address ⇒ String

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. Corresponds to the JSON property customerRouterIpAddress

Returns:

  • (String) 


12366
12367
12368
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12366

def customer_router_ip_address
  @customer_router_ip_address
end

#description ⇒ String

An optional description of this resource. Corresponds to the JSON property description

Returns:

  • (String) 


12371
12372
12373
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12371

def description
  @description
end

#edge_availability_domain ⇒ String

Desired availability domain for the attachment. Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with one per availability domain. The selected availability domain will be provided to the Partner via the pairing key so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. Corresponds to the JSON property edgeAvailabilityDomain

Returns:

  • (String) 


12381
12382
12383
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12381

def edge_availability_domain
  @edge_availability_domain
end

#google_reference_id ⇒ String

[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. Corresponds to the JSON property googleReferenceId

Returns:

  • (String) 


12387
12388
12389
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12387

def google_reference_id
  @google_reference_id
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) 


12393
12394
12395
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12393

def id
  @id
end

#interconnect ⇒ String

URL of the underlying Interconnect object that this attachment's traffic will traverse through. Corresponds to the JSON property interconnect

Returns:

  • (String) 


12399
12400
12401
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12399

def interconnect
  @interconnect
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. Corresponds to the JSON property kind

Returns:

  • (String) 


12405
12406
12407
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12405

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


12417
12418
12419
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12417

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


12424
12425
12426
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12424

def labels
  @labels
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) 


12434
12435
12436
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12434

def name
  @name
end

#operational_status ⇒ String

[Output Only] The current status of whether or not this interconnect attachment is functional. Corresponds to the JSON property operationalStatus

Returns:

  • (String) 


12440
12441
12442
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12440

def operational_status
  @operational_status
end

#pairing_key ⇒ String

[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/ domain" Corresponds to the JSON property pairingKey

Returns:

  • (String) 


12448
12449
12450
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12448

def pairing_key
  @pairing_key
end

#partner_asn ⇒ Fixnum

Optional BGP ASN for the router that should be supplied by a layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. Corresponds to the JSON property partnerAsn

Returns:

  • (Fixnum) 


12455
12456
12457
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12455

def partner_asn
  @partner_asn
end

#partner_metadata ⇒ Google::Apis::ComputeAlpha::InterconnectAttachmentPartnerMetadata

Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. Corresponds to the JSON property partnerMetadata

Returns:



12462
12463
12464
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12462

def partner_metadata
  @partner_metadata
end

#private_interconnect_info ⇒ Google::Apis::ComputeAlpha::InterconnectAttachmentPrivateInfo

Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. Corresponds to the JSON property privateInterconnectInfo

Returns:



12468
12469
12470
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12468

def private_interconnect_info
  @private_interconnect_info
end

#region ⇒ String

[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property region

Returns:

  • (String) 


12475
12476
12477
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12475

def region
  @region
end

#router ⇒ String

URL of the cloud router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. Corresponds to the JSON property router

Returns:

  • (String) 


12483
12484
12485
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12483

def router
  @router
end

#self_link ⇒ String

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

Returns:

  • (String) 


12488
12489
12490
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12488

def self_link
  @self_link
end

#state ⇒ String

[Output Only] The current state of this attachment's functionality. Corresponds to the JSON property state

Returns:

  • (String) 


12493
12494
12495
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12493

def state
  @state
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


12498
12499
12500
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12498

def type
  @type
end

#vlan_tag8021q ⇒ Fixnum

Available only for DEDICATED and PARTNER_PROVIDER. Desired VLAN tag for this attachment, in the range 2-4094. This field refers to 802.1q VLAN tag, also known as IEEE 802.1Q Only specified at creation time. Corresponds to the JSON property vlanTag8021q

Returns:

  • (Fixnum) 


12505
12506
12507
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12505

def vlan_tag8021q
  @vlan_tag8021q
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 12512

def update!(**args)
  @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled)
  @availability_zone = args[:availability_zone] if args.key?(:availability_zone)
  @bandwidth = args[:bandwidth] if args.key?(:bandwidth)
  @candidate_subnets = args[:candidate_subnets] if args.key?(:candidate_subnets)
  @cloud_router_ip_address = args[:cloud_router_ip_address] if args.key?(:cloud_router_ip_address)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @customer_router_ip_address = args[:customer_router_ip_address] if args.key?(:customer_router_ip_address)
  @description = args[:description] if args.key?(:description)
  @edge_availability_domain = args[:edge_availability_domain] if args.key?(:edge_availability_domain)
  @google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id)
  @id = args[:id] if args.key?(:id)
  @interconnect = args[:interconnect] if args.key?(:interconnect)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @operational_status = args[:operational_status] if args.key?(:operational_status)
  @pairing_key = args[:pairing_key] if args.key?(:pairing_key)
  @partner_asn = args[:partner_asn] if args.key?(:partner_asn)
  @partner_metadata = args[:partner_metadata] if args.key?(:partner_metadata)
  @private_interconnect_info = args[:private_interconnect_info] if args.key?(:private_interconnect_info)
  @region = args[:region] if args.key?(:region)
  @router = args[:router] if args.key?(:router)
  @self_link = args[:self_link] if args.key?(:self_link)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
  @vlan_tag8021q = args[:vlan_tag8021q] if args.key?(:vlan_tag8021q)
end