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

Class GetDocumentRequest

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

  • Method Details

    • name

      public final String name()

      The name of the SSM document.

      Returns:
      The name of the SSM document.

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

    • documentVersion

      public final String documentVersion()

      The document version for which you want information.

      Returns:
      The document version for which you want information.

    • documentFormat

      public final DocumentFormat documentFormat()

      Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

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

      Returns:
      Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.
      See Also:

    • documentFormatAsString

      public final String documentFormatAsString()

      Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

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

      Returns:
      Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.
      See Also:

    • toBuilder

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

    • builder

      public static GetDocumentRequest.Builder builder()

    • serializableBuilderClass

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