Package software.amazon.awssdk.services.ssm.model

Interface GetDocumentRequest.Builder

    • Method Detail

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