Class: Google::Apis::ComputeV1::InterconnectAttachment

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



10188
10189
10190
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10188

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) 


10031
10032
10033
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10031

def admin_enabled
  @admin_enabled
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 PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. Corresponds to the JSON property bandwidth

Returns:

  • (String) 


10039
10040
10041
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10039

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>) 


10050
10051
10052
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10050

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) 


10056
10057
10058
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10056

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) 


10061
10062
10063
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10061

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) 


10067
10068
10069
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10067

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) 


10072
10073
10074
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10072

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) 


10082
10083
10084
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10082

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) 


10088
10089
10090
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10088

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) 


10094
10095
10096
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10094

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) 


10100
10101
10102
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10100

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) 


10106
10107
10108
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10106

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


10116
10117
10118
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10116

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) 


10122
10123
10124
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10122

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) 


10130
10131
10132
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10130

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) 


10137
10138
10139
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10137

def partner_asn
  @partner_asn
end

#partner_metadata ⇒ Google::Apis::ComputeV1::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:



10144
10145
10146
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10144

def partner_metadata
  @partner_metadata
end

#private_interconnect_info ⇒ Google::Apis::ComputeV1::InterconnectAttachmentPrivateInfo

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

Returns:



10150
10151
10152
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10150

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) 


10157
10158
10159
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10157

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) 


10165
10166
10167
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10165

def router
  @router
end

#self_link ⇒ String

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

Returns:

  • (String) 


10170
10171
10172
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10170

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) 


10175
10176
10177
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10175

def state
  @state
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


10180
10181
10182
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10180

def type
  @type
end

#vlan_tag8021q ⇒ Fixnum

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. Corresponds to the JSON property vlanTag8021q

Returns:

  • (Fixnum) 


10186
10187
10188
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10186

def vlan_tag8021q
  @vlan_tag8021q
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10193

def update!(**args)
  @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled)
  @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)
  @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