UpdateDocumentRequest (AWS SDK for Java

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()` The version of the document that you want to update.
`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 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()`
`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 String content()
```
    A valid JSON or YAML string.
    
    Returns:
    
    A valid JSON or YAML string.
  - 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.
    
    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()
```
    The version of the document that you want to update.
    
    Returns:
    
    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()
```
    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 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.

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

attachments

name

versionName

documentVersion

documentFormat

documentFormatAsString

targetType

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields