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 a Systems Manager 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)`
`Date`	`getCreatedDate()` The date when the document was created.
`String`	`getDefaultVersion()` The default version.
`String`	`getDescription()` A description of the document.
`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()` Sha256 or Sha1.
`String`	`getLatestVersion()` The latest version of the document.
`String`	`getName()` The name of the Systems Manager document.
`String`	`getOwner()` The AWS user account that created the document.
`List<DocumentParameter>`	`getParameters()` A description of the parameters for a document.
`List<String>`	`getPlatformTypes()` The list of OS platforms compatible with this Systems Manager document.
`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 Systems Manager document.
`List<Tag>`	`getTags()` The tags, or metadata, that have been applied to the document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`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)` Sha256 or Sha1.
`void`	`setHashType(String hashType)` Sha256 or Sha1.
`void`	`setLatestVersion(String latestVersion)` The latest version of the document.
`void`	`setName(String name)` The name of the Systems Manager document.
`void`	`setOwner(String owner)` The AWS user account that created the document.
`void`	`setParameters(Collection<DocumentParameter> parameters)` A description of the parameters for a document.
`void`	`setPlatformTypes(Collection<String> platformTypes)` The list of OS platforms compatible with this Systems Manager document.
`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 Systems Manager document.
`void`	`setStatus(String status)` The status of the Systems Manager document.
`void`	`setTags(Collection<Tag> tags)` The tags, or metadata, that have been applied to the document.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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`	`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)` Sha256 or Sha1.
`DocumentDescription`	`withHashType(String hashType)` Sha256 or Sha1.
`DocumentDescription`	`withLatestVersion(String latestVersion)` The latest version of the document.
`DocumentDescription`	`withName(String name)` The name of the Systems Manager document.
`DocumentDescription`	`withOwner(String owner)` The AWS user account 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`	`withPlatformTypes(Collection<String> platformTypes)` The list of OS platforms compatible with this Systems Manager document.
`DocumentDescription`	`withPlatformTypes(PlatformType... platformTypes)` The list of OS platforms compatible with this Systems Manager document.
`DocumentDescription`	`withPlatformTypes(String... platformTypes)` The list of OS platforms compatible with this Systems Manager document.
`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 Systems Manager document.
`DocumentDescription`	`withStatus(String status)` The status of the Systems Manager document.
`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.

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)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - getHashType
```
public String getHashType()
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - withHashType
```
public DocumentDescription withHashType(String hashType)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - 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)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - withHashType
```
public DocumentDescription withHashType(DocumentHashType hashType)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    hashType - 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 Systems Manager document.
    
    Parameters:
    
    name - The name of the Systems Manager document.
  - getName
```
public String getName()
```
    The name of the Systems Manager document.
    
    Returns:
    
    The name of the Systems Manager document.
  - withName
```
public DocumentDescription withName(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.
  - setOwner
```
public void setOwner(String owner)
```
    The AWS user account that created the document.
    
    Parameters:
    
    owner - The AWS user account that created the document.
  - getOwner
```
public String getOwner()
```
    The AWS user account that created the document.
    
    Returns:
    
    The AWS user account that created the document.
  - withOwner
```
public DocumentDescription withOwner(String owner)
```
    The AWS user account that created the document.
    
    Parameters:
    
    owner - The AWS user account 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 Systems Manager document.
    
    Parameters:
    
    status - The status of the Systems Manager document.
    
    See Also:
    
    DocumentStatus
  - getStatus
```
public String getStatus()
```
    The status of the Systems Manager document.
    
    Returns:
    
    The status of the Systems Manager document.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public DocumentDescription withStatus(String status)
```
    The status of the Systems Manager document.
    
    Parameters:
    
    status - The status of the Systems Manager 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 Systems Manager document.
    
    Parameters:
    
    status - The status of the Systems Manager document.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public DocumentDescription withStatus(DocumentStatus status)
```
    The status of the Systems Manager document.
    
    Parameters:
    
    status - The status of the Systems Manager document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - 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 OS platforms compatible with this Systems Manager document.
    
    Returns:
    
    The list of OS platforms compatible with this Systems Manager document.
    
    See Also:
    
    PlatformType
  - setPlatformTypes
```
public void setPlatformTypes(Collection<String> platformTypes)
```
    The list of OS platforms compatible with this Systems Manager document.
    
    Parameters:
    
    platformTypes - The list of OS platforms compatible with this Systems Manager document.
    
    See Also:
    
    PlatformType
  - withPlatformTypes
```
public DocumentDescription withPlatformTypes(String... platformTypes)
```
    The list of OS platforms compatible with this Systems Manager 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 OS platforms compatible with this Systems Manager 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 OS platforms compatible with this Systems Manager document.
    
    Parameters:
    
    platformTypes - The list of OS platforms compatible with this Systems Manager 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 OS platforms compatible with this Systems Manager document.
    
    Parameters:
    
    platformTypes - The list of OS platforms compatible with this Systems Manager 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.
  - 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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.

Did this page help you?

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

setOwner

getOwner

withOwner

setCreatedDate

getCreatedDate

withCreatedDate

setStatus

getStatus

withStatus

setStatus

withStatus

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

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall