DocumentVersionInfo (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.DocumentVersionInfo

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentVersionInfo
extends Object
implements Serializable, Cloneable, StructuredPojo

Version information about the document.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentVersionInfo()

Constructors
Constructor and Description
`DocumentVersionInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentVersionInfo`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedDate()` The date the document was created.
`String`	`getDocumentFormat()` The document format, either JSON or YAML.
`String`	`getDocumentVersion()` The document version.
`Boolean`	`getIsDefaultVersion()` An identifier for the default version of the document.
`String`	`getName()` The document name.
`String`	`getReviewStatus()` The current status of the approval review for the latest version of the document.
`String`	`getStatus()` The status of the Systems Manager document, such as `Creating`, `Active`, `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()`
`Boolean`	`isDefaultVersion()` An identifier for the default version of the document.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreatedDate(Date createdDate)` The date the document was created.
`void`	`setDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`void`	`setDocumentVersion(String documentVersion)` The document version.
`void`	`setIsDefaultVersion(Boolean isDefaultVersion)` An identifier for the default version of the document.
`void`	`setName(String name)` The document name.
`void`	`setReviewStatus(String reviewStatus)` The current status of the approval review for the latest version of the document.
`void`	`setStatus(String status)` The status of the Systems Manager document, such as `Creating`, `Active`, `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.
`DocumentVersionInfo`	`withCreatedDate(Date createdDate)` The date the document was created.
`DocumentVersionInfo`	`withDocumentFormat(DocumentFormat documentFormat)` The document format, either JSON or YAML.
`DocumentVersionInfo`	`withDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`DocumentVersionInfo`	`withDocumentVersion(String documentVersion)` The document version.
`DocumentVersionInfo`	`withIsDefaultVersion(Boolean isDefaultVersion)` An identifier for the default version of the document.
`DocumentVersionInfo`	`withName(String name)` The document name.
`DocumentVersionInfo`	`withReviewStatus(ReviewStatus reviewStatus)` The current status of the approval review for the latest version of the document.
`DocumentVersionInfo`	`withReviewStatus(String reviewStatus)` The current status of the approval review for the latest version of the document.
`DocumentVersionInfo`	`withStatus(DocumentStatus status)` The status of the Systems Manager document, such as `Creating`, `Active`, `Failed`, and `Deleting`.
`DocumentVersionInfo`	`withStatus(String status)` The status of the Systems Manager document, such as `Creating`, `Active`, `Failed`, and `Deleting`.
`DocumentVersionInfo`	`withStatusInformation(String statusInformation)` A message returned by AWS Systems Manager that explains the `Status` value.
`DocumentVersionInfo`	`withVersionName(String versionName)` The version of the artifact associated with the document.

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

- Constructor Detail
  - DocumentVersionInfo
```
public DocumentVersionInfo()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The document name.
    
    Parameters:
    
    name - The document name.
  - getName
```
public String getName()
```
    The document name.
    
    Returns:
    
    The document name.
  - withName
```
public DocumentVersionInfo withName(String name)
```
    The document name.
    
    Parameters:
    
    name - The document name.
    
    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 DocumentVersionInfo 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.
  - 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 DocumentVersionInfo 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.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date the document was created.
    
    Parameters:
    
    createdDate - The date the document was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date the document was created.
    
    Returns:
    
    The date the document was created.
  - withCreatedDate
```
public DocumentVersionInfo withCreatedDate(Date createdDate)
```
    The date the document was created.
    
    Parameters:
    
    createdDate - The date the document was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsDefaultVersion
```
public void setIsDefaultVersion(Boolean isDefaultVersion)
```
    An identifier for the default version of the document.
    
    Parameters:
    
    isDefaultVersion - An identifier for the default version of the document.
  - getIsDefaultVersion
```
public Boolean getIsDefaultVersion()
```
    An identifier for the default version of the document.
    
    Returns:
    
    An identifier for the default version of the document.
  - withIsDefaultVersion
```
public DocumentVersionInfo withIsDefaultVersion(Boolean isDefaultVersion)
```
    An identifier for the default version of the document.
    
    Parameters:
    
    isDefaultVersion - An identifier for the default version of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefaultVersion
```
public Boolean isDefaultVersion()
```
    An identifier for the default version of the document.
    
    Returns:
    
    An identifier for the default version of the document.
  - 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 DocumentVersionInfo 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
  - withDocumentFormat
```
public DocumentVersionInfo 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
  - setStatus
```
public void setStatus(String status)
```
    The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
    
    Parameters:
    
    status - The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - getStatus
```
public String getStatus()
```
    The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
    
    Returns:
    
    The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public DocumentVersionInfo withStatus(String status)
```
    The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
    
    Parameters:
    
    status - The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - withStatus
```
public DocumentVersionInfo withStatus(DocumentStatus status)
```
    The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
    
    Parameters:
    
    status - The status of the Systems Manager document, such as Creating, Active, 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 DocumentVersionInfo 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.
  - setReviewStatus
```
public void setReviewStatus(String reviewStatus)
```
    The current status of the approval review for the latest version of the document.
    
    Parameters:
    
    reviewStatus - The current status of the approval review for the latest version of the document.
    
    See Also:
    
    ReviewStatus
  - getReviewStatus
```
public String getReviewStatus()
```
    The current status of the approval review for the latest version of the document.
    
    Returns:
    
    The current status of the approval review for the latest version of the document.
    
    See Also:
    
    ReviewStatus
  - withReviewStatus
```
public DocumentVersionInfo withReviewStatus(String reviewStatus)
```
    The current status of the approval review for the latest version of the document.
    
    Parameters:
    
    reviewStatus - The current status of the approval review for the latest version of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReviewStatus
  - withReviewStatus
```
public DocumentVersionInfo withReviewStatus(ReviewStatus reviewStatus)
```
    The current status of the approval review for the latest version of the document.
    
    Parameters:
    
    reviewStatus - The current status of the approval review for the latest version of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReviewStatus
  - 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 DocumentVersionInfo clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DocumentVersionInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentVersionInfo

Method Detail

setName

getName

withName

setDocumentVersion

getDocumentVersion

withDocumentVersion

setVersionName

getVersionName

withVersionName

setCreatedDate

getCreatedDate

withCreatedDate

setIsDefaultVersion

getIsDefaultVersion

withIsDefaultVersion

isDefaultVersion

setDocumentFormat

getDocumentFormat

withDocumentFormat

withDocumentFormat

setStatus

getStatus

withStatus

withStatus

setStatusInformation

getStatusInformation

withStatusInformation

setReviewStatus

getReviewStatus

withReviewStatus

withReviewStatus

toString

equals

hashCode

clone

marshall