Package software.amazon.awssdk.services.ssm.model

Class DescribeDocumentRequest

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

  • Method Details

    • name

      public final String name()

      The name of the SSM document.

      If you're calling a shared SSM document from a different Amazon Web Services account, Name is the full Amazon Resource Name (ARN) of the document.

      Returns:
      The name of the SSM document.

      If you're calling a shared SSM document from a different Amazon Web Services account, Name is the full Amazon Resource Name (ARN) of the document.

    • documentVersion

      public final String documentVersion()

      The document version for which you want information. Can be a specific version or the default version.

      Returns:
      The document version for which you want information. Can be a specific version or the default version.

    • versionName

      public final String versionName()

      An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

      Returns:
      An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

    • toBuilder

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

    • builder

      public static DescribeDocumentRequest.Builder builder()

    • serializableBuilderClass

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