@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 Systems Manager 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()
Returns true if the AttachmentsContent property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasRequires()
Returns true if the Requires property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
String |
name()
The name of the Systems Manager document.
|
List<DocumentRequires> |
requires()
A list of SSM documents required by a document.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetDocumentResponse.Builder> |
serializableBuilderClass() |
DocumentStatus |
status()
The status of the Systems Manager document, such as
Creating, Active,
Updating, Failed, and Deleting. |
String |
statusAsString()
The status of the Systems Manager document, such as
Creating, Active,
Updating, Failed, and Deleting. |
String |
statusInformation()
A message returned by AWS 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 String name()
The name of the Systems Manager document.
public 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 cannot be changed.
public String documentVersion()
The document version.
public DocumentStatus status()
The status of the Systems Manager 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 String statusAsString()
The status of the Systems Manager 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 String statusInformation()
A message returned by AWS Systems Manager that explains the Status value. For example, a
Failed status might be explained by the StatusInformation message,
"The specified S3 bucket does not 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 does not exist. Verify that the URL of the S3 bucket is correct."public String content()
The contents of the Systems Manager document.
public 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 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 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 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 boolean hasRequires()
public 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.
You can use hasRequires() to see if a value was sent in this field.
ApplicationConfiguration
document requires an ApplicationConfigurationSchema document.public boolean hasAttachmentsContent()
public 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.
You can use hasAttachmentsContent() to see if a value was sent in this field.
public 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 int hashCode()
hashCode in class AwsResponsepublic boolean equals(Object obj)
equals in class AwsResponsepublic 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 String toString()
public <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.Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.