BGPPeer (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.directconnect.model.BGPPeer

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BGPPeer.Builder,BGPPeer>

@Generated(value="software.amazon.awssdk:codegen")
public final class BGPPeer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BGPPeer.Builder,BGPPeer>

Information about a BGP peer.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BGPPeer.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BGPPeer.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.
`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 on which the BGP peer terminates.
`String`	`bgpPeerId()` The ID of the BGP peer.
`BGPPeerState`	`bgpPeerState()` The state of the BGP peer.
`String`	`bgpPeerStateAsString()` The state of the BGP peer.
`BGPStatus`	`bgpStatus()` The status of the BGP peer.
`String`	`bgpStatusAsString()` The status of the BGP peer.
`static BGPPeer.Builder`	`builder()`
`String`	`customerAddress()` The IP address assigned to the customer interface.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BGPPeer.Builder>`	`serializableBuilderClass()`
`BGPPeer.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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
  - bgpPeerId
```
public String bgpPeerId()
```
    The ID of the BGP peer.
    
    Returns:
    
    The ID of the BGP peer.
  - asn
```
public Integer asn()
```
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    
    Returns:
    
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
  - authKey
```
public String authKey()
```
    The authentication key for BGP configuration.
    
    Returns:
    
    The authentication key for BGP configuration.
  - addressFamily
```
public 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 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
  - amazonAddress
```
public String amazonAddress()
```
    The IP address assigned to the Amazon interface.
    
    Returns:
    
    The IP address assigned to the Amazon interface.
  - customerAddress
```
public String customerAddress()
```
    The IP address assigned to the customer interface.
    
    Returns:
    
    The IP address assigned to the customer interface.
  - bgpPeerState
```
public BGPPeerState bgpPeerState()
```
    The state of the BGP peer. The following are the possible values:
    - verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
    - pending: The BGP peer is created, and remains in this state until it is ready to be established.
    - available: The BGP peer is ready to be established.
    - deleting: The BGP peer is being deleted.
    - deleted: The BGP peer is deleted and cannot be established.
    If the service returns an enum value that is not available in the current SDK version, bgpPeerState will return BGPPeerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bgpPeerStateAsString().
    Returns:
    The state of the BGP peer. The following are the possible values:
    
    verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
    
    pending: The BGP peer is created, and remains in this state until it is ready to be established.
    
    available: The BGP peer is ready to be established.
    
    deleting: The BGP peer is being deleted.
    
    deleted: The BGP peer is deleted and cannot be established.
    See Also:
    
    BGPPeerState
  - bgpPeerStateAsString
```
public String bgpPeerStateAsString()
```
    The state of the BGP peer. The following are the possible values:
    - verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
    - pending: The BGP peer is created, and remains in this state until it is ready to be established.
    - available: The BGP peer is ready to be established.
    - deleting: The BGP peer is being deleted.
    - deleted: The BGP peer is deleted and cannot be established.
    If the service returns an enum value that is not available in the current SDK version, bgpPeerState will return BGPPeerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bgpPeerStateAsString().
    Returns:
    The state of the BGP peer. The following are the possible values:
    
    verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
    
    pending: The BGP peer is created, and remains in this state until it is ready to be established.
    
    available: The BGP peer is ready to be established.
    
    deleting: The BGP peer is being deleted.
    
    deleted: The BGP peer is deleted and cannot be established.
    See Also:
    
    BGPPeerState
  - bgpStatus
```
public BGPStatus bgpStatus()
```
    The status of the BGP peer. The following are the possible values:
    - up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
    - down: The BGP peer is down.
    - unknown: The BGP peer status is unknown.
    If the service returns an enum value that is not available in the current SDK version, bgpStatus will return BGPStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bgpStatusAsString().
    Returns:
    The status of the BGP peer. The following are the possible values:
    
    up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
    
    down: The BGP peer is down.
    
    unknown: The BGP peer status is unknown.
    See Also:
    
    BGPStatus
  - bgpStatusAsString
```
public String bgpStatusAsString()
```
    The status of the BGP peer. The following are the possible values:
    - up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
    - down: The BGP peer is down.
    - unknown: The BGP peer status is unknown.
    If the service returns an enum value that is not available in the current SDK version, bgpStatus will return BGPStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bgpStatusAsString().
    Returns:
    The status of the BGP peer. The following are the possible values:
    
    up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
    
    down: The BGP peer is down.
    
    unknown: The BGP peer status is unknown.
    See Also:
    
    BGPStatus
  - awsDeviceV2
```
public String awsDeviceV2()
```
    The Direct Connect endpoint on which the BGP peer terminates.
    
    Returns:
    
    The Direct Connect endpoint on which the BGP peer terminates.
  - toBuilder
```
public BGPPeer.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<BGPPeer.Builder,BGPPeer>
    
    Returns:
    
    a builder for type T
  - builder
```
public static BGPPeer.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BGPPeer.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class BGPPeer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

bgpPeerId

asn

authKey

addressFamily

addressFamilyAsString

amazonAddress

customerAddress

bgpPeerState

bgpPeerStateAsString

bgpStatus

bgpStatusAsString

awsDeviceV2

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields