DocumentDescription (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.ssm.model.DocumentDescription

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<DocumentDescription.Builder,DocumentDescription>

@Generated("software.amazon.awssdk:codegen")
public class DocumentDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<DocumentDescription.Builder,DocumentDescription>

Describes an SSM document.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DocumentDescription.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`DocumentDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentDescription.Builder`	`builder()`
`Date`	`createdDate()`	The date when the document was created.
`String`	`defaultVersion()`	The default version.
`String`	`description()`	A description of the document.
`String`	`documentType()`	The type of document.
`String`	`documentVersion()`	The document version.
`boolean`	`equals(Object obj)`
`String`	`hash()`	The Sha256 or Sha1 hash created by the system when the document was created.
`int`	`hashCode()`
`String`	`hashType()`	Sha256 or Sha1.
`String`	`latestVersion()`	The latest version of the document.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`name()`	The name of the SSM document.
`String`	`owner()`	The AWS user account of the person who created the document.
`List<DocumentParameter>`	`parameters()`	A description of the parameters for a document.
`List<String>`	`platformTypes()`	The list of OS platforms compatible with this SSM document.
`String`	`schemaVersion()`	The schema version.
`static Class<? extends DocumentDescription.Builder>`	`serializableBuilderClass()`
`String`	`sha1()`	The SHA1 hash of the document, which you can use for verification purposes.
`String`	`status()`	The status of the SSM document.
`DocumentDescription.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

- Method Detail
  - sha1
```
public String sha1()
```
    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.
  - hash
```
public String hash()
```
    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.
  - hashType
```
public String hashType()
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - name
```
public String name()
```
    The name of the SSM document.
    
    Returns:
    
    The name of the SSM document.
  - owner
```
public String owner()
```
    The AWS user account of the person who created the document.
    
    Returns:
    
    The AWS user account of the person who created the document.
  - createdDate
```
public Date createdDate()
```
    The date when the document was created.
    
    Returns:
    
    The date when the document was created.
  - status
```
public String status()
```
    The status of the SSM document.
    
    Returns:
    
    The status of the SSM document.
    
    See Also:
    
    DocumentStatus
  - documentVersion
```
public String documentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - description
```
public String description()
```
    A description of the document.
    
    Returns:
    
    A description of the document.
  - parameters
```
public List<DocumentParameter> parameters()
```
    A description of the parameters for a document.
    
    Returns:
    
    A description of the parameters for a document.
  - platformTypes
```
public List<String> platformTypes()
```
    The list of OS platforms compatible with this SSM document.
    
    Returns:
    
    The list of OS platforms compatible with this SSM document.
    
    See Also:
    
    PlatformType
  - documentType
```
public String documentType()
```
    The type of document.
    
    Returns:
    
    The type of document.
    
    See Also:
    
    DocumentType
  - schemaVersion
```
public String schemaVersion()
```
    The schema version.
    
    Returns:
    
    The schema version.
  - latestVersion
```
public String latestVersion()
```
    The latest version of the document.
    
    Returns:
    
    The latest version of the document.
  - defaultVersion
```
public String defaultVersion()
```
    The default version.
    
    Returns:
    
    The default version.
  - toBuilder
```
public DocumentDescription.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentDescription.Builder,DocumentDescription>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DocumentDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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.

Class DocumentDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

sha1

hash

hashType

name

owner

createdDate

status

documentVersion

description

parameters

platformTypes

documentType

schemaVersion

latestVersion

defaultVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall