Class GetDocumentResponse

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

  • Method Details

    • name

      public final String name()

      The name of the SSM document.

      Returns:
      The name of the SSM document.

    • createdDate

      public final Instant createdDate()

      The date the SSM document was created.

      Returns:
      The date the SSM document was created.

    • displayName

      public final String displayName()

      The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

      Returns:
      The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

    • versionName

      public final String versionName()

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

      Returns:
      The document version.

    • status

      public final DocumentStatus status()

      The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

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

      Returns:
      The status of the SSM document, such as Creating, Active, Updating , Failed, and Deleting.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

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

      Returns:
      The status of the SSM document, such as Creating, Active, Updating , Failed, and Deleting.
      See Also:

    • statusInformation

      public final String statusInformation()

      A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

      Returns:
      A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

    • content

      public final String content()

      The contents of the SSM document.

      Returns:
      The contents of the SSM document.

    • documentType

      public final DocumentType documentType()

      The document type.

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

      Returns:
      The document type.
      See Also:

    • documentTypeAsString

      public final String documentTypeAsString()

      The document type.

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

      Returns:
      The document type.
      See Also:

    • documentFormat

      public final DocumentFormat documentFormat()

      The document format, either JSON or YAML.

      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:
      The document format, either JSON or YAML.
      See Also:

    • documentFormatAsString

      public final String documentFormatAsString()

      The document format, either JSON or YAML.

      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:
      The document format, either JSON or YAML.
      See Also:

    • hasRequires

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

    • requires

      public final List<DocumentRequires> requires()

      A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema 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 hasRequires() method.

      Returns:
      A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

    • hasAttachmentsContent

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

    • attachmentsContent

      public final List<AttachmentContent> attachmentsContent()

      A description of the document attachments, including names, locations, sizes, and so on.

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

      Returns:
      A description of the document attachments, including names, locations, sizes, and so on.

    • reviewStatus

      public final ReviewStatus reviewStatus()

      The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

      Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

      Only one version of an SSM document can be in review, or PENDING, at a time.

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

      Returns:
      The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

      Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

      Only one version of an SSM document can be in review, or PENDING, at a time.

      See Also:

    • reviewStatusAsString

      public final String reviewStatusAsString()

      The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

      Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

      Only one version of an SSM document can be in review, or PENDING, at a time.

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

      Returns:
      The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

      Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

      Only one version of an SSM document can be in review, or PENDING, at a time.

      See Also:

    • toBuilder

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

    • builder

      public static GetDocumentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetDocumentResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.