Class ResponseItem

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

List of Documents, Folders, Comments, and Document Versions matching the query.

See Also:

  • Method Details

    • resourceType

      public final ResponseItemType resourceType()

      The type of item being returned.

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

      Returns:
      The type of item being returned.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of item being returned.

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

      Returns:
      The type of item being returned.
      See Also:

    • webUrl

      public final String webUrl()

      The webUrl of the item being returned.

      Returns:
      The webUrl of the item being returned.

    • documentMetadata

      public final DocumentMetadata documentMetadata()

      The document that matches the query.

      Returns:
      The document that matches the query.

    • folderMetadata

      public final FolderMetadata folderMetadata()

      The folder that matches the query.

      Returns:
      The folder that matches the query.

    • commentMetadata

      public final CommentMetadata commentMetadata()

      The comment that matches the query.

      Returns:
      The comment that matches the query.

    • documentVersionMetadata

      public final DocumentVersionMetadata documentVersionMetadata()

      The document version that matches the metadata.

      Returns:
      The document version that matches the metadata.

    • toBuilder

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

    • builder

      public static ResponseItem.Builder builder()

    • serializableBuilderClass

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