software.amazon.awssdk.services.workdocs.model

Class GetDocumentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workdocs.model.WorkDocsRequest

software.amazon.awssdk.services.workdocs.model.GetDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDocumentRequest.Builder,GetDocumentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authenticationToken() Amazon WorkDocs authentication token.
static GetDocumentRequest.Builder	builder()
String	documentId() The ID of the document.
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()
Boolean	includeCustomMetadata() Set this to TRUE to include custom metadata in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDocumentRequest.Builder>	serializableBuilderClass()
GetDocumentRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

authenticationToken

public String authenticationToken()

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

documentId

public String documentId()

The ID of the document.

Returns:

The ID of the document.

includeCustomMetadata

public Boolean includeCustomMetadata()

Set this to TRUE to include custom metadata in the response.

Returns:

Set this to TRUE to include custom metadata in the response.

toBuilder

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

Specified by:

toBuilder in class WorkDocsRequest

Returns:

a builder for type T

builder

public static GetDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDocumentRequest.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.