Class RouteServerEndpoint
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.RouteServerEndpoint
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RouteServerEndpoint.Builder,RouteServerEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class RouteServerEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteServerEndpoint.Builder,RouteServerEndpoint>
Describes a route server endpoint and its properties.
A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRouteServerEndpoint.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RouteServerEndpoint.Builderbuilder()StringeniAddress()The IP address of the Elastic network interface for the endpoint.StringeniId()The ID of the Elastic network interface for the endpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureReason()The reason for any failure in endpoint creation or operation.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringrouteServerEndpointId()The unique identifier of the route server endpoint.StringrouteServerId()The ID of the route server associated with this endpoint.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RouteServerEndpoint.Builder>serializableBuilderClass()RouteServerEndpointStatestate()The current state of the route server endpoint.StringstateAsString()The current state of the route server endpoint.StringsubnetId()The ID of the subnet to place the route server endpoint into.List<Tag>tags()Any tags assigned to the route server endpoint.RouteServerEndpoint.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvpcId()The ID of the VPC containing the endpoint.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
routeServerId
public final String routeServerId()
The ID of the route server associated with this endpoint.
- Returns:
- The ID of the route server associated with this endpoint.
-
routeServerEndpointId
public final String routeServerEndpointId()
The unique identifier of the route server endpoint.
- Returns:
- The unique identifier of the route server endpoint.
-
vpcId
public final String vpcId()
The ID of the VPC containing the endpoint.
- Returns:
- The ID of the VPC containing the endpoint.
-
subnetId
public final String subnetId()
The ID of the subnet to place the route server endpoint into.
- Returns:
- The ID of the subnet to place the route server endpoint into.
-
eniId
public final String eniId()
The ID of the Elastic network interface for the endpoint.
- Returns:
- The ID of the Elastic network interface for the endpoint.
-
eniAddress
public final String eniAddress()
The IP address of the Elastic network interface for the endpoint.
- Returns:
- The IP address of the Elastic network interface for the endpoint.
-
state
public final RouteServerEndpointState state()
The current state of the route server endpoint.
If the service returns an enum value that is not available in the current SDK version,
statewill returnRouteServerEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the route server endpoint.
- See Also:
RouteServerEndpointState
-
stateAsString
public final String stateAsString()
The current state of the route server endpoint.
If the service returns an enum value that is not available in the current SDK version,
statewill returnRouteServerEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the route server endpoint.
- See Also:
RouteServerEndpointState
-
failureReason
public final String failureReason()
The reason for any failure in endpoint creation or operation.
- Returns:
- The reason for any failure in endpoint creation or operation.
-
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
public final List<Tag> tags()
Any tags assigned to the route server endpoint.
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:
- Any tags assigned to the route server endpoint.
-
toBuilder
public RouteServerEndpoint.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RouteServerEndpoint.Builder,RouteServerEndpoint>
-
builder
public static RouteServerEndpoint.Builder builder()
-
serializableBuilderClass
public static Class<? extends RouteServerEndpoint.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-