Package software.amazon.awssdk.services.workdocs.model

Class GetDocumentPathRequest

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.GetDocumentPathRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDocumentPathRequest.Builder,GetDocumentPathRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDocumentPathRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	authenticationToken()	Amazon WorkDocs authentication token.
static GetDocumentPathRequest.Builder	builder()
String	documentId()	The ID of the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fields()	A comma-separated list of values.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of levels in the hierarchy to return.
String	marker()	This value is not supported.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetDocumentPathRequest.Builder>	serializableBuilderClass()
GetDocumentPathRequest.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.

limit

public final Integer limit()

The maximum number of levels in the hierarchy to return.

Returns:

The maximum number of levels in the hierarchy to return.

fields

public final String fields()

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Returns:

A comma-separated list of values. Specify NAME to include the names of the parent folders.

marker

public final String marker()

This value is not supported.

Returns:

This value is not supported.

toBuilder

public GetDocumentPathRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDocumentPathRequest.Builder,GetDocumentPathRequest>

Specified by:

toBuilder in class WorkDocsRequest

builder

public static GetDocumentPathRequest.Builder builder()

serializableBuilderClass

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