Package 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("software.amazon.awssdk:codegen")
public final class GetDocumentRequest
extends WorkDocsRequest
implements ToCopyableBuilder<GetDocumentRequest.Builder,GetDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	authenticationToken()	Amazon WorkDocs authentication token.
static GetDocumentRequest.Builder	builder()
String	documentId()	The ID of the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeCustomMetadata()	Set this to TRUE to include custom metadata in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetDocumentRequest.Builder>	serializableBuilderClass()
GetDocumentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

authenticationToken

public final String authenticationToken()

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

documentId

public final String documentId()

The ID of the document.

Returns:

The ID of the document.

includeCustomMetadata

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDocumentRequest.Builder,GetDocumentRequest>

Specified by:

toBuilder in class WorkDocsRequest

builder

public static GetDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDocumentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo