CreatePrivateVirtualInterfaceResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.directconnect.model.DirectConnectResponse
    - - software.amazon.awssdk.services.directconnect.model.CreatePrivateVirtualInterfaceResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreatePrivateVirtualInterfaceResponse.Builder,CreatePrivateVirtualInterfaceResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreatePrivateVirtualInterfaceResponse
extends DirectConnectResponse
implements ToCopyableBuilder<CreatePrivateVirtualInterfaceResponse.Builder,CreatePrivateVirtualInterfaceResponse>

Information about a virtual interface.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreatePrivateVirtualInterfaceResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreatePrivateVirtualInterfaceResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressFamily`	`addressFamily()` The address family for the BGP peer.
`String`	`addressFamilyAsString()` The address family for the BGP peer.
`String`	`amazonAddress()` The IP address assigned to the Amazon interface.
`Long`	`amazonSideAsn()` The autonomous system number (ASN) for the Amazon side of the connection.
`Integer`	`asn()` The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
`String`	`authKey()` The authentication key for BGP configuration.
`String`	`awsDeviceV2()` The Direct Connect endpoint that terminates the physical connection.
`String`	`awsLogicalDeviceId()` The Direct Connect endpoint that terminates the logical connection.
`List<BGPPeer>`	`bgpPeers()` The BGP peers configured on this virtual interface.
`static CreatePrivateVirtualInterfaceResponse.Builder`	`builder()`
`String`	`connectionId()` The ID of the connection.
`String`	`customerAddress()` The IP address assigned to the customer interface.
`String`	`customerRouterConfig()` The customer router configuration.
`String`	`directConnectGatewayId()` The ID of the Direct Connect gateway.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`boolean`	`hasBgpPeers()` Returns true if the BgpPeers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRouteFilterPrefixes()` Returns true if the RouteFilterPrefixes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Boolean`	`jumboFrameCapable()` Indicates whether jumbo frames (9001 MTU) are supported.
`String`	`location()` The location of the connection.
`Integer`	`mtu()` The maximum transmission unit (MTU), in bytes.
`String`	`ownerAccount()` The ID of the account that owns the virtual interface.
`String`	`region()` The Region where the virtual interface is located.
`List<RouteFilterPrefix>`	`routeFilterPrefixes()` The routes to be advertised to the Amazon Web Services network in this Region.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreatePrivateVirtualInterfaceResponse.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` The tags associated with the virtual interface.
`CreatePrivateVirtualInterfaceResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`String`	`virtualGatewayId()` The ID of the virtual private gateway.
`String`	`virtualInterfaceId()` The ID of the virtual interface.
`String`	`virtualInterfaceName()` The name of the virtual interface assigned by the customer network.
`VirtualInterfaceState`	`virtualInterfaceState()` The state of the virtual interface.
`String`	`virtualInterfaceStateAsString()` The state of the virtual interface.
`String`	`virtualInterfaceType()` The type of virtual interface.
`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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - ownerAccount
```
public final String ownerAccount()
```
    The ID of the account that owns the virtual interface.
    
    Returns:
    
    The ID of the account that owns the virtual interface.
  - virtualInterfaceId
```
public final String virtualInterfaceId()
```
    The ID of the virtual interface.
    
    Returns:
    
    The ID of the virtual interface.
  - location
```
public final String location()
```
    The location of the connection.
    
    Returns:
    
    The location of the connection.
  - connectionId
```
public final String connectionId()
```
    The ID of the connection.
    
    Returns:
    
    The ID of the connection.
  - virtualInterfaceType
```
public final String virtualInterfaceType()
```
    The type of virtual interface. The possible values are private and public.
    
    Returns:
    
    The type of virtual interface. The possible values are private and public.
  - virtualInterfaceName
```
public final String 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
```
public final Integer vlan()
```
    The ID of the VLAN.
    
    Returns:
    
    The ID of the VLAN.
  - asn
```
public final Integer 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
```
public final Long 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
```
public final String 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
```
public final String amazonAddress()
```
    The IP address assigned to the Amazon interface.
    
    Returns:
    
    The IP address assigned to the Amazon interface.
  - customerAddress
