DocumentVersionInfo (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.261 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.DocumentVersionInfo

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class DocumentVersionInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>

Version information about the document.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DocumentVersionInfo.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentVersionInfo.Builder`	`builder()`
`Instant`	`createdDate()` The date the 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.
`String`	`documentVersion()` The document version.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`isDefaultVersion()` An identifier for the default version of the document.
`String`	`name()` The document name.
`ReviewStatus`	`reviewStatus()` The current status of the approval review for the latest version of the document.
`String`	`reviewStatusAsString()` The current status of the approval review for the latest version of the document.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentVersionInfo.Builder>`	`serializableBuilderClass()`
`DocumentStatus`	`status()` The status of the SSM document, such as `Creating`, `Active`, `Failed`, and `Deleting`.
`String`	`statusAsString()` The status of the SSM document, such as `Creating`, `Active`, `Failed`, and `Deleting`.
`String`	`statusInformation()` A message returned by Amazon Web Services Systems Manager that explains the `Status` value.
`DocumentVersionInfo.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
  - name
```
public final String name()
```
    The document name.
    
    Returns:
    
    The document name.
  - 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.
  - documentVersion
```
public final String documentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - 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.
  - createdDate
```
public final Instant createdDate()
```
    The date the document was created.
    
    Returns:
    
    The date the document was created.
  - isDefaultVersion
```
public final Boolean isDefaultVersion()
```
    An identifier for the default version of the document.
    
    Returns:
    
    An identifier for the default version of the document.
  - 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
  - status
```
public final DocumentStatus status()
```
    The status of the SSM document, such as Creating, Active, 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, Failed, and Deleting.
    
    See Also:
    
    DocumentStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the SSM document, such as Creating, Active, 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, 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."
  - reviewStatus
```
public final ReviewStatus reviewStatus()
```
    The current status of the approval review for the latest version of the document.
    
    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 approval review for the latest version of the document.
    
    See Also:
    
    ReviewStatus
  - reviewStatusAsString
```
public final String reviewStatusAsString()
```
    The current status of the approval review for the latest version of the document.
    
    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 approval review for the latest version of the document.
    
    See Also:
    
    ReviewStatus
  - toBuilder
```
public DocumentVersionInfo.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>
  - builder
```
public static DocumentVersionInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentVersionInfo.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 DocumentVersionInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

displayName

documentVersion

versionName

createdDate

isDefaultVersion

documentFormat

documentFormatAsString

status

statusAsString

statusInformation

reviewStatus

reviewStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields