Class DescribeFileSystemAliasesRequest

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

The request object for DescribeFileSystemAliases operation.

  • Method Details

    • clientRequestToken

      public final String clientRequestToken()
      Returns the value of the ClientRequestToken property for this object.
      Returns:
      The value of the ClientRequestToken property for this object.

    • fileSystemId

      public final String fileSystemId()

      The ID of the file system to return the associated DNS aliases for (String).

      Returns:
      The ID of the file system to return the associated DNS aliases for (String).

    • maxResults

      public final Integer maxResults()

      Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

      Returns:
      Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

    • nextToken

      public final String nextToken()

      Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

      Returns:
      Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

    • toBuilder

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

    • builder

      public static DescribeFileSystemAliasesRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.