Class Peering

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

Describes a peering connection.

See Also:

  • Method Details

    • coreNetworkId

      public final String coreNetworkId()

      The ID of the core network for the peering request.

      Returns:
      The ID of the core network for the peering request.

    • coreNetworkArn

      public final String coreNetworkArn()

      The ARN of a core network.

      Returns:
      The ARN of a core network.

    • peeringId

      public final String peeringId()

      The ID of the peering attachment.

      Returns:
      The ID of the peering attachment.

    • ownerAccountId

      public final String ownerAccountId()

      The ID of the account owner.

      Returns:
      The ID of the account owner.

    • peeringType

      public final PeeringType peeringType()

      The type of peering. This will be TRANSIT_GATEWAY.

      If the service returns an enum value that is not available in the current SDK version, peeringType will return PeeringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from peeringTypeAsString().

      Returns:
      The type of peering. This will be TRANSIT_GATEWAY.
      See Also:

    • peeringTypeAsString

      public final String peeringTypeAsString()

      The type of peering. This will be TRANSIT_GATEWAY.

      If the service returns an enum value that is not available in the current SDK version, peeringType will return PeeringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from peeringTypeAsString().

      Returns:
      The type of peering. This will be TRANSIT_GATEWAY.
      See Also:

    • state

      public final PeeringState state()

      The current state of the peering connection.

      If the service returns an enum value that is not available in the current SDK version, state will return PeeringState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the peering connection.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the peering connection.

      If the service returns an enum value that is not available in the current SDK version, state will return PeeringState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the peering connection.
      See Also:

    • edgeLocation

      public final String edgeLocation()

      The edge location for the peer.

      Returns:
      The edge location for the peer.

    • resourceArn

      public final String resourceArn()

      The resource ARN of the peer.

      Returns:
      The resource ARN of the peer.

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

    • tags

      public final List<Tag> tags()

      The list of key-value tags associated with the peering.

      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:
      The list of key-value tags associated with the peering.

    • createdAt

      public final Instant createdAt()

      The timestamp when the attachment peer was created.

      Returns:
      The timestamp when the attachment peer was created.

    • hasLastModificationErrors

      public final boolean hasLastModificationErrors()
      For responses, this returns true if the service returned a value for the LastModificationErrors 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.

    • lastModificationErrors

      public final List<PeeringError> lastModificationErrors()

      Describes the error associated with the Connect peer request.

      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 hasLastModificationErrors() method.

      Returns:
      Describes the error associated with the Connect peer request.

    • toBuilder

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

    • builder

      public static Peering.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Peering.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.