Package software.amazon.awssdk.services.workdocs.model

Class UpdateDocumentRequest

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.UpdateDocumentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDocumentRequest extends WorkDocsRequest implements ToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>

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

    • documentId

      public final String documentId()

      The ID of the document.

      Returns:
      The ID of the document.

    • name

      public final String name()

      The name of the document.

      Returns:
      The name of the document.

    • parentFolderId

      public final String parentFolderId()

      The ID of the parent folder.

      Returns:
      The ID of the parent folder.

    • resourceState

      public final ResourceStateType resourceState()

      The resource state of the document. Only ACTIVE and RECYCLED are supported.

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

      Returns:
      The resource state of the document. Only ACTIVE and RECYCLED are supported.
      See Also:

    • resourceStateAsString

      public final String resourceStateAsString()

      The resource state of the document. Only ACTIVE and RECYCLED are supported.

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

      Returns:
      The resource state of the document. Only ACTIVE and RECYCLED are supported.
      See Also:

    • toBuilder

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

    • builder

      public static UpdateDocumentRequest.Builder builder()

    • serializableBuilderClass

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