GetDocumentResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.simplesystemsmanagement.model.GetDocumentResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetDocumentResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetDocumentResult()

Constructors
Constructor and Description
`GetDocumentResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetDocumentResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<AttachmentContent>`	`getAttachmentsContent()` A description of the document attachments, including names, locations, sizes, etc.
`String`	`getContent()` The contents of the Systems Manager document.
`String`	`getDocumentFormat()` The document format, either JSON or YAML.
`String`	`getDocumentType()` The document type.
`String`	`getDocumentVersion()` The document version.
`String`	`getName()` The name of the Systems Manager document.
`String`	`getStatus()` The status of the Systems Manager document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`String`	`getStatusInformation()` A message returned by AWS Systems Manager that explains the `Status` value.
`String`	`getVersionName()` The version of the artifact associated with the document.
`int`	`hashCode()`
`void`	`setAttachmentsContent(Collection<AttachmentContent> attachmentsContent)` A description of the document attachments, including names, locations, sizes, etc.
`void`	`setContent(String content)` The contents of the Systems Manager document.
`void`	`setDocumentFormat(DocumentFormat documentFormat)` The document format, either JSON or YAML.
`void`	`setDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`void`	`setDocumentType(DocumentType documentType)` The document type.
`void`	`setDocumentType(String documentType)` The document type.
`void`	`setDocumentVersion(String documentVersion)` The document version.
`void`	`setName(String name)` The name of the Systems Manager document.
`void`	`setStatus(DocumentStatus status)` The status of the Systems Manager document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`void`	`setStatus(String status)` The status of the Systems Manager document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`void`	`setStatusInformation(String statusInformation)` A message returned by AWS Systems Manager that explains the `Status` value.
`void`	`setVersionName(String versionName)` The version of the artifact associated with the document.
`String`	`toString()` Returns a string representation of this object.
`GetDocumentResult`	`withAttachmentsContent(AttachmentContent... attachmentsContent)` A description of the document attachments, including names, locations, sizes, etc.
`GetDocumentResult`	`withAttachmentsContent(Collection<AttachmentContent> attachmentsContent)` A description of the document attachments, including names, locations, sizes, etc.
`GetDocumentResult`	`withContent(String content)` The contents of the Systems Manager document.
`GetDocumentResult`	`withDocumentFormat(DocumentFormat documentFormat)` The document format, either JSON or YAML.
`GetDocumentResult`	`withDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`GetDocumentResult`	`withDocumentType(DocumentType documentType)` The document type.
`GetDocumentResult`	`withDocumentType(String documentType)` The document type.
`GetDocumentResult`	`withDocumentVersion(String documentVersion)` The document version.
`GetDocumentResult`	`withName(String name)` The name of the Systems Manager document.
`GetDocumentResult`	`withStatus(DocumentStatus status)` The status of the Systems Manager document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`GetDocumentResult`	`withStatus(String status)` The status of the Systems Manager document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
`GetDocumentResult`	`withStatusInformation(String statusInformation)` A message returned by AWS Systems Manager that explains the `Status` value.
`GetDocumentResult`	`withVersionName(String versionName)` The version of the artifact associated with the document.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetDocumentResult
```
public GetDocumentResult()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the Systems Manager document.
    
    Parameters:
    
    name - The name of the Systems Manager document.
  - getName
```
public String getName()
```
    The name of the Systems Manager document.
    
    Returns:
    
    The name of the Systems Manager document.
  - withName
```
public GetDocumentResult withName(String name)
```
    The name of the Systems Manager document.
    
    Parameters:
    
    name - The name of the Systems Manager document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionName
```
public void setVersionName(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.
    
    Parameters:
    
    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.
  - getVersionName
```
public String getVersionName()
```
    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.
  - withVersionName
```
public GetDocumentResult withVersionName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The document version.
    
    Parameters:
    
    documentVersion - The document version.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - withDocumentVersion
```
public GetDocumentResult withDocumentVersion(String documentVersion)
```
    The document version.
    
    Parameters:
    
    documentVersion - The document version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    Parameters:
    
    status - The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - getStatus
```
public String getStatus()
```
    The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    Returns:
    
    The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public GetDocumentResult withStatus(String status)
```
    The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    Parameters:
    
    status - The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - setStatus
```
public void setStatus(DocumentStatus status)
```
    The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    Parameters:
    
    status - The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public GetDocumentResult withStatus(DocumentStatus status)
```
    The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    Parameters:
    
    status - The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - setStatusInformation
```
public void setStatusInformation(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."
    
    Parameters:
    
    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."
  - getStatusInformation
```
public String getStatusInformation()
```
    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."
  - withStatusInformation
```
public GetDocumentResult withStatusInformation(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."
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContent
```
public void setContent(String content)
```
    The contents of the Systems Manager document.
    
    Parameters:
    
    content - The contents of the Systems Manager document.
  - getContent
```
public String getContent()
```
    The contents of the Systems Manager document.
    
    Returns:
    
    The contents of the Systems Manager document.
  - withContent
```
public GetDocumentResult withContent(String content)
```
    The contents of the Systems Manager document.
    
    Parameters:
    
    content - The contents of the Systems Manager document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentType
```
public void setDocumentType(String documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    See Also:
    
    DocumentType
  - getDocumentType
```
public String getDocumentType()
```
    The document type.
    
    Returns:
    
    The document type.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public GetDocumentResult withDocumentType(String documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setDocumentType
```
public void setDocumentType(DocumentType documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public GetDocumentResult withDocumentType(DocumentType documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setDocumentFormat
```
public void setDocumentFormat(String documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - getDocumentFormat
```
public String getDocumentFormat()
```
    The document format, either JSON or YAML.
    
    Returns:
    
    The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - withDocumentFormat
```
public GetDocumentResult withDocumentFormat(String documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - setDocumentFormat
```
public void setDocumentFormat(DocumentFormat documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - withDocumentFormat
```
public GetDocumentResult withDocumentFormat(DocumentFormat documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - getAttachmentsContent
```
public List<AttachmentContent> getAttachmentsContent()
```
    A description of the document attachments, including names, locations, sizes, etc.
    
    Returns:
    
    A description of the document attachments, including names, locations, sizes, etc.
  - setAttachmentsContent
```
public void setAttachmentsContent(Collection<AttachmentContent> attachmentsContent)
```
    A description of the document attachments, including names, locations, sizes, etc.
    
    Parameters:
    
    attachmentsContent - A description of the document attachments, including names, locations, sizes, etc.
  - withAttachmentsContent
```
public GetDocumentResult withAttachmentsContent(AttachmentContent... attachmentsContent)
```
    A description of the document attachments, including names, locations, sizes, etc.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachmentsContent(java.util.Collection) or withAttachmentsContent(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attachmentsContent - A description of the document attachments, including names, locations, sizes, etc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttachmentsContent
```
public GetDocumentResult withAttachmentsContent(Collection<AttachmentContent> attachmentsContent)
```
    A description of the document attachments, including names, locations, sizes, etc.
    
    Parameters:
    
    attachmentsContent - A description of the document attachments, including names, locations, sizes, etc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetDocumentResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetDocumentResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetDocumentResult

Method Detail

setName

getName

withName

setVersionName

getVersionName

withVersionName

setDocumentVersion

getDocumentVersion

withDocumentVersion

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusInformation

getStatusInformation

withStatusInformation

setContent

getContent

withContent

setDocumentType

getDocumentType

withDocumentType

setDocumentType

withDocumentType

setDocumentFormat

getDocumentFormat

withDocumentFormat

setDocumentFormat

withDocumentFormat

getAttachmentsContent

setAttachmentsContent

withAttachmentsContent

withAttachmentsContent

toString

equals

hashCode

clone