software.amazon.awssdk.services.directconnect.model

Class BGPPeer

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

Method Summary

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)
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)
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() Returns a string representation of this object.

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. 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.

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 not available.

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 not available.

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 not available.

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 not available.

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

equalsBySdkFields

public 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 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 <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.