Class ConnectPeer

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

Describes a core network Connect peer.

See Also:

  • Method Details

    • coreNetworkId

      public final String coreNetworkId()

      The ID of a core network.

      Returns:
      The ID of a core network.

    • connectAttachmentId

      public final String connectAttachmentId()

      The ID of the attachment to connect.

      Returns:
      The ID of the attachment to connect.

    • connectPeerId

      public final String connectPeerId()

      The ID of the Connect peer.

      Returns:
      The ID of the Connect peer.

    • edgeLocation

      public final String edgeLocation()

      The Connect peer Regions where edges are located.

      Returns:
      The Connect peer Regions where edges are located.

    • state

      public final ConnectPeerState state()

      The state of the Connect peer.

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

      Returns:
      The state of the Connect peer.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the Connect peer.

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

      Returns:
      The state of the Connect peer.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the Connect peer was created.

      Returns:
      The timestamp when the Connect peer was created.

    • configuration

      public final ConnectPeerConfiguration configuration()

      The configuration of the Connect peer.

      Returns:
      The configuration of the Connect 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 Connect peer.

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

    • subnetArn

      public final String subnetArn()

      The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

      Returns:
      The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

    • 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<ConnectPeerError> lastModificationErrors()

      Describes the error associated with the attachment 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 attachment request.

    • toBuilder

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

    • builder

      public static ConnectPeer.Builder builder()

    • serializableBuilderClass

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