@Generated(value="software.amazon.awssdk:codegen") public final class GetDocumentResponse extends SsmResponse implements ToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetDocumentResponse.Builder |
| Modifier and Type | Method and 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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
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 as
Creating, Active, Updating,
Failed, and Deleting. |
String |
statusAsString()
The status of the SSM document, such as
Creating, Active, Updating,
Failed, and Deleting. |
String |
statusInformation()
A message returned by Amazon Web Services Systems Manager that explains the
Status value. |
GetDocumentResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
versionName()
The version of the artifact associated with the document.
|
responseMetadatasdkHttpResponsecopypublic final String name()
The name of the SSM document.
public final Instant createdDate()
The date the SSM document was created.
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.
public final String versionName()
The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
public final String documentVersion()
The document version.
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().
Creating, Active, Updating
, Failed, and Deleting.DocumentStatuspublic 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().
Creating, Active, Updating
, Failed, and Deleting.DocumentStatuspublic 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."
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."public final String content()
The contents of the SSM document.
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().
DocumentTypepublic 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().
DocumentTypepublic 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().
DocumentFormatpublic 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().
DocumentFormatpublic final boolean hasRequires()
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.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.
ApplicationConfiguration
document requires an ApplicationConfigurationSchema document.public final boolean hasAttachmentsContent()
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.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.
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().
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.
ReviewStatuspublic 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().
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.
ReviewStatuspublic GetDocumentResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>toBuilder in class AwsResponsepublic static GetDocumentResponse.Builder builder()
public static Class<? extends GetDocumentResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.