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
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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
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()
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 String name()

The name of the Systems Manager document.

Returns:

The name of the Systems Manager document.

owner

public String owner()

The AWS user account that created the document.

Returns:

The AWS user account that created the document.

versionName

public 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 List<PlatformType> platformTypes()

The operating system platform.

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

Returns:

The operating system platform.

platformTypesAsStrings

public List<String> platformTypesAsStrings()

The operating system platform.

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

Returns:

The operating system platform.

documentVersion

public String documentVersion()

The document version.

Returns:

The document version.

documentType

public 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 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 String schemaVersion()

The schema version.

Returns:

The schema version.

documentFormat

public 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 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 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 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 Types Reference in the AWS CloudFormation User Guide.

tags

public 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.

Returns:

The tags, or metadata, that have been applied to 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.