Class DocumentDescription
- java.lang.Object
-
- com.amazonaws.services.simplesystemsmanagement.model.DocumentDescription
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class DocumentDescription extends Object implements Serializable, Cloneable
Describes an SSM document.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DocumentDescription()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentDescription
clone()
boolean
equals(Object obj)
Date
getCreatedDate()
The date when the SSM document was created.String
getDescription()
A description of the document.String
getHash()
The Sha256 or Sha1 hash created by the system when the document was created.String
getHashType()
Sha256 or Sha1.String
getName()
The name of the SSM document.String
getOwner()
The AWS user account of the person who 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 SSM document.String
getSha1()
The SHA1 hash of the document, which you can use for verification purposes.String
getStatus()
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
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
setName(String name)
The name of the SSM document.void
setOwner(String owner)
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
setSha1(String sha1)
The SHA1 hash of the document, which you can use for verification purposes.void
setStatus(DocumentStatus status)
The status of the SSM document.void
setStatus(String status)
The status of the SSM document.String
toString()
Returns a string representation of this object; useful for testing and debugging.DocumentDescription
withCreatedDate(Date createdDate)
The date when the SSM document was created.DocumentDescription
withDescription(String description)
A description of the document.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
withName(String name)
The name of the SSM document.DocumentDescription
withOwner(String owner)
The AWS user account of the person who created the document.DocumentDescription
withParameters(DocumentParameter... parameters)
A description of the parameters for a document.DocumentDescription
withParameters(Collection<DocumentParameter> parameters)
A description of the parameters for a document.DocumentDescription
withPlatformTypes(PlatformType... platformTypes)
The list of OS platforms compatible with this SSM document.DocumentDescription
withPlatformTypes(String... platformTypes)
The list of OS platforms compatible with this SSM document.DocumentDescription
withPlatformTypes(Collection<String> platformTypes)
The list of OS platforms compatible with this SSM document.DocumentDescription
withSha1(String sha1)
The SHA1 hash of the document, which you can use for verification purposes.DocumentDescription
withStatus(DocumentStatus status)
The status of the SSM document.DocumentDescription
withStatus(String status)
The status of the SSM document.
-
-
-
Method Detail
-
setSha1
public void setSha1(String sha1)
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
public String 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
public DocumentDescription withSha1(String sha1)
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
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 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.
-
setOwner
public void setOwner(String owner)
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
public String 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
public DocumentDescription withOwner(String owner)
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
public void setCreatedDate(Date createdDate)
The date when the SSM document was created.
- Parameters:
createdDate
- The date when the SSM document was created.
-
getCreatedDate
public Date getCreatedDate()
The date when the SSM document was created.
- Returns:
- The date when the SSM document was created.
-
withCreatedDate
public DocumentDescription withCreatedDate(Date createdDate)
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
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
-
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)
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
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 SSM document.
- Returns:
- The list of OS platforms compatible with this SSM document.
- See Also:
PlatformType
-
setPlatformTypes
public void setPlatformTypes(Collection<String> platformTypes)
The list of OS platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of OS platforms compatible with this SSM document.- See Also:
PlatformType
-
withPlatformTypes
public DocumentDescription withPlatformTypes(String... platformTypes)
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:
PlatformType
-
withPlatformTypes
public DocumentDescription withPlatformTypes(Collection<String> platformTypes)
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:
PlatformType
-
withPlatformTypes
public DocumentDescription withPlatformTypes(PlatformType... platformTypes)
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:
PlatformType
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DocumentDescription clone()
-
-