Class DocumentDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Describes an SSM document.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The date when the SSM document was created.A description of the document.getHash()
The Sha256 or Sha1 hash created by the system when the document was created.Sha256 or Sha1.getName()
The name of the SSM document.getOwner()
The AWS user account of the person who created the document.A description of the parameters for a document.The list of OS platforms compatible with this SSM document.getSha1()
The SHA1 hash of the document, which you can use for verification purposes.The status of the SSM document.int
hashCode()
void
setCreatedDate
(Date createdDate) The date when the SSM document was created.void
setDescription
(String description) A description of the document.void
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
The name of the SSM document.void
The AWS user account of the person who 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 SSM document.void
The SHA1 hash of the document, which you can use for verification purposes.void
setStatus
(DocumentStatus status) The status of the SSM document.void
The status of the SSM document.toString()
Returns a string representation of this object; useful for testing and debugging.withCreatedDate
(Date createdDate) The date when the SSM document was created.withDescription
(String description) A description of the document.The Sha256 or Sha1 hash created by the system when the document was created.withHashType
(DocumentHashType hashType) Sha256 or Sha1.withHashType
(String hashType) Sha256 or Sha1.The name of the SSM document.The AWS user account of the person who created the document.withParameters
(DocumentParameter... parameters) A description of the parameters for a document.withParameters
(Collection<DocumentParameter> parameters) A description of the parameters for a document.withPlatformTypes
(PlatformType... platformTypes) The list of OS platforms compatible with this SSM document.withPlatformTypes
(String... platformTypes) The list of OS platforms compatible with this SSM document.withPlatformTypes
(Collection<String> platformTypes) The list of OS platforms compatible with this SSM document.The SHA1 hash of the document, which you can use for verification purposes.withStatus
(DocumentStatus status) The status of the SSM document.withStatus
(String status) The status of the SSM document.
-
Constructor Details
-
DocumentDescription
public DocumentDescription()
-
-
Method Details
-
setSha1
The SHA1 hash of the document, which you can use for verification purposes.
- Parameters:
sha1
- The SHA1 hash of the document, which you can use for verification purposes.
-
getSha1
The SHA1 hash of the document, which you can use for verification purposes.
- Returns:
- The SHA1 hash of the document, which you can use for verification purposes.
-
withSha1
The SHA1 hash of the document, which you can use for verification purposes.
- Parameters:
sha1
- The SHA1 hash of the document, which you can use for verification purposes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHash
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
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
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
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Parameters:
hashType
- Sha256 or Sha1.Sha1 hashes have been deprecated.
- See Also:
-
getHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Returns:
- Sha256 or Sha1.
Sha1 hashes have been deprecated.
- See Also:
-
withHashType
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:
-
setHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Parameters:
hashType
- Sha256 or Sha1.Sha1 hashes have been deprecated.
- See Also:
-
withHashType
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:
-
setName
The name of the SSM document.
- Parameters:
name
- The name of the SSM document.
-
getName
The name of the SSM document.
- Returns:
- The name of the SSM document.
-
withName
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.
-
setOwner
The AWS user account of the person who created the document.
- Parameters:
owner
- The AWS user account of the person who created the document.
-
getOwner
The AWS user account of the person who created the document.
- Returns:
- The AWS user account of the person who created the document.
-
withOwner
The AWS user account of the person who created the document.
- Parameters:
owner
- The AWS user account of the person who created the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreatedDate
The date when the SSM document was created.
- Parameters:
createdDate
- The date when the SSM document was created.
-
getCreatedDate
The date when the SSM document was created.
- Returns:
- The date when the SSM document was created.
-
withCreatedDate
The date when the SSM document was created.
- Parameters:
createdDate
- The date when the SSM document was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
The status of the SSM document.
- Parameters:
status
- The status of the SSM document.- See Also:
-
getStatus
The status of the SSM document.
- Returns:
- The status of the SSM document.
- See Also:
-
withStatus
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:
-
setStatus
The status of the SSM document.
- Parameters:
status
- The status of the SSM document.- See Also:
-
withStatus
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:
-
setDescription
A description of the document.
- Parameters:
description
- A description of the document.
-
getDescription
A description of the document.
- Returns:
- A description of the document.
-
withDescription
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
A description of the parameters for a document.
- Returns:
- A description of the parameters for a document.
-
setParameters
A description of the parameters for a document.
- Parameters:
parameters
- A description of the parameters for a document.
-
withParameters
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)
orwithParameters(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
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
The list of OS platforms compatible with this SSM document.
- Returns:
- The list of OS platforms compatible with this SSM document.
- See Also:
-
setPlatformTypes
The list of OS platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of OS platforms compatible with this SSM document.- See Also:
-
withPlatformTypes
The list of OS platforms compatible with this SSM document.
NOTE: This method appends the values to the existing list (if any). Use
setPlatformTypes(java.util.Collection)
orwithPlatformTypes(java.util.Collection)
if you want to override the existing values.- Parameters:
platformTypes
- The list of OS platforms compatible with this SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withPlatformTypes
The list of OS platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of OS platforms compatible with this SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withPlatformTypes
The list of OS platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of OS platforms compatible with this SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-