Class OdbPeeringConnection

java.lang.Object
software.amazon.awssdk.services.odb.model.OdbPeeringConnection
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OdbPeeringConnection.Builder,OdbPeeringConnection>
@Generated("software.amazon.awssdk:codegen") public final class OdbPeeringConnection extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OdbPeeringConnection.Builder,OdbPeeringConnection>

A peering connection between an ODB network and either another ODB network or a customer-owned VPC.

See Also:

  • Method Details

    • odbPeeringConnectionId

      public final String 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

      public final String displayName()

      The display name of the ODB peering connection.

      Returns:
      The display name of the ODB peering connection.

    • status

      public final ResourceStatus 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 return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the ODB peering connection.

      Valid Values: provisioning | active | terminating | terminated | failed

      See Also:

    • statusAsString

      public final String 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 return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the ODB peering connection.

      Valid Values: provisioning | active | terminating | terminated | failed

      See Also:

    • statusReason

      public final String 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

      public final String 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

      public final String 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

      public final String peerNetworkArn()

      The Amazon Resource Name (ARN) of the peer network.

      Returns:
      The Amazon Resource Name (ARN) of the peer network.

    • odbPeeringConnectionType

      public final String 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 the isEmpty() 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

      public final List<String> 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

      public final Instant createdAt()

      The timestamp when the ODB peering connection was created.

      Returns:
      The timestamp when the ODB peering connection was created.

    • percentProgress

      public final Float 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

      public OdbPeeringConnection.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<OdbPeeringConnection.Builder,OdbPeeringConnection>
      Returns:
      a builder for type T

    • builder

      public static OdbPeeringConnection.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OdbPeeringConnection.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.