Class Attachment

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

Describes a core network attachment.

See Also:

  • Method Details

    • coreNetworkId

      public final String coreNetworkId()

      The ID of a core network.

      Returns:
      The ID of a core network.

    • coreNetworkArn

      public final String coreNetworkArn()

      The ARN of a core network.

      Returns:
      The ARN of a core network.

    • attachmentId

      public final String attachmentId()

      The ID of the attachment.

      Returns:
      The ID of the attachment.

    • ownerAccountId

      public final String ownerAccountId()

      The ID of the attachment account owner.

      Returns:
      The ID of the attachment account owner.

    • attachmentType

      public final AttachmentType attachmentType()

      The type of attachment.

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

      Returns:
      The type of attachment.
      See Also:

    • attachmentTypeAsString

      public final String attachmentTypeAsString()

      The type of attachment.

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

      Returns:
      The type of attachment.
      See Also:

    • state

      public final AttachmentState state()

      The state of the attachment.

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

      Returns:
      The state of the attachment.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the attachment.

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

      Returns:
      The state of the attachment.
      See Also:

    • edgeLocation

      public final String edgeLocation()

      The Region where the edge is located. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.

      Returns:
      The Region where the edge is located. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.

    • hasEdgeLocations

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

    • edgeLocations

      public final List<String> edgeLocations()

      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.

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

      Returns:
      The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.

    • resourceArn

      public final String resourceArn()

      The attachment resource ARN.

      Returns:
      The attachment resource ARN.

    • attachmentPolicyRuleNumber

      public final Integer attachmentPolicyRuleNumber()

      The policy rule number associated with the attachment.

      Returns:
      The policy rule number associated with the attachment.

    • segmentName

      public final String segmentName()

      The name of the segment attachment.

      Returns:
      The name of the segment attachment.

    • networkFunctionGroupName

      public final String networkFunctionGroupName()

      The name of the network function group.

      Returns:
      The name of the network function group.

    • 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 tags associated with the attachment.

      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 tags associated with the attachment.

    • proposedSegmentChange

      public final ProposedSegmentChange proposedSegmentChange()

      The attachment to move from one segment to another.

      Returns:
      The attachment to move from one segment to another.

    • proposedNetworkFunctionGroupChange

      public final ProposedNetworkFunctionGroupChange proposedNetworkFunctionGroupChange()

      Describes a proposed change to a network function group associated with the attachment.

      Returns:
      Describes a proposed change to a network function group associated with the attachment.

    • createdAt

      public final Instant createdAt()

      The timestamp when the attachment was created.

      Returns:
      The timestamp when the attachment was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the attachment was last updated.

      Returns:
      The timestamp when the attachment was last updated.

    • 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<AttachmentError> 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 Attachment.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<Attachment.Builder,Attachment>
      Returns:
      a builder for type T

    • builder

      public static Attachment.Builder builder()

    • serializableBuilderClass

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