UpdateDocumentRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.10.35 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateDocumentRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 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()` 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()`
`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 String content()
```
    A valid JSON or YAML string.
    
    Returns:
    
    A valid JSON or YAML string.
  - hasAttachments
```
public 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 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 String name()
```
    The name of the document that you want to update.
    
    Returns:
    
    The name of the document that you want to update.
  - versionName
```
public 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 String documentVersion()
```
    (Required) The version of the document that you want to update.
    
    Returns:
    
    (Required) The version of the document that you want to update.
  - documentFormat
```
public 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 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 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 interface ToCopyableBuilder<UpdateDocumentRequest.Builder,UpdateDocumentRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - builder
```
public static UpdateDocumentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateDocumentRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateDocumentRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

content

hasAttachments

attachments

name

versionName

documentVersion

documentFormat

documentFormatAsString

targetType

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields