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

    • name

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

    • createdDate

      GetDocumentResponse.Builder createdDate(Instant createdDate)

      The date the SSM document was created.

      Parameters:
      createdDate - The date the SSM document was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      GetDocumentResponse.Builder displayName(String displayName)

      The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

      Parameters:
      displayName - The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
      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, 12.6. This value is unique across all versions of a document, and can't be changed.

      Parameters:
      versionName - 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

      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 SSM document, such as Creating, Active, Updating, Failed, and Deleting.

      Parameters:
      status - The status of the SSM 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:

    • status

      GetDocumentResponse.Builder status(DocumentStatus status)

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

      Parameters:
      status - The status of the SSM 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:

    • statusInformation

      GetDocumentResponse.Builder statusInformation(String statusInformation)

      A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

      Parameters:
      statusInformation - A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't 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 SSM document.

      Parameters:
      content - The contents of the SSM 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

      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:

    • 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

      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:

    • requires

      GetDocumentResponse.Builder requires(Collection<DocumentRequires> requires)

      A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

      Parameters:
      requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requires

      GetDocumentResponse.Builder requires(DocumentRequires... requires)

      A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

      Parameters:
      requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requires

      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.

      This is a convenience method that creates an instance of the DocumentRequires.Builder avoiding the need to create one manually via DocumentRequires.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requires(List<DocumentRequires>).

      Parameters:
      requires - a consumer that will call methods on DocumentRequires.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attachmentsContent

      GetDocumentResponse.Builder attachmentsContent(Collection<AttachmentContent> attachmentsContent)

      A description of the document attachments, including names, locations, sizes, and so on.

      Parameters:
      attachmentsContent - A description of the document attachments, including names, locations, sizes, and so on.
      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, and so on.

      Parameters:
      attachmentsContent - A description of the document attachments, including names, locations, sizes, and so on.
      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, and so on.

      This is a convenience method that creates an instance of the AttachmentContent.Builder avoiding the need to create one manually via AttachmentContent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachmentsContent(List<AttachmentContent>).

      Parameters:
      attachmentsContent - a consumer that will call methods on AttachmentContent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • reviewStatus

      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.

      Parameters:
      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.

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

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

      Parameters:
      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.

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