Class AccessPointDescription

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

Provides a description of an EFS file system access point.

See Also:

  • Method Details

    • clientToken

      public final String clientToken()

      The opaque string specified in the request to ensure idempotent creation.

      Returns:
      The opaque string specified in the request to ensure idempotent creation.

    • name

      public final String name()

      The name of the access point. This is the value of the Name tag.

      Returns:
      The name of the access point. This is the value of the Name tag.

    • 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 access point, presented as an array of Tag objects.

      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 access point, presented as an array of Tag objects.

    • accessPointId

      public final String accessPointId()

      The ID of the access point, assigned by Amazon EFS.

      Returns:
      The ID of the access point, assigned by Amazon EFS.

    • accessPointArn

      public final String accessPointArn()

      The unique Amazon Resource Name (ARN) associated with the access point.

      Returns:
      The unique Amazon Resource Name (ARN) associated with the access point.

    • fileSystemId

      public final String fileSystemId()

      The ID of the EFS file system that the access point applies to.

      Returns:
      The ID of the EFS file system that the access point applies to.

    • posixUser

      public final PosixUser posixUser()

      The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

      Returns:
      The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

    • rootDirectory

      public final RootDirectory rootDirectory()

      The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

      Returns:
      The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

    • ownerId

      public final String ownerId()

      Identifies the Amazon Web Services account that owns the access point resource.

      Returns:
      Identifies the Amazon Web Services account that owns the access point resource.

    • lifeCycleState

      public final LifeCycleState lifeCycleState()

      Identifies the lifecycle phase of the access point.

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

      Returns:
      Identifies the lifecycle phase of the access point.
      See Also:

    • lifeCycleStateAsString

      public final String lifeCycleStateAsString()

      Identifies the lifecycle phase of the access point.

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

      Returns:
      Identifies the lifecycle phase of the access point.
      See Also:

    • toBuilder

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

    • builder

      public static AccessPointDescription.Builder builder()

    • serializableBuilderClass

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