public static interface GetDocumentResponse.Builder extends SsmResponse.Builder, SdkPojo, CopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>
Modifier and Type | Method and Description |
---|---|
GetDocumentResponse.Builder |
attachmentsContent(AttachmentContent... attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
|
GetDocumentResponse.Builder |
attachmentsContent(Collection<AttachmentContent> attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
|
GetDocumentResponse.Builder |
attachmentsContent(Consumer<AttachmentContent.Builder>... attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
|
GetDocumentResponse.Builder |
content(String content)
The contents of the Systems Manager document.
|
GetDocumentResponse.Builder |
documentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
|
GetDocumentResponse.Builder |
documentFormat(String documentFormat)
The document format, either JSON or YAML.
|
GetDocumentResponse.Builder |
documentType(DocumentType documentType)
The document type.
|
GetDocumentResponse.Builder |
documentType(String documentType)
The document type.
|
GetDocumentResponse.Builder |
documentVersion(String documentVersion)
The document version.
|
GetDocumentResponse.Builder |
name(String name)
The name of the Systems Manager document.
|
GetDocumentResponse.Builder |
requires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document.
|
GetDocumentResponse.Builder |
requires(Consumer<DocumentRequires.Builder>... requires)
A list of SSM documents required by a document.
|
GetDocumentResponse.Builder |
requires(DocumentRequires... requires)
A list of SSM documents required by a document.
|
GetDocumentResponse.Builder |
reviewStatus(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.
|
GetDocumentResponse.Builder |
reviewStatus(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.
|
GetDocumentResponse.Builder |
status(DocumentStatus status)
The status of the Systems Manager document, such as
Creating , Active ,
Updating , Failed , and Deleting . |
GetDocumentResponse.Builder |
status(String status)
The status of the Systems Manager document, such as
Creating , Active ,
Updating , Failed , and Deleting . |
GetDocumentResponse.Builder |
statusInformation(String statusInformation)
A message returned by AWS Systems Manager that explains the
Status value. |
GetDocumentResponse.Builder |
versionName(String versionName)
The version of the artifact associated with the document.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
GetDocumentResponse.Builder name(String name)
The name of the Systems Manager document.
name
- The name of the Systems Manager document.GetDocumentResponse.Builder versionName(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.
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.GetDocumentResponse.Builder documentVersion(String documentVersion)
The document version.
documentVersion
- The document version.GetDocumentResponse.Builder status(String status)
The status of the Systems Manager document, such as Creating
, Active
,
Updating
, Failed
, and Deleting
.
status
- The status of the Systems Manager document, such as Creating
, Active
,
Updating
, Failed
, and Deleting
.DocumentStatus
,
DocumentStatus
GetDocumentResponse.Builder status(DocumentStatus status)
The status of the Systems Manager document, such as Creating
, Active
,
Updating
, Failed
, and Deleting
.
status
- The status of the Systems Manager document, such as Creating
, Active
,
Updating
, Failed
, and Deleting
.DocumentStatus
,
DocumentStatus
GetDocumentResponse.Builder statusInformation(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."
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."GetDocumentResponse.Builder content(String content)
The contents of the Systems Manager document.
content
- The contents of the Systems Manager document.GetDocumentResponse.Builder documentType(String documentType)
The document type.
documentType
- The document type.DocumentType
,
DocumentType
GetDocumentResponse.Builder documentType(DocumentType documentType)
The document type.
documentType
- The document type.DocumentType
,
DocumentType
GetDocumentResponse.Builder documentFormat(String documentFormat)
The document format, either JSON or YAML.
documentFormat
- The document format, either JSON or YAML.DocumentFormat
,
DocumentFormat
GetDocumentResponse.Builder documentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
documentFormat
- The document format, either JSON or YAML.DocumentFormat
,
DocumentFormat
GetDocumentResponse.Builder requires(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.GetDocumentResponse.Builder requires(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.GetDocumentResponse.Builder requires(Consumer<DocumentRequires.Builder>... requires)
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #requires(List)
.requires
- a consumer that will call methods on List.Builder
#requires(List)
GetDocumentResponse.Builder attachmentsContent(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.GetDocumentResponse.Builder attachmentsContent(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.GetDocumentResponse.Builder attachmentsContent(Consumer<AttachmentContent.Builder>... attachmentsContent)
A description of the document attachments, including names, locations, sizes, and so on.
This is a convenience that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #attachmentsContent(List)
.attachmentsContent
- a consumer that will call methods on List.Builder
#attachmentsContent(List)
GetDocumentResponse.Builder reviewStatus(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
,
ReviewStatus
GetDocumentResponse.Builder reviewStatus(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
,
ReviewStatus
Copyright © 2021. All rights reserved.