Class OdbPeeringConnection
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OdbPeeringConnection.Builder,
OdbPeeringConnection>
A peering connection between an ODB network and either another ODB network or a customer-owned VPC.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic OdbPeeringConnection.Builder
builder()
final Instant
The timestamp when the ODB peering connection was created.final String
The display name of the ODB peering connection.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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PeerNetworkCidrs property.final String
The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.final String
The Amazon Resource Name (ARN) of the ODB peering connection.final String
The unique identifier of the ODB peering connection.final String
The type of the ODB peering connection.final String
The Amazon Resource Name (ARN) of the peer network.The CIDR blocks associated with the peering connection.final Float
The percentage progress of the ODB peering connection creation or deletion.static Class
<? extends OdbPeeringConnection.Builder> final ResourceStatus
status()
The status of the ODB peering connection.final String
The status of the ODB peering connection.final String
The reason for the current status of the ODB peering connection.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
odbPeeringConnectionId
The unique identifier of the ODB peering connection. A sample ID is
odbpcx-abcdefgh12345678
.- Returns:
- The unique identifier of the ODB peering connection. A sample ID is
odbpcx-abcdefgh12345678
.
-
displayName
The display name of the ODB peering connection.
- Returns:
- The display name of the ODB peering connection.
-
status
The status of the ODB peering connection.
Valid Values:
provisioning | active | terminating | terminated | failed
If the service returns an enum value that is not available in the current SDK version,
status
will returnResourceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the ODB peering connection.
Valid Values:
provisioning | active | terminating | terminated | failed
- See Also:
-
statusAsString
The status of the ODB peering connection.
Valid Values:
provisioning | active | terminating | terminated | failed
If the service returns an enum value that is not available in the current SDK version,
status
will returnResourceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the ODB peering connection.
Valid Values:
provisioning | active | terminating | terminated | failed
- See Also:
-
statusReason
The reason for the current status of the ODB peering connection.
- Returns:
- The reason for the current status of the ODB peering connection.
-
odbPeeringConnectionArn
The Amazon Resource Name (ARN) of the ODB peering connection.
Example:
arn:aws:odb:us-east-1:123456789012:odb-peering-connection/odbpcx-abcdefgh12345678
- Returns:
- The Amazon Resource Name (ARN) of the ODB peering connection.
Example:
arn:aws:odb:us-east-1:123456789012:odb-peering-connection/odbpcx-abcdefgh12345678
-
odbNetworkArn
The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
- Returns:
- The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
-
peerNetworkArn
The Amazon Resource Name (ARN) of the peer network.
- Returns:
- The Amazon Resource Name (ARN) of the peer network.
-
odbPeeringConnectionType
The type of the ODB peering connection.
Valid Values:
ODB-VPC | ODB-ODB
- Returns:
- The type of the ODB peering connection.
Valid Values:
ODB-VPC | ODB-ODB
-
hasPeerNetworkCidrs
public final boolean hasPeerNetworkCidrs()For responses, this returns true if the service returned a value for the PeerNetworkCidrs 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. -
peerNetworkCidrs
The CIDR blocks associated with the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
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
hasPeerNetworkCidrs()
method.- Returns:
- The CIDR blocks associated with the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
-
createdAt
The timestamp when the ODB peering connection was created.
- Returns:
- The timestamp when the ODB peering connection was created.
-
percentProgress
The percentage progress of the ODB peering connection creation or deletion.
- Returns:
- The percentage progress of the ODB peering connection creation or deletion.
-
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<OdbPeeringConnection.Builder,
OdbPeeringConnection> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-