@Generated(value="software.amazon.awssdk:codegen") public final class UpdateDocumentRequest extends SsmRequest implements ToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateDocumentRequest.Builder |
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.
|
DocumentFormat |
documentFormat()
Specify the document format for the new document version.
|
String |
documentFormatAsString()
Specify the document format for the new document version.
|
String |
documentVersion()
(Required) The latest 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 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.
|
overrideConfiguration
copy
public final String content()
A valid JSON or YAML string.
public final boolean hasAttachments()
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.
public final String name()
The name of the document that you want to update.
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.
public final String documentVersion()
(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.
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()
.
DocumentFormat
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()
.
DocumentFormat
public final String targetType()
Specify a new target type for the document.
public UpdateDocumentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>
toBuilder
in class SsmRequest
public static UpdateDocumentRequest.Builder builder()
public static Class<? extends UpdateDocumentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.