Class DocumentVersionInfo

java.lang.Object
software.amazon.awssdk.services.ssm.model.DocumentVersionInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>
@Generated("software.amazon.awssdk:codegen") public final class DocumentVersionInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>

Version information about the document.

See Also:

  • Method Details

    • 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, 12.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, 12.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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public DocumentVersionInfo.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.