DocumentDescription (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DocumentDescription.Builder,DocumentDescription>

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

Describes a Systems Manager document.

See Also:: Serialized Form

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
`List<AttachmentInformation>`	`attachmentsInformation()` Details about the document attachments, including names, locations, sizes, etc.
`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.
`DocumentFormat`	`documentFormat()` The document format, either JSON or YAML.
`String`	`documentFormatAsString()` The document format, either JSON or YAML.
`DocumentType`	`documentType()` The type of document.
`String`	`documentTypeAsString()` 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()` The hash type of the document.
`String`	`hashTypeAsString()` The hash type of the document.
`String`	`latestVersion()` The latest version of the document.
`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>`	`platformTypesAsStrings()` The list of OS platforms compatible with this Systems Manager document.
`String`	`schemaVersion()` The schema version.
`List<SdkField<?>>`	`sdkFields()`
`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`	`statusAsString()` The status of the Systems Manager document.
`String`	`statusInformation()` A message returned by AWS Systems Manager that explains the `Status` value.
`List<Tag>`	`tags()` The tags, or metadata, that have been applied to the document.
`String`	`targetType()` The target type which defines the kinds of resources the document can run on.
`DocumentDescription.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`versionName()` The version of the artifact associated with the document.

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()
```
    The hash type of the document. Valid values include 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 hashTypeAsString().
    
    Returns:
    
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - hashTypeAsString
```
public String hashTypeAsString()
```
    The hash type of the document. Valid values include 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 hashTypeAsString().
    
    Returns:
    
    The hash type of the document. Valid values include 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.
  - versionName
```
public String versionName()
```
    The version of the artifact associated with the document.
    
    Returns:
    
    The version of the artifact associated with the 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 statusAsString().
    
    Returns:
    
    The status of the Systems Manager document.
    
    See Also:
    
    DocumentStatus
  - statusAsString
```
public String statusAsString()
```
    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 statusAsString().
    
    Returns:
    
    The status of the Systems Manager document.
    
    See Also:
    
    DocumentStatus
  - statusInformation
```
public String statusInformation()
```
    A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
    
    Returns:
    
    A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
  - 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.
  - platformTypesAsStrings
```
public List<String> platformTypesAsStrings()
```
    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 documentTypeAsString().
    
    Returns:
    
    The type of document.
    
    See Also:
    
    DocumentType
  - documentTypeAsString
```
public String documentTypeAsString()
```
    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 documentTypeAsString().
    
    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.
  - documentFormat
```
public DocumentFormat documentFormat()
```
    The document format, either JSON or YAML.
    
    If the service returns an enum value that is not available in the current SDK version, documentFormat will return DocumentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentFormatAsString().
    
    Returns:
    
    The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - documentFormatAsString
```
public String documentFormatAsString()
```
    The document format, either JSON or YAML.
    
    If the service returns an enum value that is not available in the current SDK version, documentFormat will return DocumentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentFormatAsString().
    
    Returns:
    
    The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - targetType
```
public String targetType()
```
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
    
    Returns:
    
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
  - 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.
  - attachmentsInformation
```
public List<AttachmentInformation> attachmentsInformation()
```
    Details about the document attachments, including names, locations, sizes, etc.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Details about the document attachments, including names, locations, sizes, etc.
  - 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)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

hashTypeAsString

name

versionName

owner

createdDate

status

statusAsString

statusInformation

documentVersion

description

parameters

platformTypes

platformTypesAsStrings

documentType

documentTypeAsString

schemaVersion

latestVersion

defaultVersion

documentFormat

documentFormatAsString

targetType

tags

attachmentsInformation

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields