DocumentDescription (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.78 API)

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 Amazon Web Services Systems Manager document (SSM 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
`String`	`approvedVersion()` The version of the document currently approved for use in the organization.
`List<AttachmentInformation>`	`attachmentsInformation()` Details about the document attachments, including names, locations, sizes, and so on.
`String`	`author()` The user in your organization who created the document.
`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.
`String`	`displayName()` The friendly name of the SSM 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachmentsInformation()` For responses, this returns true if the service returned a value for the AttachmentsInformation property.
`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.
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`boolean`	`hasPlatformTypes()` For responses, this returns true if the service returned a value for the PlatformTypes property.
`boolean`	`hasRequires()` For responses, this returns true if the service returned a value for the Requires property.
`boolean`	`hasReviewInformation()` For responses, this returns true if the service returned a value for the ReviewInformation property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`latestVersion()` The latest version of the document.
`String`	`name()` The name of the SSM document.
`String`	`owner()` The Amazon Web Services user account that created the document.
`List<DocumentParameter>`	`parameters()` A description of the parameters for a document.
`String`	`pendingReviewVersion()` The version of the document that is currently under review.
`List<PlatformType>`	`platformTypes()` The list of OS platforms compatible with this SSM document.
`List<String>`	`platformTypesAsStrings()` The list of OS platforms compatible with this SSM document.
`List<DocumentRequires>`	`requires()` A list of SSM documents required by a document.
`List<ReviewInformation>`	`reviewInformation()` Details about the review of a document.
`ReviewStatus`	`reviewStatus()` The current status of the review.
`String`	`reviewStatusAsString()` The current status of the review.
`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 SSM document.
`String`	`statusAsString()` The status of the SSM document.
`String`	`statusInformation()` A message returned by Amazon Web Services 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()`
`String`	`toString()` Returns a string representation of this object.
`String`	`versionName()` The version of the artifact associated with the document.

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

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

- Method Detail
  - sha1
```
public final 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 final 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 final 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 final 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 final String name()
```
    The name of the SSM document.
    
    Returns:
    
    The name of the SSM document.
  - displayName
```
public final String displayName()
```
    The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
    
    Returns:
    
    The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
  - versionName
```
public final String versionName()
```
    The version of the artifact associated with the document.
    
    Returns:
    
    The version of the artifact associated with the document.
  - owner
```
public final String owner()
```
    The Amazon Web Services user account that created the document.
    
    Returns:
    
    The Amazon Web Services user account that created the document.
  - createdDate
```
public final Instant createdDate()
```
    The date when the document was created.
    
    Returns:
    
    The date when the document was created.
  - status
```
public final DocumentStatus status()
```
    The status of the SSM 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 SSM document.
    
    See Also:
    
    DocumentStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the SSM 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 SSM document.
    
    See Also:
    
    DocumentStatus
  - statusInformation
```
public final String statusInformation()
```
    A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
    
    Returns:
    
    A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
  - documentVersion
```
public final String documentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - description
```
public final String description()
```
    A description of the document.
    
    Returns:
    
    A description of the document.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parameters
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.
    
    Returns:
    
    A description of the parameters for a document.
  - platformTypes
```
public final List<PlatformType> platformTypes()
```
    The list of OS platforms compatible with this SSM document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlatformTypes() method.
    
    Returns:
    
    The list of OS platforms compatible with this SSM document.
  - hasPlatformTypes
```
public final boolean hasPlatformTypes()
```
    For responses, this returns true if the service returned a value for the PlatformTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - platformTypesAsStrings
```
public final List<String> platformTypesAsStrings()
```
    The list of OS platforms compatible with this SSM document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlatformTypes() method.
    
    Returns:
    
    The list of OS platforms compatible with this SSM document.
  - documentType
```
public final 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 final 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 final String schemaVersion()
```
    The schema version.
    
    Returns:
    
    The schema version.
  - latestVersion
```
public final String latestVersion()
```
    The latest version of the document.
    
    Returns:
    
    The latest version of the document.
  - defaultVersion
```
public final String defaultVersion()
```
    The default version.
    
    Returns:
    
    The default version.
  - documentFormat
```
public final 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 final 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 final 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 Amazon Web Services resource and property types reference in the 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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags, or metadata, that have been applied to the document.
  - hasAttachmentsInformation
```
public final boolean hasAttachmentsInformation()
```
    For responses, this returns true if the service returned a value for the AttachmentsInformation property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attachmentsInformation
```
public final List<AttachmentInformation> attachmentsInformation()
```
    Details about the document attachments, including names, locations, sizes, and so on.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttachmentsInformation() method.
    
    Returns:
    
    Details about the document attachments, including names, locations, sizes, and so on.
  - hasRequires
```
public final boolean hasRequires()
```
    For responses, this returns true if the service returned a value for the Requires property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - requires
```
public final List<DocumentRequires> requires()
```
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequires() method.
    
    Returns:
    
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
  - author
```
public final String author()
```
    The user in your organization who created the document.
    
    Returns:
    
    The user in your organization who created the document.
  - hasReviewInformation
```
public final boolean hasReviewInformation()
```
    For responses, this returns true if the service returned a value for the ReviewInformation property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - reviewInformation
```
public final List<ReviewInformation> reviewInformation()
```
    Details about the review of a document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReviewInformation() method.
    
    Returns:
    
    Details about the review of a document.
  - approvedVersion
```
public final String approvedVersion()
```
    The version of the document currently approved for use in the organization.
    
    Returns:
    
    The version of the document currently approved for use in the organization.
  - pendingReviewVersion
```
public final String pendingReviewVersion()
```
    The version of the document that is currently under review.
    
    Returns:
    
    The version of the document that is currently under review.
  - reviewStatus
```
public final ReviewStatus reviewStatus()
```
    The current status of the review.
    
    If the service returns an enum value that is not available in the current SDK version, reviewStatus will return ReviewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reviewStatusAsString().
    
    Returns:
    
    The current status of the review.
    
    See Also:
    
    ReviewStatus
  - reviewStatusAsString
```
public final String reviewStatusAsString()
```
    The current status of the review.
    
    If the service returns an enum value that is not available in the current SDK version, reviewStatus will return ReviewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reviewStatusAsString().
    
    Returns:
    
    The current status of the review.
    
    See Also:
    
    ReviewStatus
  - toBuilder
```
public DocumentDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentDescription.Builder,DocumentDescription>
  - builder
```
public static DocumentDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

displayName

versionName

owner

createdDate

status

statusAsString

statusInformation

documentVersion

description

hasParameters

parameters

platformTypes

hasPlatformTypes

platformTypesAsStrings

documentType

documentTypeAsString

schemaVersion

latestVersion

defaultVersion

documentFormat

documentFormatAsString

targetType

hasTags

tags

hasAttachmentsInformation

attachmentsInformation

hasRequires

requires

author

hasReviewInformation

reviewInformation

approvedVersion

pendingReviewVersion

reviewStatus

reviewStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields