DocumentDescription (AWS SDK for Java

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

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

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

Describes a Systems Manager document.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DocumentDescription.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentDescription.Builder`	`builder()`
`Instant`	`createdDate()` The date when the document was created.
`String`	`defaultVersion()` The default version.
`String`	`description()` A description of the document.
`DocumentType`	`documentType()` The type of document.
`String`	`documentTypeString()` The type of document.
`String`	`documentVersion()` The document version.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`hash()` The Sha256 or Sha1 hash created by the system when the document was created.
`int`	`hashCode()`
`DocumentHashType`	`hashType()` Sha256 or Sha1.
`String`	`hashTypeString()` 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 Systems Manager document.
`String`	`owner()` The AWS user account that created the document.
`List<DocumentParameter>`	`parameters()` A description of the parameters for a document.
`List<PlatformType>`	`platformTypes()` The list of OS platforms compatible with this Systems Manager document.
`List<String>`	`platformTypesStrings()` The list of OS platforms compatible with this Systems Manager 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.
`DocumentStatus`	`status()` The status of the Systems Manager document.
`String`	`statusString()` The status of the Systems Manager document.
`List<Tag>`	`tags()` The tags, or metadata, that have been applied to the 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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - sha1
```
public String sha1()
```
    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.
  - 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 DocumentHashType hashType()
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    If the service returns an enum value that is not available in the current SDK version, hashType will return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hashTypeString().
    
    Returns:
    
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - hashTypeString
```
public String hashTypeString()
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    If the service returns an enum value that is not available in the current SDK version, hashType will return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hashTypeString().
    
    Returns:
    
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - name
```
public String name()
```
    The name of the Systems Manager document.
    
    Returns:
    
    The name of the Systems Manager document.
  - owner
```
public String owner()
```
    The AWS user account that created the document.
    
    Returns:
    
    The AWS user account that created the document.
  - createdDate
```
public Instant createdDate()
```
    The date when the document was created.
    
    Returns:
    
    The date when the document was created.
  - status
```
public DocumentStatus status()
```
    The status of the Systems Manager document.
    
    If the service returns an enum value that is not available in the current SDK version, status will return DocumentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusString().
    
    Returns:
    
    The status of the Systems Manager document.
    
    See Also:
    
    DocumentStatus
  - statusString
```
public String statusString()
```
    The status of the Systems Manager document.
    
    If the service returns an enum value that is not available in the current SDK version, status will return DocumentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusString().
    
    Returns:
    
    The status of the Systems Manager 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A description of the parameters for a document.
  - platformTypes
```
public List<PlatformType> platformTypes()
```
    The list of OS platforms compatible with this Systems Manager document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of OS platforms compatible with this Systems Manager document.
  - platformTypesStrings
```
public List<String> platformTypesStrings()
```
    The list of OS platforms compatible with this Systems Manager document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of OS platforms compatible with this Systems Manager document.
  - documentType
```
public DocumentType documentType()
```
    The type of document.
    
    If the service returns an enum value that is not available in the current SDK version, documentType will return DocumentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentTypeString().
    
    Returns:
    
    The type of document.
    
    See Also:
    
    DocumentType
  - documentTypeString
```
public String documentTypeString()
```
    The type of document.
    
    If the service returns an enum value that is not available in the current SDK version, documentType will return DocumentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentTypeString().
    
    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.
  - tags
```
public List<Tag> tags()
```
    The tags, or metadata, that have been applied to the document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The tags, or metadata, that have been applied to the document.
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - 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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

sha1

hash

hashType

hashTypeString

name

owner

createdDate

status

statusString

documentVersion

description

parameters

platformTypes

platformTypesStrings

documentType

documentTypeString

schemaVersion

latestVersion

defaultVersion

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall