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

Class CreateCustomMetadataRequest

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

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

    • resourceId

      public final String resourceId()

      The ID of the resource.

      Returns:
      The ID of the resource.

    • versionId

      public final String versionId()

      The ID of the version, if the custom metadata is being added to a document version.

      Returns:
      The ID of the version, if the custom metadata is being added to a document version.

    • hasCustomMetadata

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

    • customMetadata

      public final Map<String,String> customMetadata()

      Custom metadata in the form of name-value pairs.

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

      Returns:
      Custom metadata in the form of name-value pairs.

    • toBuilder

      public CreateCustomMetadataRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateCustomMetadataRequest.Builder,CreateCustomMetadataRequest>
      Specified by:
      toBuilder in class WorkDocsRequest

    • builder

      public static CreateCustomMetadataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCustomMetadataRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo