Class DocumentRequires

java.lang.Object
software.amazon.awssdk.services.ssm.model.DocumentRequires
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DocumentRequires.Builder,DocumentRequires>

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

An SSM document required by the current document.

See Also:
  • Method Details

    • name

      public final String name()

      The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

      Returns:
      The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
    • version

      public final String version()

      The document version required by the current document.

      Returns:
      The document version required by the current document.
    • requireType

      public final String requireType()

      The document type of the required SSM document.

      Returns:
      The document type of the required SSM document.
    • versionName

      public final String versionName()

      An optional field specifying 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:
      An optional field specifying 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.
    • toBuilder

      public DocumentRequires.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<DocumentRequires.Builder,DocumentRequires>
      Returns:
      a builder for type T
    • builder

      public static DocumentRequires.Builder builder()
    • serializableBuilderClass

      public static Class<? extends DocumentRequires.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.