Package 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 Details

    • name

      GetDocumentRequest.Builder name(String name)

      The name of the SSM document.

      Parameters:
      name - The name of the SSM 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, 12.6. This value is unique across all versions of a document and can't be changed.

      Parameters:
      versionName - An optional field specifying 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.
      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

      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:

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