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



12145
12146
12147
# File 'generated/google/apis/compute_alpha/classes.rb', line 12145

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

Instance Attribute Details

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


11963
11964
11965
# File 'generated/google/apis/compute_alpha/classes.rb', line 11963

def admin_enabled
  @admin_enabled
end

#availability_zoneString

Corresponds to the JSON property availabilityZone

Returns:

  • (String)


11969
11970
11971
# File 'generated/google/apis/compute_alpha/classes.rb', line 11969

def availability_zone
  @availability_zone
end

#bandwidthString

Corresponds to the JSON property bandwidth

Returns:

  • (String)


11974
11975
11976
# File 'generated/google/apis/compute_alpha/classes.rb', line 11974

def bandwidth
  @bandwidth
end

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


11985
11986
11987
# File 'generated/google/apis/compute_alpha/classes.rb', line 11985

def candidate_subnets
  @candidate_subnets
end

#cloud_router_ip_addressString

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


11991
11992
11993
# File 'generated/google/apis/compute_alpha/classes.rb', line 11991

def cloud_router_ip_address
  @cloud_router_ip_address
end

#creation_timestampString

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

Returns:

  • (String)


11996
11997
11998
# File 'generated/google/apis/compute_alpha/classes.rb', line 11996

def creation_timestamp
  @creation_timestamp
end

#customer_router_ip_addressString

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


12002
12003
12004
# File 'generated/google/apis/compute_alpha/classes.rb', line 12002

def customer_router_ip_address
  @customer_router_ip_address
end

#descriptionString

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

Returns:

  • (String)


12007
12008
12009
# File 'generated/google/apis/compute_alpha/classes.rb', line 12007

def description
  @description
end

#edge_availability_domainString

Desired availability domain for the attachment. Can only be specified when creating PARTNER-type InterconnectAttachments. 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)


12018
12019
12020
# File 'generated/google/apis/compute_alpha/classes.rb', line 12018

def edge_availability_domain
  @edge_availability_domain
end

#google_reference_idString

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


12024
12025
12026
# File 'generated/google/apis/compute_alpha/classes.rb', line 12024

def google_reference_id
  @google_reference_id
end

#idFixnum

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

Returns:

  • (Fixnum)


12030
12031
12032
# File 'generated/google/apis/compute_alpha/classes.rb', line 12030

def id
  @id
end

#interconnectString

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

Returns:

  • (String)


12036
12037
12038
# File 'generated/google/apis/compute_alpha/classes.rb', line 12036

def interconnect
  @interconnect
end

#kindString

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

Returns:

  • (String)


12042
12043
12044
# File 'generated/google/apis/compute_alpha/classes.rb', line 12042

def kind
  @kind
end

#label_fingerprintString

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)


12054
12055
12056
# File 'generated/google/apis/compute_alpha/classes.rb', line 12054

def label_fingerprint
  @label_fingerprint
end

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


12061
12062
12063
# File 'generated/google/apis/compute_alpha/classes.rb', line 12061

def labels
  @labels
end

#nameString

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


12071
12072
12073
# File 'generated/google/apis/compute_alpha/classes.rb', line 12071

def name
  @name
end

#operational_statusString

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

Returns:

  • (String)


12077
12078
12079
# File 'generated/google/apis/compute_alpha/classes.rb', line 12077

def operational_status
  @operational_status
end

#pairing_keyString

[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. Opaque string identifying an PARTNER attachment. Of the form ? cloud-region/XXXXXX?. Corresponds to the JSON property pairingKey

Returns:

  • (String)


12084
12085
12086
# File 'generated/google/apis/compute_alpha/classes.rb', line 12084

def pairing_key
  @pairing_key
end

#partner_asnFixnum

[Output only for PARTNER. Input for PARTNER_PROVIDER. Not present for DEDICATED] BGP ASN of the Partner. A layer 3 Partner should supply this if they configured BGP on behalf of the customer. Corresponds to the JSON property partnerAsn

Returns:

  • (Fixnum)


12091
12092
12093
# File 'generated/google/apis/compute_alpha/classes.rb', line 12091

def partner_asn
  @partner_asn
end

#partner_metadataGoogle::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. Only mutable for PARTNER_PROVIDER type, output-only for PARTNER, not available for DEDICATED. Corresponds to the JSON property partnerMetadata



12099
12100
12101
# File 'generated/google/apis/compute_alpha/classes.rb', line 12099

def 
  @partner_metadata
end

#private_interconnect_infoGoogle::Apis::ComputeAlpha::InterconnectAttachmentPrivateInfo

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



12105
12106
12107
# File 'generated/google/apis/compute_alpha/classes.rb', line 12105

def private_interconnect_info
  @private_interconnect_info
end

#regionString

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


12112
12113
12114
# File 'generated/google/apis/compute_alpha/classes.rb', line 12112

def region
  @region
end

#routerString

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)


12120
12121
12122
# File 'generated/google/apis/compute_alpha/classes.rb', line 12120

def router
  @router
end

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

Returns:

  • (String)


12125
12126
12127
# File 'generated/google/apis/compute_alpha/classes.rb', line 12125

def self_link
  @self_link
end

#stateString

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

Returns:

  • (String)


12131
12132
12133
# File 'generated/google/apis/compute_alpha/classes.rb', line 12131

def state
  @state
end

#typeString

Corresponds to the JSON property type

Returns:

  • (String)


12136
12137
12138
# File 'generated/google/apis/compute_alpha/classes.rb', line 12136

def type
  @type
end

#vlan_tag8021qFixnum

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)


12143
12144
12145
# File 'generated/google/apis/compute_alpha/classes.rb', line 12143

def vlan_tag8021q
  @vlan_tag8021q
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
# File 'generated/google/apis/compute_alpha/classes.rb', line 12150

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