software.amazon.awssdk.services.ssm.model

Interface GetDocumentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetDocumentRequest.Builder,GetDocumentRequest>, SdkBuilder<GetDocumentRequest.Builder,GetDocumentRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

GetDocumentRequest

public static interface GetDocumentRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<GetDocumentRequest.Builder,GetDocumentRequest>

Method Summary

Modifier and Type	Method and Description
GetDocumentRequest.Builder	documentFormat(DocumentFormat documentFormat) Returns the document in the specified format.
GetDocumentRequest.Builder	documentFormat(String documentFormat) Returns the document in the specified format.
GetDocumentRequest.Builder	documentVersion(String documentVersion) The document version for which you want information.
GetDocumentRequest.Builder	name(String name) The name of the Systems Manager document.
GetDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetDocumentRequest.Builder	versionName(String versionName) An optional field specifying the version of the artifact associated with the document.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

GetDocumentRequest.Builder versionName(String versionName)

An optional field specifying 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 - An optional field specifying 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

GetDocumentRequest.Builder documentVersion(String documentVersion)

The document version for which you want information.

Parameters:

documentVersion - The document version for which you want information.

Returns:

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

documentFormat

GetDocumentRequest.Builder documentFormat(String documentFormat)

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Parameters:

documentFormat - Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Returns:

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

See Also:

DocumentFormat, DocumentFormat

documentFormat

GetDocumentRequest.Builder documentFormat(DocumentFormat documentFormat)

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Parameters:

documentFormat - Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Returns:

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

See Also:

DocumentFormat, DocumentFormat

overrideConfiguration

GetDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.