@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetDocumentResult() |
Modifier and Type | Method and Description |
---|---|
GetDocumentResult |
clone() |
boolean |
equals(Object obj) |
List<AttachmentContent> |
getAttachmentsContent()
A description of the document attachments, including names, locations, sizes, and so on.
|
String |
getContent()
The contents of the SSM document.
|
Date |
getCreatedDate()
The date the SSM document was created.
|
String |
getDisplayName()
The friendly name of the SSM document.
|
String |
getDocumentFormat()
The document format, either JSON or YAML.
|
String |
getDocumentType()
The document type.
|
String |
getDocumentVersion()
The document version.
|
String |
getName()
The name of the SSM document.
|
List<DocumentRequires> |
getRequires()
A list of SSM documents required by a document.
|
String |
getReviewStatus()
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 |
getStatus()
The status of the SSM document, such as
Creating , Active , Updating ,
Failed , and Deleting . |
String |
getStatusInformation()
A message returned by Amazon Web Services Systems Manager that explains the
Status value. |
String |
getVersionName()
The version of the artifact associated with the document.
|
int |
hashCode() |
void |
setAttachmentsContent(Collection<AttachmentContent> attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
|
void |
setContent(String content)
The contents of the SSM document.
|
void |
setCreatedDate(Date createdDate)
The date the SSM document was created.
|
void |
setDisplayName(String displayName)
The friendly name of the SSM document.
|
void |
setDocumentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
|
void |
setDocumentFormat(String documentFormat)
The document format, either JSON or YAML.
|
void |
setDocumentType(DocumentType documentType)
The document type.
|
void |
setDocumentType(String documentType)
The document type.
|
void |
setDocumentVersion(String documentVersion)
The document version.
|
void |
setName(String name)
The name of the SSM document.
|
void |
setRequires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document.
|
void |
setReviewStatus(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.
|
void |
setReviewStatus(String 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.
|
void |
setStatus(DocumentStatus status)
The status of the SSM document, such as
Creating , Active , Updating ,
Failed , and Deleting . |
void |
setStatus(String status)
The status of the SSM document, such as
Creating , Active , Updating ,
Failed , and Deleting . |
void |
setStatusInformation(String statusInformation)
A message returned by Amazon Web Services Systems Manager that explains the
Status value. |
void |
setVersionName(String versionName)
The version of the artifact associated with the document.
|
String |
toString()
Returns a string representation of this object.
|
GetDocumentResult |
withAttachmentsContent(AttachmentContent... attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
|
GetDocumentResult |
withAttachmentsContent(Collection<AttachmentContent> attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
|
GetDocumentResult |
withContent(String content)
The contents of the SSM document.
|
GetDocumentResult |
withCreatedDate(Date createdDate)
The date the SSM document was created.
|
GetDocumentResult |
withDisplayName(String displayName)
The friendly name of the SSM document.
|
GetDocumentResult |
withDocumentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
|
GetDocumentResult |
withDocumentFormat(String documentFormat)
The document format, either JSON or YAML.
|
GetDocumentResult |
withDocumentType(DocumentType documentType)
The document type.
|
GetDocumentResult |
withDocumentType(String documentType)
The document type.
|
GetDocumentResult |
withDocumentVersion(String documentVersion)
The document version.
|
GetDocumentResult |
withName(String name)
The name of the SSM document.
|
GetDocumentResult |
withRequires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document.
|
GetDocumentResult |
withRequires(DocumentRequires... requires)
A list of SSM documents required by a document.
|
GetDocumentResult |
withReviewStatus(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.
|
GetDocumentResult |
withReviewStatus(String 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.
|
GetDocumentResult |
withStatus(DocumentStatus status)
The status of the SSM document, such as
Creating , Active , Updating ,
Failed , and Deleting . |
GetDocumentResult |
withStatus(String status)
The status of the SSM document, such as
Creating , Active , Updating ,
Failed , and Deleting . |
GetDocumentResult |
withStatusInformation(String statusInformation)
A message returned by Amazon Web Services Systems Manager that explains the
Status value. |
GetDocumentResult |
withVersionName(String versionName)
The version of the artifact associated with the document.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setName(String name)
The name of the SSM document.
name
- The name of the SSM document.public String getName()
The name of the SSM document.
public GetDocumentResult withName(String name)
The name of the SSM document.
name
- The name of the SSM document.public void setCreatedDate(Date createdDate)
The date the SSM document was created.
createdDate
- The date the SSM document was created.public Date getCreatedDate()
The date the SSM document was created.
public GetDocumentResult withCreatedDate(Date createdDate)
The date the SSM document was created.
createdDate
- The date the SSM document was created.public void setDisplayName(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.
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 String getDisplayName()
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 GetDocumentResult withDisplayName(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.
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 void setVersionName(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.
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.public String getVersionName()
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.
public GetDocumentResult withVersionName(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.
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.public void setDocumentVersion(String documentVersion)
The document version.
documentVersion
- The document version.public String getDocumentVersion()
The document version.
public GetDocumentResult withDocumentVersion(String documentVersion)
The document version.
documentVersion
- The document version.public void setStatus(String status)
The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.
status
- The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.DocumentStatus
public String getStatus()
The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.
Creating
, Active
, Updating
, Failed
, and Deleting
.DocumentStatus
public GetDocumentResult withStatus(String status)
The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.
status
- The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.DocumentStatus
public void setStatus(DocumentStatus status)
The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.
status
- The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.DocumentStatus
public GetDocumentResult withStatus(DocumentStatus status)
The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.
status
- The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.DocumentStatus
public void setStatusInformation(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."
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."public String getStatusInformation()
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 GetDocumentResult withStatusInformation(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."
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."public void setContent(String content)
The contents of the SSM document.
content
- The contents of the SSM document.public String getContent()
The contents of the SSM document.
public GetDocumentResult withContent(String content)
The contents of the SSM document.
content
- The contents of the SSM document.public void setDocumentType(String documentType)
The document type.
documentType
- The document type.DocumentType
public String getDocumentType()
The document type.
DocumentType
public GetDocumentResult withDocumentType(String documentType)
The document type.
documentType
- The document type.DocumentType
public void setDocumentType(DocumentType documentType)
The document type.
documentType
- The document type.DocumentType
public GetDocumentResult withDocumentType(DocumentType documentType)
The document type.
documentType
- The document type.DocumentType
public void setDocumentFormat(String documentFormat)
The document format, either JSON or YAML.
documentFormat
- The document format, either JSON or YAML.DocumentFormat
public String getDocumentFormat()
The document format, either JSON or YAML.
DocumentFormat
public GetDocumentResult withDocumentFormat(String documentFormat)
The document format, either JSON or YAML.
documentFormat
- The document format, either JSON or YAML.DocumentFormat
public void setDocumentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
documentFormat
- The document format, either JSON or YAML.DocumentFormat
public GetDocumentResult withDocumentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
documentFormat
- The document format, either JSON or YAML.DocumentFormat
public List<DocumentRequires> getRequires()
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.public void setRequires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
requires
- A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.public GetDocumentResult withRequires(DocumentRequires... requires)
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
NOTE: This method appends the values to the existing list (if any). Use
setRequires(java.util.Collection)
or withRequires(java.util.Collection)
if you want to override
the existing values.
requires
- A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.public GetDocumentResult withRequires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
requires
- A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.public List<AttachmentContent> getAttachmentsContent()
A description of the document attachments, including names, locations, sizes, and so on.
public void setAttachmentsContent(Collection<AttachmentContent> attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
attachmentsContent
- A description of the document attachments, including names, locations, sizes, and so on.public GetDocumentResult withAttachmentsContent(AttachmentContent... attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
NOTE: This method appends the values to the existing list (if any). Use
setAttachmentsContent(java.util.Collection)
or withAttachmentsContent(java.util.Collection)
if
you want to override the existing values.
attachmentsContent
- A description of the document attachments, including names, locations, sizes, and so on.public GetDocumentResult withAttachmentsContent(Collection<AttachmentContent> attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
attachmentsContent
- A description of the document attachments, including names, locations, sizes, and so on.public void setReviewStatus(String 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.
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.
ReviewStatus
public String getReviewStatus()
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.
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.
ReviewStatus
public GetDocumentResult withReviewStatus(String 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.
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.
ReviewStatus
public void setReviewStatus(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.
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.
ReviewStatus
public GetDocumentResult withReviewStatus(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.
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.
ReviewStatus
public String toString()
toString
in class Object
Object.toString()
public GetDocumentResult clone()