Class DocumentIdentifier

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

Describes the name of a SSM document.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the SSM document.

      Returns:
      The name of the SSM document.

    • createdDate

      public final Instant createdDate()

      The date the SSM document was created.

      Returns:
      The date the SSM document was created.

    • displayName

      public final String displayName()

      An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

      Returns:
      An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

    • owner

      public final String owner()

      The Amazon Web Services user that created the document.

      Returns:
      The Amazon Web Services user that created the document.

    • versionName

      public final String versionName()

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

    • platformTypes

      public final List<PlatformType> platformTypes()

      The operating system platform.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlatformTypes() method.

      Returns:
      The operating system platform.

    • hasPlatformTypes

      public final boolean hasPlatformTypes()
      For responses, this returns true if the service returned a value for the PlatformTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • platformTypesAsStrings

      public final List<String> platformTypesAsStrings()

      The operating system platform.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlatformTypes() method.

      Returns:
      The operating system platform.

    • documentVersion

      public final String documentVersion()

      The document version.

      Returns:
      The document version.

    • documentType

      public final DocumentType documentType()

      The document type.

      If the service returns an enum value that is not available in the current SDK version, documentType will return DocumentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentTypeAsString().

      Returns:
      The document type.
      See Also:

    • documentTypeAsString

      public final String documentTypeAsString()

      The document type.

      If the service returns an enum value that is not available in the current SDK version, documentType will return DocumentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentTypeAsString().

      Returns:
      The document type.
      See Also:

    • schemaVersion

      public final String schemaVersion()

      The schema version.

      Returns:
      The schema version.

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

    • targetType

      public final String targetType()

      The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

      Returns:
      The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags, or metadata, that have been applied to the document.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags, or metadata, that have been applied to the document.

    • hasRequires

      public final boolean hasRequires()
      For responses, this returns true if the service returned a value for the Requires property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • requires

      public final List<DocumentRequires> requires()

      A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequires() method.

      Returns:
      A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

    • reviewStatus

      public final ReviewStatus reviewStatus()

      The current status of a document review.

      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 a document review.
      See Also:

    • reviewStatusAsString

      public final String reviewStatusAsString()

      The current status of a document review.

      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 a document review.
      See Also:

    • author

      public final String author()

      The user in your organization who created the document.

      Returns:
      The user in your organization who created the document.

    • toBuilder

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

    • builder

      public static DocumentIdentifier.Builder builder()

    • serializableBuilderClass

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