software.amazon.awssdk.services.ssm.model

Interface GetDocumentResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>, SdkBuilder<GetDocumentResponse.Builder,GetDocumentResponse>, SdkPojo, SdkResponse.Builder, SsmResponse.Builder

Enclosing class:

GetDocumentResponse

public static interface GetDocumentResponse.Builder
extends SsmResponse.Builder, SdkPojo, CopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>

Method Summary

Modifier and Type	Method and Description
GetDocumentResponse.Builder	attachmentsContent(AttachmentContent... attachmentsContent) A description of the document attachments, including names, locations, sizes, etc.
GetDocumentResponse.Builder	attachmentsContent(Collection<AttachmentContent> attachmentsContent) A description of the document attachments, including names, locations, sizes, etc.
GetDocumentResponse.Builder	attachmentsContent(Consumer<AttachmentContent.Builder>... attachmentsContent) A description of the document attachments, including names, locations, sizes, etc.
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	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.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

GetDocumentResponse.Builder name(String name)

The name of the Systems Manager document.

Parameters:

name - The name of the Systems Manager document.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionName

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentVersion

GetDocumentResponse.Builder documentVersion(String documentVersion)

The document version.

Parameters:

documentVersion - The document version.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetDocumentResponse.Builder status(String status)

The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

Parameters:

status - The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentStatus, DocumentStatus

status

GetDocumentResponse.Builder status(DocumentStatus status)

The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

Parameters:

status - The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentStatus, DocumentStatus

statusInformation

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."

Parameters:

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."

Returns:

Returns a reference to this object so that method calls can be chained together.

content

GetDocumentResponse.Builder content(String content)

The contents of the Systems Manager document.

Parameters:

content - The contents of the Systems Manager document.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentType

GetDocumentResponse.Builder documentType(String documentType)

The document type.

Parameters:

documentType - The document type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentType, DocumentType

documentType

GetDocumentResponse.Builder documentType(DocumentType documentType)

The document type.

Parameters:

documentType - The document type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentType, DocumentType

documentFormat

GetDocumentResponse.Builder documentFormat(String documentFormat)

The document format, either JSON or YAML.

Parameters:

documentFormat - The document format, either JSON or YAML.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentFormat, DocumentFormat

documentFormat

GetDocumentResponse.Builder documentFormat(DocumentFormat documentFormat)

The document format, either JSON or YAML.

Parameters:

documentFormat - The document format, either JSON or YAML.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentFormat, DocumentFormat

attachmentsContent

GetDocumentResponse.Builder attachmentsContent(Collection<AttachmentContent> attachmentsContent)

A description of the document attachments, including names, locations, sizes, etc.

Parameters:

attachmentsContent - A description of the document attachments, including names, locations, sizes, etc.

Returns:

Returns a reference to this object so that method calls can be chained together.

attachmentsContent

GetDocumentResponse.Builder attachmentsContent(AttachmentContent... attachmentsContent)

A description of the document attachments, including names, locations, sizes, etc.

Parameters:

attachmentsContent - A description of the document attachments, including names, locations, sizes, etc.

Returns:

Returns a reference to this object so that method calls can be chained together.

attachmentsContent

GetDocumentResponse.Builder attachmentsContent(Consumer<AttachmentContent.Builder>... attachmentsContent)

A description of the document attachments, including names, locations, sizes, etc.

This is a convenience that creates an instance of the 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 #attachmentsContent(List).

Parameters:

attachmentsContent - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#attachmentsContent(List)