Class DescribeAccessPointsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.efs.model.EfsRequest
software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAccessPointsRequest.Builder,DescribeAccessPointsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAccessPointsRequest extends EfsRequest implements ToCopyableBuilder<DescribeAccessPointsRequest.Builder,DescribeAccessPointsRequest>

  • Method Details

    • maxResults

      public final Integer maxResults()

      (Optional) When retrieving all access points for a file system, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.

      Returns:
      (Optional) When retrieving all access points for a file system, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.

    • nextToken

      public final String nextToken()

      NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.

      Returns:
      NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.

    • accessPointId

      public final String accessPointId()

      (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.

      Returns:
      (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.

    • fileSystemId

      public final String fileSystemId()

      (Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.

      Returns:
      (Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.

    • toBuilder

      public DescribeAccessPointsRequest.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<DescribeAccessPointsRequest.Builder,DescribeAccessPointsRequest>
      Specified by:
      toBuilder in class EfsRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeAccessPointsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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