software.amazon.awssdk.services.ssm.model

Class UpdateDocumentRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AttachmentsSource>	attachments() A list of key and value pairs that describe attachments to a version of a document.
static UpdateDocumentRequest.Builder	builder()
String	content() A valid JSON or YAML string.
String	displayName() The friendly name of the Systems Manager document that you want to update.
DocumentFormat	documentFormat() Specify the document format for the new document version.
String	documentFormatAsString() Specify the document format for the new document version.
String	documentVersion() The version of the document that you want to update.
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) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasAttachments() Returns true if the Attachments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	name() The name of the Systems Manager document that you want to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDocumentRequest.Builder>	serializableBuilderClass()
String	targetType() Specify a new target type for the document.
UpdateDocumentRequest.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 you are updating 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

content

public final String content()

A valid JSON or YAML string.

Returns:

A valid JSON or YAML string.

hasAttachments

public final boolean hasAttachments()

Returns true if the Attachments 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.

attachments

public final List<AttachmentsSource> attachments()

A list of key and value pairs that describe attachments to a version of a document.

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

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

Returns:

A list of key and value pairs that describe attachments to a version of a document.

name

public final String name()

The name of the Systems Manager document that you want to update.

Returns:

The name of the Systems Manager document that you want to update.

displayName

public final String displayName()

The friendly name of the Systems Manager document that you want to update. This value can differ for each version of the document. If you do not specify a value for this parameter in your request, the existing value is applied to the new document version.

Returns:

The friendly name of the Systems Manager document that you want to update. This value can differ for each version of the document. If you do not specify a value for this parameter in your request, the existing value is applied to the new document version.

versionName

public final String versionName()

An optional field specifying the version of the artifact you are updating 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 you are updating 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 final String documentVersion()

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

Returns:

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

documentFormat

public final DocumentFormat documentFormat()

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. 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:

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

See Also:

DocumentFormat

documentFormatAsString

public final String documentFormatAsString()

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. 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:

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

See Also:

DocumentFormat

targetType

public final String targetType()

Specify a new target type for the document.

Returns:

Specify a new target type for the document.

toBuilder

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

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static UpdateDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateDocumentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

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