software.amazon.awssdk.services.ssm.model

Class DocumentIdentifier

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<DocumentIdentifier.Builder,DocumentIdentifier>

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

Describes the name of a Systems Manager document.

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()
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()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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.
static Class<? extends DocumentIdentifier.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags, or metadata, that have been applied to the document.
DocumentIdentifier.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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.

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.

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)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.