software.amazon.awssdk.services.ssm.model

Class DocumentIdentifier

java.lang.Object

software.amazon.awssdk.services.ssm.model.DocumentIdentifier

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentIdentifier.Builder,DocumentIdentifier>

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

Describes the name of a Systems Manager document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentIdentifier.Builder

Method Summary

Modifier and Type	Method and Description
String	author() The user in your organization who created the document.
static DocumentIdentifier.Builder	builder()
DocumentFormat	documentFormat() The document format, either JSON or YAML.
String	documentFormatAsString() The document format, either JSON or YAML.
DocumentType	documentType() The document type.
String	documentTypeAsString() The document type.
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	hasPlatformTypes() Returns true if the PlatformTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasRequires() Returns true if the Requires property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() The name of the Systems Manager document.
String	owner() The AWS user account that created the document.
List<PlatformType>	platformTypes() The operating system platform.
List<String>	platformTypesAsStrings() The operating system platform.
List<DocumentRequires>	requires() A list of SSM documents required by a document.
ReviewStatus	reviewStatus() The current status of a document review.
String	reviewStatusAsString() The current status of a document review.
String	schemaVersion() The schema version.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentIdentifier.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags, or metadata, that have been applied to the document.
String	targetType() The target type which defines the kinds of resources the document can run on.
DocumentIdentifier.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() An optional field specifying the version of the artifact associated with the document.

Methods inherited from class java.lang.Object

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 name of the Systems Manager document.

Returns:

The name of the Systems Manager document.

owner

public final String owner()

The AWS user account that created the document.

Returns:

The AWS user account that created the 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 cannot 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 cannot 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.

You can use hasPlatformTypes() to see if a value was sent in this field.

Returns:

The operating system platform.

hasPlatformTypes

public final boolean hasPlatformTypes()

Returns true if the PlatformTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

platformTypesAsStrings

public final List<String> platformTypesAsStrings()

The operating system platform.

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

You can use hasPlatformTypes() to see if a value was sent in this field.

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:

DocumentType

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:

DocumentType

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:

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

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 AWS resource and property types reference in the AWS 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 AWS resource and property types reference in the AWS CloudFormation User Guide.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

Returns:

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

hasRequires

public final boolean hasRequires()

Returns true if the Requires property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasRequires() to see if a value was sent in this field.

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:

ReviewStatus

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:

ReviewStatus

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.