Class AllocatePrivateVirtualInterfaceResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AllocatePrivateVirtualInterfaceResponse.Builder,
AllocatePrivateVirtualInterfaceResponse>
Information about a virtual interface.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal AddressFamily
The address family for the BGP peer.final String
The address family for the BGP peer.final String
The IP address assigned to the Amazon interface.final Long
The autonomous system number (ASN) for the Amazon side of the connection.final Integer
asn()
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.final String
authKey()
The authentication key for BGP configuration.final String
The Direct Connect endpoint that terminates the physical connection.final String
The Direct Connect endpoint that terminates the logical connection.bgpPeers()
The BGP peers configured on this virtual interface.builder()
final String
The ID of the connection.final String
The IP address assigned to the customer interface.final String
The customer router configuration.final String
The ID of the Direct Connect gateway.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the BgpPeers property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RouteFilterPrefixes property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
Indicates whether jumbo frames are supported.final String
location()
The location of the connection.final Integer
mtu()
The maximum transmission unit (MTU), in bytes.final String
The ID of the Amazon Web Services account that owns the virtual interface.final String
region()
The Amazon Web Services Region where the virtual interface is located.final List
<RouteFilterPrefix> The routes to be advertised to the Amazon Web Services network in this Region.static Class
<? extends AllocatePrivateVirtualInterfaceResponse.Builder> final Boolean
Indicates whether SiteLink is enabled.tags()
The tags associated with the virtual interface.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the virtual private gateway.final String
The ID of the virtual interface.final String
The name of the virtual interface assigned by the customer network.final VirtualInterfaceState
The state of the virtual interface.final String
The state of the virtual interface.final String
The type of virtual interface.final Integer
vlan()
The ID of the VLAN.Methods inherited from class software.amazon.awssdk.services.directconnect.model.DirectConnectResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ownerAccount
The ID of the Amazon Web Services account that owns the virtual interface.
- Returns:
- The ID of the Amazon Web Services account that owns the virtual interface.
-
virtualInterfaceId
The ID of the virtual interface.
- Returns:
- The ID of the virtual interface.
-
location
The location of the connection.
- Returns:
- The location of the connection.
-
connectionId
The ID of the connection.
- Returns:
- The ID of the connection.
-
virtualInterfaceType
The type of virtual interface. The possible values are
private
andpublic
.- Returns:
- The type of virtual interface. The possible values are
private
andpublic
.
-
virtualInterfaceName
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
- Returns:
- The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
-
vlan
The ID of the VLAN.
- Returns:
- The ID of the VLAN.
-
asn
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
- Returns:
- The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
-
amazonSideAsn
The autonomous system number (ASN) for the Amazon side of the connection.
- Returns:
- The autonomous system number (ASN) for the Amazon side of the connection.
-
authKey
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- Returns:
- The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
-
amazonAddress
The IP address assigned to the Amazon interface.
- Returns:
- The IP address assigned to the Amazon interface.
-
customerAddress
The IP address assigned to the customer interface.
- Returns:
- The IP address assigned to the customer interface.
-
addressFamily
The address family for the BGP peer.
If the service returns an enum value that is not available in the current SDK version,
addressFamily
will returnAddressFamily.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaddressFamilyAsString()
.- Returns:
- The address family for the BGP peer.
- See Also:
-
addressFamilyAsString
The address family for the BGP peer.
If the service returns an enum value that is not available in the current SDK version,
addressFamily
will returnAddressFamily.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaddressFamilyAsString()
.- Returns:
- The address family for the BGP peer.
- See Also:
-
virtualInterfaceState
The state of the virtual interface. The following are the possible values:
-
confirming
: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying
: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending
: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available
: A virtual interface that is able to forward traffic. -
down
: A virtual interface that is BGP down. -
deleting
: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. -
deleted
: A virtual interface that cannot forward traffic. -
rejected
: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirming
state is deleted by the virtual interface owner, the virtual interface enters theRejected
state. -
unknown
: The state of the virtual interface is not available.
If the service returns an enum value that is not available in the current SDK version,
virtualInterfaceState
will returnVirtualInterfaceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvirtualInterfaceStateAsString()
.- Returns:
- The state of the virtual interface. The following are the possible values:
-
confirming
: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying
: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending
: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available
: A virtual interface that is able to forward traffic. -
down
: A virtual interface that is BGP down. -
deleting
: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. -
deleted
: A virtual interface that cannot forward traffic. -
rejected
: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirming
state is deleted by the virtual interface owner, the virtual interface enters theRejected
state. -
unknown
: The state of the virtual interface is not available.
-
- See Also:
-
-
virtualInterfaceStateAsString
The state of the virtual interface. The following are the possible values:
-
confirming
: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying
: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending
: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available
: A virtual interface that is able to forward traffic. -
down
: A virtual interface that is BGP down. -
deleting
: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. -
deleted
: A virtual interface that cannot forward traffic. -
rejected
: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirming
state is deleted by the virtual interface owner, the virtual interface enters theRejected
state. -
unknown
: The state of the virtual interface is not available.
If the service returns an enum value that is not available in the current SDK version,
virtualInterfaceState
will returnVirtualInterfaceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvirtualInterfaceStateAsString()
.- Returns:
- The state of the virtual interface. The following are the possible values:
-
confirming
: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying
: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending
: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available
: A virtual interface that is able to forward traffic. -
down
: A virtual interface that is BGP down. -
deleting
: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. -
deleted
: A virtual interface that cannot forward traffic. -
rejected
: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirming
state is deleted by the virtual interface owner, the virtual interface enters theRejected
state. -
unknown
: The state of the virtual interface is not available.
-
- See Also:
-
-
customerRouterConfig
The customer router configuration.
- Returns:
- The customer router configuration.
-
mtu
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
- Returns:
- The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
-
jumboFrameCapable
Indicates whether jumbo frames are supported.
- Returns:
- Indicates whether jumbo frames are supported.
-
virtualGatewayId
The ID of the virtual private gateway. Applies only to private virtual interfaces.
- Returns:
- The ID of the virtual private gateway. Applies only to private virtual interfaces.
-
directConnectGatewayId
The ID of the Direct Connect gateway.
- Returns:
- The ID of the Direct Connect gateway.
-
hasRouteFilterPrefixes
public final boolean hasRouteFilterPrefixes()For responses, this returns true if the service returned a value for the RouteFilterPrefixes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
routeFilterPrefixes
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRouteFilterPrefixes()
method.- Returns:
- The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
-
hasBgpPeers
public final boolean hasBgpPeers()For responses, this returns true if the service returned a value for the BgpPeers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
bgpPeers
The BGP peers configured on this virtual interface.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBgpPeers()
method.- Returns:
- The BGP peers configured on this virtual interface.
-
region
The Amazon Web Services Region where the virtual interface is located.
- Returns:
- The Amazon Web Services Region where the virtual interface is located.
-
awsDeviceV2
The Direct Connect endpoint that terminates the physical connection.
- Returns:
- The Direct Connect endpoint that terminates the physical connection.
-
awsLogicalDeviceId
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- Returns:
- The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tags associated with the virtual interface.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tags associated with the virtual interface.
-
siteLinkEnabled
Indicates whether SiteLink is enabled.
- Returns:
- Indicates whether SiteLink is enabled.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AllocatePrivateVirtualInterfaceResponse.Builder,
AllocatePrivateVirtualInterfaceResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AllocatePrivateVirtualInterfaceResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-