@Generated(value="software.amazon.awssdk:codegen") public final class DocumentVersionInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>
Version information about the document.
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentVersionInfo.Builder |
Modifier and Type | Method and Description |
---|---|
static DocumentVersionInfo.Builder |
builder() |
Instant |
createdDate()
The date the document was created.
|
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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 Systems Manager document, such as
Creating , Active ,
Failed , and Deleting . |
String |
statusAsString()
The status of the Systems Manager document, such as
Creating , Active ,
Failed , and Deleting . |
String |
statusInformation()
A message returned by AWS Systems Manager that explains the
Status value. |
DocumentVersionInfo.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.
|
copy
public final String name()
The document name.
public final String documentVersion()
The document version.
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 cannot be changed.
public final Instant createdDate()
The date the document was created.
public final Boolean isDefaultVersion()
An identifier for the default version of the document.
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()
.
DocumentFormat
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()
.
DocumentFormat
public final DocumentStatus status()
The status of the Systems Manager 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()
.
Creating
, Active
,
Failed
, and Deleting
.DocumentStatus
public final String statusAsString()
The status of the Systems Manager 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()
.
Creating
, Active
,
Failed
, and Deleting
.DocumentStatus
public final 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."
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."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()
.
ReviewStatus
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()
.
ReviewStatus
public DocumentVersionInfo.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>
public static DocumentVersionInfo.Builder builder()
public static Class<? extends DocumentVersionInfo.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.