GetDocumentResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.ssm.model.SsmResponse
    - - software.amazon.awssdk.services.ssm.model.GetDocumentResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDocumentResponse
extends SsmResponse
implements ToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetDocumentResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AttachmentContent>`	`attachmentsContent()` A description of the document attachments, including names, locations, sizes, and so on.
`static GetDocumentResponse.Builder`	`builder()`
`String`	`content()` The contents of the SSM document.
`Instant`	`createdDate()` The date the SSM document was created.
`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 document type.
`String`	`documentTypeAsString()` The document type.
`String`	`documentVersion()` The document version.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`boolean`	`hasAttachmentsContent()` Returns true if the AttachmentsContent property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRequires()` Returns true if the Requires property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`name()` The name of the SSM document.
`List<DocumentRequires>`	`requires()` A list of SSM documents required by a document.
`ReviewStatus`	`reviewStatus()` The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.
`String`	`reviewStatusAsString()` The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDocumentResponse.Builder>`	`serializableBuilderClass()`
`DocumentStatus`	`status()` The status of the SSM document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`String`	`statusAsString()` The status of the SSM document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`String`	`statusInformation()` A message returned by Amazon Web Services Systems Manager that explains the `Status` value.
`GetDocumentResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`String`	`versionName()` The version of the artifact associated with the document.

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - name
```
public final String name()
```
    The name of the SSM document.
    
    Returns:
    
    The name of the SSM document.
  - createdDate
```
public final Instant createdDate()
```
    The date the SSM document was created.
    
    Returns:
    
    The date the SSM document was created.
  - 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. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
    
    Returns:
    
    The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
  - documentVersion
```
public final String documentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - status
```
public final DocumentStatus status()
```
    The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.
    
    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, such as Creating, Active, Updating , Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.
    
    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, such as Creating, Active, Updating , Failed, and Deleting.
    
    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."
  - content
```
public final String content()
```
    The contents of the SSM document.
    
    Returns:
    
    The contents of the SSM document.
  - documentType
```
public final DocumentType documentType()
```
    The document type.
    
    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 document type.
    
    See Also:
    
    DocumentType
  - documentTypeAsString
```
public final String documentTypeAsString()
```
    The document type.
    
    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 document type.
    
    See Also:
    
    DocumentType
  - 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
  - hasRequires
```
public final boolean hasRequires()
```
    Returns true if the Requires property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasRequires() to see if a value was sent in this field.
    
    Returns:
    
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
  - hasAttachmentsContent
```
public final boolean hasAttachmentsContent()
```
    Returns true if the AttachmentsContent property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attachmentsContent
```
public final List<AttachmentContent> attachmentsContent()
```
    A description of the document attachments, including names, locations, sizes, and so on.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAttachmentsContent() to see if a value was sent in this field.
    
    Returns:
    
    A description of the document attachments, including names, locations, sizes, and so on.
  - reviewStatus
```
public final ReviewStatus reviewStatus()
```
    The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.
    
    Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.
    
    Only one version of an SSM document can be in review, or PENDING, at a time.
    
    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 review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.
    
    Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.
    
    Only one version of an SSM document can be in review, or PENDING, at a time.
    
    See Also:
    
    ReviewStatus
  - reviewStatusAsString
```
public final String reviewStatusAsString()
```
    The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.
    
    Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.
    
    Only one version of an SSM document can be in review, or PENDING, at a time.
    
    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 review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.
    
    Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.
    
    Only one version of an SSM document can be in review, or PENDING, at a time.
    
    See Also:
    
    ReviewStatus
  - toBuilder
```
public GetDocumentResponse.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<GetDocumentResponse.Builder,GetDocumentResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetDocumentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDocumentResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final 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.

AWS SDK for Java API Reference - 2.17.9

Class GetDocumentResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

name

createdDate

displayName

versionName

documentVersion

status

statusAsString

statusInformation

content

documentType

documentTypeAsString

documentFormat

documentFormatAsString

hasRequires

requires

hasAttachmentsContent

attachmentsContent

reviewStatus

reviewStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields