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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetDocumentResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AttachmentContent>
attachmentsContent()
A description of the document attachments, including names, locations, sizes, and so on.static GetDocumentResponse.Builder
builder()
String
content()
The contents of the SSM document.Instant
createdDate()
The date the SSM document was created.String
displayName()
The friendly name of the SSM document.DocumentFormat
documentFormat()
The document format, either JSON or YAML.String
documentFormatAsString()
The document format, either JSON or YAML.DocumentType
documentType()
The document type.String
documentTypeAsString()
The document type.String
documentVersion()
The document version.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAttachmentsContent()
For responses, this returns true if the service returned a value for the AttachmentsContent property.int
hashCode()
boolean
hasRequires()
For responses, this returns true if the service returned a value for the Requires property.String
name()
The name of the SSM document.List<DocumentRequires>
requires()
A list of SSM documents required by a document.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.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.List<SdkField<?>>
sdkFields()
static Class<? extends GetDocumentResponse.Builder>
serializableBuilderClass()
DocumentStatus
status()
The status of the SSM document, such asCreating
,Active
,Updating
,Failed
, andDeleting
.String
statusAsString()
The status of the SSM document, such asCreating
,Active
,Updating
,Failed
, andDeleting
.String
statusInformation()
A message returned by Amazon Web Services Systems Manager that explains theStatus
value.GetDocumentResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
versionName()
The version of the artifact associated with the document.-
Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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
, andDeleting
.If the service returns an enum value that is not available in the current SDK version,
status
will returnDocumentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the SSM document, such as
Creating
,Active
,Updating
,Failed
, andDeleting
. - See Also:
DocumentStatus
-
statusAsString
public final String statusAsString()
The status of the SSM document, such as
Creating
,Active
,Updating
,Failed
, andDeleting
.If the service returns an enum value that is not available in the current SDK version,
status
will returnDocumentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the SSM document, such as
Creating
,Active
,Updating
,Failed
, andDeleting
. - See Also:
DocumentStatus
-
statusInformation
public final String statusInformation()
A message returned by Amazon Web Services Systems Manager that explains the
Status
value. For example, aFailed
status might be explained by theStatusInformation
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, aFailed
status might be explained by theStatusInformation
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 returnDocumentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentTypeAsString()
.- Returns:
- The document type.
- See Also:
DocumentType
-
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 returnDocumentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentTypeAsString()
.- Returns:
- The document type.
- See Also:
DocumentType
-
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 returnDocumentFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentFormatAsString()
.- Returns:
- The document format, either JSON or YAML.
- See Also:
DocumentFormat
-
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 returnDocumentFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentFormatAsString()
.- Returns:
- The document format, either JSON or YAML.
- See Also:
DocumentFormat
-
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 theisEmpty()
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 anApplicationConfigurationSchema
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 anApplicationConfigurationSchema
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 theisEmpty()
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 returnReviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreviewStatusAsString()
.- 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:
ReviewStatus
-
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 returnReviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreviewStatusAsString()
.- 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:
ReviewStatus
-
toBuilder
public GetDocumentResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static GetDocumentResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetDocumentResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-