Class DescribeFolderContentsRequest

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

  • Method Details

    • authenticationToken

      public final String authenticationToken()

      Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

      Returns:
      Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

    • folderId

      public final String folderId()

      The ID of the folder.

      Returns:
      The ID of the folder.

    • sort

      public final ResourceSortType sort()

      The sorting criteria.

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

      Returns:
      The sorting criteria.
      See Also:

    • sortAsString

      public final String sortAsString()

      The sorting criteria.

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

      Returns:
      The sorting criteria.
      See Also:

    • order

      public final OrderType order()

      The order for the contents of the folder.

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

      Returns:
      The order for the contents of the folder.
      See Also:

    • orderAsString

      public final String orderAsString()

      The order for the contents of the folder.

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

      Returns:
      The order for the contents of the folder.
      See Also:

    • limit

      public final Integer limit()

      The maximum number of items to return with this call.

      Returns:
      The maximum number of items to return with this call.

    • marker

      public final String marker()

      The marker for the next set of results. This marker was received from a previous call.

      Returns:
      The marker for the next set of results. This marker was received from a previous call.

    • type

      public final FolderContentType type()

      The type of items.

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

      Returns:
      The type of items.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of items.

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

      Returns:
      The type of items.
      See Also:

    • include

      public final String include()

      The contents to include. Specify "INITIALIZED" to include initialized documents.

      Returns:
      The contents to include. Specify "INITIALIZED" to include initialized documents.

    • toBuilder

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

    • builder

      public static DescribeFolderContentsRequest.Builder builder()

    • serializableBuilderClass

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