Class GetDocumentResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetDocumentResponse.Builder,
GetDocumentResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AttachmentContent> A description of the document attachments, including names, locations, sizes, and so on.static GetDocumentResponse.Builder
builder()
final String
content()
The contents of the SSM document.final Instant
The date the SSM document was created.final String
The friendly name of the SSM document.final DocumentFormat
The document format, either JSON or YAML.final String
The document format, either JSON or YAML.final DocumentType
The document type.final String
The document type.final String
The document version.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the AttachmentsContent property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Requires property.final String
name()
The name of the SSM document.final List
<DocumentRequires> requires()
A list of SSM documents required by a document.final 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.final String
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.static Class
<? extends GetDocumentResponse.Builder> final DocumentStatus
status()
The status of the SSM document, such asCreating
,Active
,Updating
,Failed
, andDeleting
.final String
The status of the SSM document, such asCreating
,Active
,Updating
,Failed
, andDeleting
.final String
A message returned by Amazon Web Services Systems Manager that explains theStatus
value.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the SSM document.
- Returns:
- The name of the SSM document.
-
createdDate
The date the SSM document was created.
- Returns:
- The date the SSM document was created.
-
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
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
The document version.
- Returns:
- The document version.
-
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:
-
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:
-
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
The contents of the SSM document.
- Returns:
- The contents of the SSM document.
-
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:
-
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:
-
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:
-
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:
-
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
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
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
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:
-
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:
-
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 interfaceToCopyableBuilder<GetDocumentResponse.Builder,
GetDocumentResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-