```
public final String customerAddress()
```
    The IP address assigned to the customer interface.
    
    Returns:
    
    The IP address assigned to the customer interface.
  - addressFamily
```
public final AddressFamily 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 return AddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addressFamilyAsString().
    
    Returns:
    
    The address family for the BGP peer.
    
    See Also:
    
    AddressFamily
  - addressFamilyAsString
```
public final String 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 return AddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addressFamilyAsString().
    
    Returns:
    
    The address family for the BGP peer.
    
    See Also:
    
    AddressFamily
  - virtualInterfaceState
```
public final VirtualInterfaceState 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 the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected 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 return VirtualInterfaceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from virtualInterfaceStateAsString().
    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 the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
    
    unknown: The state of the virtual interface is not available.
    See Also:
    
    VirtualInterfaceState
  - virtualInterfaceStateAsString
```
public final String 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 the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected 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 return VirtualInterfaceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from virtualInterfaceStateAsString().
    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 the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
    
    unknown: The state of the virtual interface is not available.
    See Also:
    
    VirtualInterfaceState
  - customerRouterConfig
```
public final String customerRouterConfig()
```
    The customer router configuration.
    
    Returns:
    
    The customer router configuration.
  - mtu
```
public final Integer mtu()
```
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    
    Returns:
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
  - jumboFrameCapable
```
public final Boolean jumboFrameCapable()
```
    Indicates whether jumbo frames (9001 MTU) are supported.
    
    Returns:
    
    Indicates whether jumbo frames (9001 MTU) are supported.
  - virtualGatewayId
```
public final String 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
```
public final String directConnectGatewayId()
```
    The ID of the Direct Connect gateway.
    
    Returns:
    
    The ID of the Direct Connect gateway.
  - hasRouteFilterPrefixes
```
public final boolean hasRouteFilterPrefixes()
```
    Returns true if the RouteFilterPrefixes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - routeFilterPrefixes
```
public final List<RouteFilterPrefix> 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.
    
    You can use hasRouteFilterPrefixes() to see if a value was sent in this field.
    
    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()
```
    Returns true if the BgpPeers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - bgpPeers
```
public final List<BGPPeer> bgpPeers()
```
    The BGP peers configured on this virtual interface.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasBgpPeers() to see if a value was sent in this field.
    
    Returns:
    
    The BGP peers configured on this virtual interface.
  - region
```
public final String region()
```
    The Region where the virtual interface is located.
    
    Returns:
    
    The Region where the virtual interface is located.
  - awsDeviceV2
```
public final String awsDeviceV2()
```
    The Direct Connect endpoint that terminates the physical connection.
    
    Returns:
    
    The Direct Connect endpoint that terminates the physical connection.
  - awsLogicalDeviceId
```
public final String 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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    The tags associated with the virtual interface.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags associated with the virtual interface.
  - toBuilder
```
public CreatePrivateVirtualInterfaceResponse.Builder 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 interface ToCopyableBuilder<CreatePrivateVirtualInterfaceResponse.Builder,CreatePrivateVirtualInterfaceResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreatePrivateVirtualInterfaceResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreatePrivateVirtualInterfaceResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    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
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.7

Class CreatePrivateVirtualInterfaceResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.directconnect.model.DirectConnectResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ownerAccount

virtualInterfaceId

location

connectionId

virtualInterfaceType

virtualInterfaceName

vlan

asn

amazonSideAsn

authKey

amazonAddress

customerAddress

addressFamily

addressFamilyAsString

virtualInterfaceState

virtualInterfaceStateAsString

customerRouterConfig

mtu

jumboFrameCapable

virtualGatewayId

directConnectGatewayId

hasRouteFilterPrefixes

routeFilterPrefixes

hasBgpPeers

bgpPeers

region

awsDeviceV2

awsLogicalDeviceId

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields