DocumentDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.DocumentDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an Amazon Web Services Systems Manager document (SSM document).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentDescription()

Constructors
Constructor and Description
`DocumentDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApprovedVersion()` The version of the document currently approved for use in the organization.
`List<AttachmentInformation>`	`getAttachmentsInformation()` Details about the document attachments, including names, locations, sizes, and so on.
`String`	`getAuthor()` The user in your organization who created the document.
`List<String>`	`getCategory()` The classification of a document to help you identify and categorize its use.
`List<String>`	`getCategoryEnum()` The value that identifies a document's category.
`Date`	`getCreatedDate()` The date when the document was created.
`String`	`getDefaultVersion()` The default version.
`String`	`getDescription()` A description of the document.
`String`	`getDisplayName()` The friendly name of the SSM document.
`String`	`getDocumentFormat()` The document format, either JSON or YAML.
`String`	`getDocumentType()` The type of document.
`String`	`getDocumentVersion()` The document version.
`String`	`getHash()` The Sha256 or Sha1 hash created by the system when the document was created.
`String`	`getHashType()` The hash type of the document.
`String`	`getLatestVersion()` The latest version of the document.
`String`	`getName()` The name of the SSM document.
`String`	`getOwner()` The Amazon Web Services user that created the document.
`List<DocumentParameter>`	`getParameters()` A description of the parameters for a document.
`String`	`getPendingReviewVersion()` The version of the document that is currently under review.
`List<String>`	`getPlatformTypes()` The list of operating system (OS) platforms compatible with this SSM document.
`List<DocumentRequires>`	`getRequires()` A list of SSM documents required by a document.
`List<ReviewInformation>`	`getReviewInformation()` Details about the review of a document.
`String`	`getReviewStatus()` The current status of the review.
`String`	`getSchemaVersion()` The schema version.
`String`	`getSha1()` The SHA1 hash of the document, which you can use for verification.
`String`	`getStatus()` The status of the SSM document.
`String`	`getStatusInformation()` A message returned by Amazon Web Services Systems Manager that explains the `Status` value.
`List<Tag>`	`getTags()` The tags, or metadata, that have been applied to the document.
`String`	`getTargetType()` The target type which defines the kinds of resources the document can run on.
`String`	`getVersionName()` The version of the artifact associated with the document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApprovedVersion(String approvedVersion)` The version of the document currently approved for use in the organization.
`void`	`setAttachmentsInformation(Collection<AttachmentInformation> attachmentsInformation)` Details about the document attachments, including names, locations, sizes, and so on.
`void`	`setAuthor(String author)` The user in your organization who created the document.
`void`	`setCategory(Collection<String> category)` The classification of a document to help you identify and categorize its use.
`void`	`setCategoryEnum(Collection<String> categoryEnum)` The value that identifies a document's category.
`void`	`setCreatedDate(Date createdDate)` The date when the document was created.
`void`	`setDefaultVersion(String defaultVersion)` The default version.
`void`	`setDescription(String description)` A description of the document.
`void`	`setDisplayName(String displayName)` The friendly name of the SSM document.
`void`	`setDocumentFormat(DocumentFormat documentFormat)` The document format, either JSON or YAML.
`void`	`setDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`void`	`setDocumentType(DocumentType documentType)` The type of document.
`void`	`setDocumentType(String documentType)` The type of document.
`void`	`setDocumentVersion(String documentVersion)` The document version.
`void`	`setHash(String hash)` The Sha256 or Sha1 hash created by the system when the document was created.
`void`	`setHashType(DocumentHashType hashType)` The hash type of the document.
`void`	`setHashType(String hashType)` The hash type of the document.
`void`	`setLatestVersion(String latestVersion)` The latest version of the document.
`void`	`setName(String name)` The name of the SSM document.
`void`	`setOwner(String owner)` The Amazon Web Services user that created the document.
`void`	`setParameters(Collection<DocumentParameter> parameters)` A description of the parameters for a document.
`void`	`setPendingReviewVersion(String pendingReviewVersion)` The version of the document that is currently under review.
`void`	`setPlatformTypes(Collection<String> platformTypes)` The list of operating system (OS) platforms compatible with this SSM document.
`void`	`setRequires(Collection<DocumentRequires> requires)` A list of SSM documents required by a document.
`void`	`setReviewInformation(Collection<ReviewInformation> reviewInformation)` Details about the review of a document.
`void`	`setReviewStatus(ReviewStatus reviewStatus)` The current status of the review.
`void`	`setReviewStatus(String reviewStatus)` The current status of the review.
`void`	`setSchemaVersion(String schemaVersion)` The schema version.
`void`	`setSha1(String sha1)` The SHA1 hash of the document, which you can use for verification.
`void`	`setStatus(DocumentStatus status)` The status of the SSM document.
`void`	`setStatus(String status)` The status of the SSM document.
`void`	`setStatusInformation(String statusInformation)` A message returned by Amazon Web Services Systems Manager that explains the `Status` value.
`void`	`setTags(Collection<Tag> tags)` The tags, or metadata, that have been applied to the document.
`void`	`setTargetType(String targetType)` The target type which defines the kinds of resources the document can run on.
`void`	`setVersionName(String versionName)` The version of the artifact associated with the document.
`String`	`toString()` Returns a string representation of this object.
`DocumentDescription`	`withApprovedVersion(String approvedVersion)` The version of the document currently approved for use in the organization.
`DocumentDescription`	`withAttachmentsInformation(AttachmentInformation... attachmentsInformation)` Details about the document attachments, including names, locations, sizes, and so on.
`DocumentDescription`	`withAttachmentsInformation(Collection<AttachmentInformation> attachmentsInformation)` Details about the document attachments, including names, locations, sizes, and so on.
`DocumentDescription`	`withAuthor(String author)` The user in your organization who created the document.
`DocumentDescription`	`withCategory(Collection<String> category)` The classification of a document to help you identify and categorize its use.
`DocumentDescription`	`withCategory(String... category)` The classification of a document to help you identify and categorize its use.
`DocumentDescription`	`withCategoryEnum(Collection<String> categoryEnum)` The value that identifies a document's category.
`DocumentDescription`	`withCategoryEnum(String... categoryEnum)` The value that identifies a document's category.
`DocumentDescription`	`withCreatedDate(Date createdDate)` The date when the document was created.
`DocumentDescription`	`withDefaultVersion(String defaultVersion)` The default version.
`DocumentDescription`	`withDescription(String description)` A description of the document.
`DocumentDescription`	`withDisplayName(String displayName)` The friendly name of the SSM document.
`DocumentDescription`	`withDocumentFormat(DocumentFormat documentFormat)` The document format, either JSON or YAML.
`DocumentDescription`	`withDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`DocumentDescription`	`withDocumentType(DocumentType documentType)` The type of document.
`DocumentDescription`	`withDocumentType(String documentType)` The type of document.
`DocumentDescription`	`withDocumentVersion(String documentVersion)` The document version.
`DocumentDescription`	`withHash(String hash)` The Sha256 or Sha1 hash created by the system when the document was created.
`DocumentDescription`	`withHashType(DocumentHashType hashType)` The hash type of the document.
`DocumentDescription`	`withHashType(String hashType)` The hash type of the document.
`DocumentDescription`	`withLatestVersion(String latestVersion)` The latest version of the document.
`DocumentDescription`	`withName(String name)` The name of the SSM document.
`DocumentDescription`	`withOwner(String owner)` The Amazon Web Services user that created the document.
`DocumentDescription`	`withParameters(Collection<DocumentParameter> parameters)` A description of the parameters for a document.
`DocumentDescription`	`withParameters(DocumentParameter... parameters)` A description of the parameters for a document.
`DocumentDescription`	`withPendingReviewVersion(String pendingReviewVersion)` The version of the document that is currently under review.
`DocumentDescription`	`withPlatformTypes(Collection<String> platformTypes)` The list of operating system (OS) platforms compatible with this SSM document.
`DocumentDescription`	`withPlatformTypes(PlatformType... platformTypes)` The list of operating system (OS) platforms compatible with this SSM document.
`DocumentDescription`	`withPlatformTypes(String... platformTypes)` The list of operating system (OS) platforms compatible with this SSM document.
`DocumentDescription`	`withRequires(Collection<DocumentRequires> requires)` A list of SSM documents required by a document.
`DocumentDescription`	`withRequires(DocumentRequires... requires)` A list of SSM documents required by a document.
`DocumentDescription`	`withReviewInformation(Collection<ReviewInformation> reviewInformation)` Details about the review of a document.
`DocumentDescription`	`withReviewInformation(ReviewInformation... reviewInformation)` Details about the review of a document.
`DocumentDescription`	`withReviewStatus(ReviewStatus reviewStatus)` The current status of the review.
`DocumentDescription`	`withReviewStatus(String reviewStatus)` The current status of the review.
`DocumentDescription`	`withSchemaVersion(String schemaVersion)` The schema version.
`DocumentDescription`	`withSha1(String sha1)` The SHA1 hash of the document, which you can use for verification.
`DocumentDescription`	`withStatus(DocumentStatus status)` The status of the SSM document.
`DocumentDescription`	`withStatus(String status)` The status of the SSM document.
`DocumentDescription`	`withStatusInformation(String statusInformation)` A message returned by Amazon Web Services Systems Manager that explains the `Status` value.
`DocumentDescription`	`withTags(Collection<Tag> tags)` The tags, or metadata, that have been applied to the document.
`DocumentDescription`	`withTags(Tag... tags)` The tags, or metadata, that have been applied to the document.
`DocumentDescription`	`withTargetType(String targetType)` The target type which defines the kinds of resources the document can run on.
`DocumentDescription`	`withVersionName(String versionName)` The version of the artifact associated with the document.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentDescription
```
public DocumentDescription()
```
- Method Detail
  - setSha1
```
public void setSha1(String sha1)
```
    The SHA1 hash of the document, which you can use for verification.
    
    Parameters:
    
    sha1 - The SHA1 hash of the document, which you can use for verification.
  - getSha1
```
public String getSha1()
```
    The SHA1 hash of the document, which you can use for verification.
    
    Returns:
    
    The SHA1 hash of the document, which you can use for verification.
  - withSha1
```
public DocumentDescription withSha1(String sha1)
```
    The SHA1 hash of the document, which you can use for verification.
    
    Parameters:
    
    sha1 - The SHA1 hash of the document, which you can use for verification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHash
```
public void setHash(String hash)
```
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hash - The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
  - getHash
```
public String getHash()
```
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
  - withHash
```
public DocumentDescription withHash(String hash)
```
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hash - The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHashType
```
public void setHashType(String hashType)
```
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - getHashType
```
public String getHashType()
```
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - withHashType
```
public DocumentDescription withHashType(String hashType)
```
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentHashType
  - setHashType
```
public void setHashType(DocumentHashType hashType)
```
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - withHashType
```
public DocumentDescription withHashType(DocumentHashType hashType)
```
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentHashType
  - setName
```
public void setName(String name)
```
    The name of the SSM document.
    
    Parameters:
    
    name - The name of the SSM document.
  - getName
```
public String getName()
```
    The name of the SSM document.
    
    Returns:
    
    The name of the SSM document.
  - withName
```
public DocumentDescription withName(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.
  - setDisplayName
```
public void setDisplayName(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.
  - getDisplayName
```
public String getDisplayName()
```
    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:
    
    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.
  - withDisplayName
```
public DocumentDescription withDisplayName(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.
  - setVersionName
```
public void setVersionName(String versionName)
```
    The version of the artifact associated with the document.
    
    Parameters:
    
    versionName - The version of the artifact associated with the document.
  - getVersionName
```
public String getVersionName()
```
    The version of the artifact associated with the document.
    
    Returns:
    
    The version of the artifact associated with the document.
  - withVersionName
```
public DocumentDescription withVersionName(String versionName)
```
    The version of the artifact associated with the document.
    
    Parameters:
    
    versionName - The version of the artifact associated with the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwner
```
public void setOwner(String owner)
```
    The Amazon Web Services user that created the document.
    
    Parameters:
    
    owner - The Amazon Web Services user that created the document.
  - getOwner
```
public String getOwner()
```
    The Amazon Web Services user that created the document.
    
    Returns:
    
    The Amazon Web Services user that created the document.
  - withOwner
```
public DocumentDescription withOwner(String owner)
```
    The Amazon Web Services user that created the document.
    
    Parameters:
    
    owner - The Amazon Web Services user that created the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date when the document was created.
    
    Parameters:
    
    createdDate - The date when the document was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date when the document was created.
    
    Returns:
    
    The date when the document was created.
  - withCreatedDate
```
public DocumentDescription withCreatedDate(Date createdDate)
```
    The date when the document was created.
    
    Parameters:
    
    createdDate - The date when the document was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the SSM document.
    
    Parameters:
    
    status - The status of the SSM document.
    
    See Also:
    
    DocumentStatus
  - getStatus
```
public String getStatus()
```
    The status of the SSM document.
    
    Returns:
    
    The status of the SSM document.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public DocumentDescription withStatus(String status)
```
    The status of the SSM document.
    
    Parameters:
    
    status - The status of the SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - setStatus
```
public void setStatus(DocumentStatus status)
```
    The status of the SSM document.
    
    Parameters:
    
    status - The status of the SSM document.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public DocumentDescription withStatus(DocumentStatus status)
```
    The status of the SSM document.
    
    Parameters:
    
    status - The status of the SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - setStatusInformation
```
public void setStatusInformation(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."
  - getStatusInformation
```
public String getStatusInformation()
```
    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:
    
    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."
  - withStatusInformation
```
public DocumentDescription withStatusInformation(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.
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The document version.
    
    Parameters:
    
    documentVersion - The document version.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - withDocumentVersion
```
public DocumentDescription withDocumentVersion(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.
  - setDescription
```
public void setDescription(String description)
```
    A description of the document.
    
    Parameters:
    
    description - A description of the document.
  - getDescription
```
public String getDescription()
```
    A description of the document.
    
    Returns:
    
    A description of the document.
  - withDescription
```
public DocumentDescription withDescription(String description)
```
    A description of the document.
    
    Parameters:
    
    description - A description of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public List<DocumentParameter> getParameters()
```
    A description of the parameters for a document.
    
    Returns:
    
    A description of the parameters for a document.
  - setParameters
```
public void setParameters(Collection<DocumentParameter> parameters)
```
    A description of the parameters for a document.
    
    Parameters:
    
    parameters - A description of the parameters for a document.
  - withParameters
```
public DocumentDescription withParameters(DocumentParameter... parameters)
```
    A description of the parameters for a document.
    
    NOTE: This method appends the values to the existing list (if any). Use setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    parameters - A description of the parameters for a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParameters
```
public DocumentDescription withParameters(Collection<DocumentParameter> parameters)
```
    A description of the parameters for a document.
    
    Parameters:
    
    parameters - A description of the parameters for a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlatformTypes
```
public List<String> getPlatformTypes()
```
    The list of operating system (OS) platforms compatible with this SSM document.
    
    Returns:
    
    The list of operating system (OS) platforms compatible with this SSM document.
    
    See Also:
    
    PlatformType
  - setPlatformTypes
```
public void setPlatformTypes(Collection<String> platformTypes)
```
    The list of operating system (OS) platforms compatible with this SSM document.
    
    Parameters:
    
    platformTypes - The list of operating system (OS) platforms compatible with this SSM document.
    
    See Also:
    
    PlatformType
  - withPlatformTypes
```
public DocumentDescription withPlatformTypes(String... platformTypes)
```
    The list of operating system (OS) platforms compatible with this SSM document.
    
    NOTE: This method appends the values to the existing list (if any). Use setPlatformTypes(java.util.Collection) or withPlatformTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    platformTypes - The list of operating system (OS) platforms compatible with this SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - withPlatformTypes
```
public DocumentDescription withPlatformTypes(Collection<String> platformTypes)
```
    The list of operating system (OS) platforms compatible with this SSM document.
    
    Parameters:
    
    platformTypes - The list of operating system (OS) platforms compatible with this SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - withPlatformTypes
```
public DocumentDescription withPlatformTypes(PlatformType... platformTypes)
```
    The list of operating system (OS) platforms compatible with this SSM document.
    
    Parameters:
    
    platformTypes - The list of operating system (OS) platforms compatible with this SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - setDocumentType
```
public void setDocumentType(String documentType)
```
    The type of document.
    
    Parameters:
    
    documentType - The type of document.
    
    See Also:
    
    DocumentType
  - getDocumentType
```
public String getDocumentType()
```
    The type of document.
    
    Returns:
    
    The type of document.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public DocumentDescription withDocumentType(String documentType)
```
    The type of document.
    
    Parameters:
    
    documentType - The type of document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setDocumentType
```
public void setDocumentType(DocumentType documentType)
```
    The type of document.
    
    Parameters:
    
    documentType - The type of document.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public DocumentDescription withDocumentType(DocumentType documentType)
```
    The type of document.
    
    Parameters:
    
    documentType - The type of document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setSchemaVersion
```
public void setSchemaVersion(String schemaVersion)
```
    The schema version.
    
    Parameters:
    
    schemaVersion - The schema version.
  - getSchemaVersion
```
public String getSchemaVersion()
```
    The schema version.
    
    Returns:
    
    The schema version.
  - withSchemaVersion
```
public DocumentDescription withSchemaVersion(String schemaVersion)
```
    The schema version.
    
    Parameters:
    
    schemaVersion - The schema version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatestVersion
```
public void setLatestVersion(String latestVersion)
```
    The latest version of the document.
    
    Parameters:
    
    latestVersion - The latest version of the document.
  - getLatestVersion
```
public String getLatestVersion()
```
    The latest version of the document.
    
    Returns:
    
    The latest version of the document.
  - withLatestVersion
```
public DocumentDescription withLatestVersion(String latestVersion)
```
    The latest version of the document.
    
    Parameters:
    
    latestVersion - The latest version of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultVersion
```
public void setDefaultVersion(String defaultVersion)
```
    The default version.
    
    Parameters:
    
    defaultVersion - The default version.
  - getDefaultVersion
```
public String getDefaultVersion()
```
    The default version.
    
    Returns:
    
    The default version.
  - withDefaultVersion
```
public DocumentDescription withDefaultVersion(String defaultVersion)
```
    The default version.
    
    Parameters:
    
    defaultVersion - The default version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentFormat
```
public void setDocumentFormat(String documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - getDocumentFormat
```
public String getDocumentFormat()
```
    The document format, either JSON or YAML.
    
    Returns:
    
    The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - withDocumentFormat
```
public DocumentDescription withDocumentFormat(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
  - setDocumentFormat
```
public void setDocumentFormat(DocumentFormat documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - withDocumentFormat
```
public DocumentDescription withDocumentFormat(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
  - setTargetType
```
public void setTargetType(String targetType)
```
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Parameters:
    
    targetType - The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
  - getTargetType
```
public String getTargetType()
```
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Returns:
    
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
  - withTargetType
```
public DocumentDescription withTargetType(String targetType)
```
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Parameters:
    
    targetType - The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags, or metadata, that have been applied to the document.
    
    Returns:
    
    The tags, or metadata, that have been applied to the document.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags, or metadata, that have been applied to the document.
    
    Parameters:
    
    tags - The tags, or metadata, that have been applied to the document.
  - withTags
```
public DocumentDescription withTags(Tag... tags)
```
    The tags, or metadata, that have been applied to the document.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags, or metadata, that have been applied to the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DocumentDescription withTags(Collection<Tag> tags)
```
    The tags, or metadata, that have been applied to the document.
    
    Parameters:
    
    tags - The tags, or metadata, that have been applied to the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttachmentsInformation
```
public List<AttachmentInformation> getAttachmentsInformation()
```
    Details about the document attachments, including names, locations, sizes, and so on.
    
    Returns:
    
    Details about the document attachments, including names, locations, sizes, and so on.
  - setAttachmentsInformation
```
public void setAttachmentsInformation(Collection<AttachmentInformation> attachmentsInformation)
```
    Details about the document attachments, including names, locations, sizes, and so on.
    
    Parameters:
    
    attachmentsInformation - Details about the document attachments, including names, locations, sizes, and so on.
  - withAttachmentsInformation
```
public DocumentDescription withAttachmentsInformation(AttachmentInformation... attachmentsInformation)
```
    Details about the document attachments, including names, locations, sizes, and so on.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachmentsInformation(java.util.Collection) or withAttachmentsInformation(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attachmentsInformation - Details about 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.
  - withAttachmentsInformation
```
public DocumentDescription withAttachmentsInformation(Collection<AttachmentInformation> attachmentsInformation)
```
    Details about the document attachments, including names, locations, sizes, and so on.
    
    Parameters:
    
    attachmentsInformation - Details about 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.
  - getRequires
```
public List<DocumentRequires> getRequires()
```
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    Returns:
    
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
  - setRequires
```
public void setRequires(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.
  - withRequires
```
public DocumentDescription withRequires(DocumentRequires... requires)
```
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    NOTE: This method appends the values to the existing list (if any). Use setRequires(java.util.Collection) or withRequires(java.util.Collection) if you want to override the existing values.
    
    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.
  - withRequires
```
public DocumentDescription withRequires(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.
  - setAuthor
```
public void setAuthor(String author)
```
    The user in your organization who created the document.
    
    Parameters:
    
    author - The user in your organization who created the document.
  - getAuthor
```
public String getAuthor()
```
    The user in your organization who created the document.
    
    Returns:
    
    The user in your organization who created the document.
  - withAuthor
```
public DocumentDescription withAuthor(String author)
```
    The user in your organization who created the document.
    
    Parameters:
    
    author - The user in your organization who created the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReviewInformation
```
public List<ReviewInformation> getReviewInformation()
```
    Details about the review of a document.
    
    Returns:
    
    Details about the review of a document.
  - setReviewInformation
```
public void setReviewInformation(Collection<ReviewInformation> reviewInformation)
```
    Details about the review of a document.
    
    Parameters:
    
    reviewInformation - Details about the review of a document.
  - withReviewInformation
```
public DocumentDescription withReviewInformation(ReviewInformation... reviewInformation)
```
    Details about the review of a document.
    
    NOTE: This method appends the values to the existing list (if any). Use setReviewInformation(java.util.Collection) or withReviewInformation(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    reviewInformation - Details about the review of a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReviewInformation
```
public DocumentDescription withReviewInformation(Collection<ReviewInformation> reviewInformation)
```
    Details about the review of a document.
    
    Parameters:
    
    reviewInformation - Details about the review of a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApprovedVersion
```
public void setApprovedVersion(String approvedVersion)
```
    The version of the document currently approved for use in the organization.
    
    Parameters:
    
    approvedVersion - The version of the document currently approved for use in the organization.
  - getApprovedVersion
```
public String getApprovedVersion()
```
    The version of the document currently approved for use in the organization.
    
    Returns:
    
    The version of the document currently approved for use in the organization.
  - withApprovedVersion
```
public DocumentDescription withApprovedVersion(String approvedVersion)
```
    The version of the document currently approved for use in the organization.
    
    Parameters:
    
    approvedVersion - The version of the document currently approved for use in the organization.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingReviewVersion
```
public void setPendingReviewVersion(String pendingReviewVersion)
```
    The version of the document that is currently under review.
    
    Parameters:
    
    pendingReviewVersion - The version of the document that is currently under review.
  - getPendingReviewVersion
```
public String getPendingReviewVersion()
```
    The version of the document that is currently under review.
    
    Returns:
    
    The version of the document that is currently under review.
  - withPendingReviewVersion
```
public DocumentDescription withPendingReviewVersion(String pendingReviewVersion)
```
    The version of the document that is currently under review.
    
    Parameters:
    
    pendingReviewVersion - The version of the document that is currently under review.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReviewStatus
```
public void setReviewStatus(String reviewStatus)
```
    The current status of the review.
    
    Parameters:
    
    reviewStatus - The current status of the review.
    
    See Also:
    
    ReviewStatus
  - getReviewStatus
```
public String getReviewStatus()
```
    The current status of the review.
    
    Returns:
    
    The current status of the review.
    
    See Also:
    
    ReviewStatus
  - withReviewStatus
```
public DocumentDescription withReviewStatus(String reviewStatus)
```
    The current status of the review.
    
    Parameters:
    
    reviewStatus - The current status of the review.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReviewStatus
  - setReviewStatus
```
public void setReviewStatus(ReviewStatus reviewStatus)
```
    The current status of the review.
    
    Parameters:
    
    reviewStatus - The current status of the review.
    
    See Also:
    
    ReviewStatus
  - withReviewStatus
```
public DocumentDescription withReviewStatus(ReviewStatus reviewStatus)
```
    The current status of the review.
    
    Parameters:
    
    reviewStatus - The current status of the review.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReviewStatus
  - getCategory
```
public List<String> getCategory()
```
    The classification of a document to help you identify and categorize its use.
    
    Returns:
    
    The classification of a document to help you identify and categorize its use.
  - setCategory
```
public void setCategory(Collection<String> category)
```
    The classification of a document to help you identify and categorize its use.
    
    Parameters:
    
    category - The classification of a document to help you identify and categorize its use.
  - withCategory
```
public DocumentDescription withCategory(String... category)
```
    The classification of a document to help you identify and categorize its use.
    
    NOTE: This method appends the values to the existing list (if any). Use setCategory(java.util.Collection) or withCategory(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    category - The classification of a document to help you identify and categorize its use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCategory
```
public DocumentDescription withCategory(Collection<String> category)
```
    The classification of a document to help you identify and categorize its use.
    
    Parameters:
    
    category - The classification of a document to help you identify and categorize its use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCategoryEnum
```
public List<String> getCategoryEnum()
```
    The value that identifies a document's category.
    
    Returns:
    
    The value that identifies a document's category.
  - setCategoryEnum
```
public void setCategoryEnum(Collection<String> categoryEnum)
```
    The value that identifies a document's category.
    
    Parameters:
    
    categoryEnum - The value that identifies a document's category.
  - withCategoryEnum
```
public DocumentDescription withCategoryEnum(String... categoryEnum)
```
    The value that identifies a document's category.
    
    NOTE: This method appends the values to the existing list (if any). Use setCategoryEnum(java.util.Collection) or withCategoryEnum(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    categoryEnum - The value that identifies a document's category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCategoryEnum
```
public DocumentDescription withCategoryEnum(Collection<String> categoryEnum)
```
    The value that identifies a document's category.
    
    Parameters:
    
    categoryEnum - The value that identifies a document's category.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class DocumentDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentDescription

Method Detail

setSha1

getSha1

withSha1

setHash

getHash

withHash

setHashType

getHashType

withHashType

setHashType

withHashType

setName

getName

withName

setDisplayName

getDisplayName

withDisplayName

setVersionName

getVersionName

withVersionName

setOwner

getOwner

withOwner

setCreatedDate

getCreatedDate

withCreatedDate

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusInformation

getStatusInformation

withStatusInformation

setDocumentVersion

getDocumentVersion

withDocumentVersion

setDescription

getDescription

withDescription

getParameters

setParameters

withParameters

withParameters

getPlatformTypes

setPlatformTypes

withPlatformTypes

withPlatformTypes

withPlatformTypes

setDocumentType

getDocumentType

withDocumentType

setDocumentType

withDocumentType

setSchemaVersion

getSchemaVersion

withSchemaVersion

setLatestVersion

getLatestVersion

withLatestVersion

setDefaultVersion

getDefaultVersion

withDefaultVersion

setDocumentFormat

getDocumentFormat

withDocumentFormat

setDocumentFormat

withDocumentFormat

setTargetType

getTargetType

withTargetType

getTags