GetDocumentResponse (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.10.68 API)

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, etc.
`static GetDocumentResponse.Builder`	`builder()`
`String`	`content()` The contents of the Systems Manager 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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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 Systems Manager document.
`List<DocumentRequires>`	`requires()` A list of SSM documents required by a document.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDocumentResponse.Builder>`	`serializableBuilderClass()`
`DocumentStatus`	`status()` The status of the Systems Manager document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`String`	`statusAsString()` The status of the Systems Manager document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`String`	`statusInformation()` A message returned by AWS Systems Manager that explains the `Status` value.
`GetDocumentResponse.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 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - 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. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot 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 cannot be changed.
  - documentVersion
```
public String documentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - status
```
public DocumentStatus status()
```
    The status of the Systems Manager 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 Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the Systems Manager 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 Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    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."
  - content
```
public String content()
```
    The contents of the Systems Manager document.
    
    Returns:
    
    The contents of the Systems Manager document.
  - documentType
```
public 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 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 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
  - hasRequires
```
public 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 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 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 List<AttachmentContent> attachmentsContent()
```
    A description of the document attachments, including names, locations, sizes, etc.
    
    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, etc.
  - toBuilder
```
public GetDocumentResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetDocumentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDocumentResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

versionName

documentVersion

status

statusAsString

statusInformation

content

documentType

documentTypeAsString

documentFormat

documentFormatAsString

hasRequires

requires

hasAttachmentsContent

attachmentsContent

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields