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("software.amazon.awssdk:codegen") public final class UpdateDocumentRequest extends SsmRequest implements ToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdateDocumentRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AttachmentsSource>
attachments()
A list of key-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 SSM 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)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAttachments()
For responses, this returns true if the service returned a value for the Attachments property.int
hashCode()
String
name()
The name of the SSM 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()
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
clone, finalize, 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()
For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
attachments
public final List<AttachmentsSource> attachments()
A list of key-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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttachments()
method.- Returns:
- A list of key-value pairs that describe attachments to a version of a document.
-
name
public final String name()
The name of the SSM document that you want to update.
- Returns:
- The name of the SSM document that you want to update.
-
displayName
public final String displayName()
The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't 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 SSM document that you want to update. This value can differ for each version of the document. If you don't 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 can't 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 can't 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.If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the
apply-only-at-cron-interval
parameter.- 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.If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the
apply-only-at-cron-interval
parameter.
-
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 returnDocumentFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentFormatAsString()
.- 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 returnDocumentFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentFormatAsString()
.- 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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static UpdateDocumentRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateDocumentRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-