Class DocumentMetadata

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

Describes the document.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the document.

      Returns:
      The ID of the document.

    • creatorId

      public final String creatorId()

      The ID of the creator.

      Returns:
      The ID of the creator.

    • parentFolderId

      public final String parentFolderId()

      The ID of the parent folder.

      Returns:
      The ID of the parent folder.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time when the document was created.

      Returns:
      The time when the document was created.

    • modifiedTimestamp

      public final Instant modifiedTimestamp()

      The time when the document was updated.

      Returns:
      The time when the document was updated.

    • latestVersionMetadata

      public final DocumentVersionMetadata latestVersionMetadata()

      The latest version of the document.

      Returns:
      The latest version of the document.

    • resourceState

      public final ResourceStateType resourceState()

      The resource state.

      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.
      See Also:

    • resourceStateAsString

      public final String resourceStateAsString()

      The resource state.

      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.
      See Also:

    • hasLabels

      public final boolean hasLabels()
      For responses, this returns true if the service returned a value for the Labels 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.

    • labels

      public final List<String> labels()

      List of labels on the document.

      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 hasLabels() method.

      Returns:
      List of labels on the document.

    • toBuilder

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

    • builder

      public static DocumentMetadata.Builder builder()

    • serializableBuilderClass

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