InterconnectAttachment (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.InterconnectAttachment

All Implemented Interfaces:: com.google.api.gax.httpjson.ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class InterconnectAttachment
extends Object
implements com.google.api.gax.httpjson.ApiMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InterconnectAttachment.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`InterconnectAttachment.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Boolean`	`getAdminEnabled()` Determines whether this Attachment will carry packets.
`com.google.api.gax.httpjson.ApiMessage`	`getApiMessageRequestBody()`
`String`	`getBandwidth()` Provisioned bandwidth capacity for the interconnect attachment.
`List<String>`	`getCandidateSubnetsList()` Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
`String`	`getCloudRouterIpAddress()` [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getCustomerRouterIpAddress()` [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`static InterconnectAttachment`	`getDefaultInstance()`
`String`	`getDescription()` An optional description of this resource.
`String`	`getEdgeAvailabilityDomain()` Desired availability domain for the attachment.
`List<String>`	`getFieldMask()`
`Object`	`getFieldValue(String fieldName)`
`String`	`getGoogleReferenceId()` [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
`String`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getInterconnect()` URL of the underlying Interconnect object that this attachment's traffic will traverse through.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` Name of the resource.
`String`	`getOperationalStatus()` [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use.
`String`	`getPairingKey()` [Output only for type PARTNER.
`String`	`getPartnerAsn()` Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer.
`InterconnectAttachmentPartnerMetadata`	`getPartnerMetadata()` Informational metadata about Partner attachments from Partners to display to customers.
`InterconnectAttachmentPrivateInfo`	`getPrivateInterconnectInfo()` [Output Only] Information specific to an InterconnectAttachment.
`String`	`getRegion()` [Output Only] URL of the region where the regional interconnect attachment resides.
`String`	`getRouter()` URL of the Cloud Router to be used for dynamic routing.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getState()` [Output Only] The current state of this attachment's functionality.
`String`	`getType()` The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect.
`Integer`	`getVlanTag8021q()` The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094.
`int`	`hashCode()`
`static InterconnectAttachment.Builder`	`newBuilder()`
`static InterconnectAttachment.Builder`	`newBuilder(InterconnectAttachment prototype)`
`InterconnectAttachment.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFieldValue
```
public Object getFieldValue(String fieldName)
```
    Specified by:
    
    getFieldValue in interface com.google.api.gax.httpjson.ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public com.google.api.gax.httpjson.ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface com.google.api.gax.httpjson.ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface com.google.api.gax.httpjson.ApiMessage
  - getAdminEnabled
```
public Boolean getAdminEnabled()
```
    Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
  - getBandwidth
```
public String getBandwidth()
```
    Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s
  - getCandidateSubnetsList
```
public List<String> getCandidateSubnetsList()
```
    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.
  - getCloudRouterIpAddress
```
public String getCloudRouterIpAddress()
```
    [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getCustomerRouterIpAddress
```
public String getCustomerRouterIpAddress()
```
    [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource.
  - getEdgeAvailabilityDomain
```
public String getEdgeAvailabilityDomain()
```
    Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, 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.
  - getGoogleReferenceId
```
public String getGoogleReferenceId()
```
    [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - getInterconnect
```
public String getInterconnect()
```
    URL of the underlying Interconnect object that this attachment's traffic will traverse through.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
  - getName
```
public String getName()
```
    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.
  - getOperationalStatus
```
public String getOperationalStatus()
```
    [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
  - getPairingKey
```
public String getPairingKey()
```
    [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"
  - getPartnerAsn
```
public String getPartnerAsn()
```
    Optional BGP ASN for the router 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.
  - getPartnerMetadata
```
public InterconnectAttachmentPartnerMetadata getPartnerMetadata()
```
    Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
  - getPrivateInterconnectInfo
```
public InterconnectAttachmentPrivateInfo getPrivateInterconnectInfo()
```
    [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
  - getRegion
```
public String getRegion()
```
    [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.
  - getRouter
```
public String getRouter()
```
    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.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - getState
```
public String getState()
```
    [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
  - getType
```
public String getType()
```
    The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
  - getVlanTag8021q
```
public Integer getVlanTag8021q()
```
    The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
  - newBuilder
```
public static InterconnectAttachment.Builder newBuilder()
```
  - newBuilder
```
public static InterconnectAttachment.Builder newBuilder(InterconnectAttachment prototype)
```
  - toBuilder
```
public InterconnectAttachment.Builder toBuilder()
```
  - getDefaultInstance
```
public static InterconnectAttachment getDefaultInstance()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class InterconnectAttachment

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldValue

getApiMessageRequestBody

getFieldMask

getAdminEnabled

getBandwidth

getCandidateSubnetsList

getCloudRouterIpAddress

getCreationTimestamp

getCustomerRouterIpAddress

getDescription

getEdgeAvailabilityDomain

getGoogleReferenceId

getId

getInterconnect

getKind

getName

getOperationalStatus

getPairingKey

getPartnerAsn

getPartnerMetadata

getPrivateInterconnectInfo

getRegion

getRouter

getSelfLink

getState

getType

getVlanTag8021q

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode