software.amazon.awssdk.services.workdocs.model

Class DescribeFolderContentsRequest

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

All Implemented Interfaces:

ToCopyableBuilder<DescribeFolderContentsRequest.Builder,DescribeFolderContentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeFolderContentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authenticationToken() Amazon WorkDocs authentication token.
static DescribeFolderContentsRequest.Builder	builder()
boolean	equals(Object obj)
String	folderId() The ID of the folder.
<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	include() The contents to include.
Integer	limit() The maximum number of items to return with this call.
String	marker() The marker for the next set of results.
OrderType	order() The order for the contents of the folder.
String	orderAsString() The order for the contents of the folder.
static Class<? extends DescribeFolderContentsRequest.Builder>	serializableBuilderClass()
ResourceSortType	sort() The sorting criteria.
String	sortAsString() The sorting criteria.
DescribeFolderContentsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
FolderContentType	type() The type of items.
String	typeAsString() The type of items.

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

requestOverrideConfig

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.

folderId

public String folderId()

The ID of the folder.

Returns:

The ID of the folder.

sort

public ResourceSortType sort()

The sorting criteria.

If the service returns an enum value that is not available in the current SDK version, sort will return ResourceSortType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

Returns:

The sorting criteria.

See Also:

ResourceSortType

sortAsString

public String sortAsString()

The sorting criteria.

If the service returns an enum value that is not available in the current SDK version, sort will return ResourceSortType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

Returns:

The sorting criteria.

See Also:

ResourceSortType

order

public OrderType order()

The order for the contents of the folder.

If the service returns an enum value that is not available in the current SDK version, order will return OrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

The order for the contents of the folder.

See Also:

OrderType

orderAsString

public String orderAsString()

The order for the contents of the folder.

If the service returns an enum value that is not available in the current SDK version, order will return OrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

The order for the contents of the folder.

See Also:

OrderType

limit

public Integer limit()

The maximum number of items to return with this call.

Returns:

The maximum number of items to return with this call.

marker

public String marker()

The marker for the next set of results. This marker was received from a previous call.

Returns:

The marker for the next set of results. This marker was received from a previous call.

type

public FolderContentType type()

The type of items.

If the service returns an enum value that is not available in the current SDK version, type will return FolderContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of items.

See Also:

FolderContentType

typeAsString

public String typeAsString()

The type of items.

If the service returns an enum value that is not available in the current SDK version, type will return FolderContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of items.

See Also:

FolderContentType

include

public String include()

The contents to include. Specify "INITIALIZED" to include initialized documents.

Returns:

The contents to include. Specify "INITIALIZED" to include initialized documents.

toBuilder

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

Specified by:

toBuilder in class WorkDocsRequest

Returns:

a builder for type T

builder

public static DescribeFolderContentsRequest.Builder builder()

serializableBuilderClass

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