software.amazon.awssdk.services.ssm.model

Class GetDocumentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.GetDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDocumentRequest.Builder,GetDocumentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetDocumentRequest.Builder	builder()
DocumentFormat	documentFormat() Returns the document in the specified format.
String	documentFormatAsString() Returns the document in the specified format.
String	documentVersion() The document version for which you want information.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	name() The name of the Systems Manager document.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDocumentRequest.Builder>	serializableBuilderClass()
GetDocumentRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

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.

documentVersion

public String documentVersion()

The document version for which you want information.

Returns:

The document version for which you want information.

documentFormat

public DocumentFormat documentFormat()

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

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:

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

See Also:

DocumentFormat

documentFormatAsString

public String documentFormatAsString()

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

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:

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

See Also:

DocumentFormat

toBuilder

public GetDocumentRequest.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<GetDocumentRequest.Builder,GetDocumentRequest>

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static GetDocumentRequest.Builder builder()

serializableBuilderClass

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.