Package 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:

SdkPojo, ToCopyableBuilder<DescribeFolderContentsRequest.Builder,DescribeFolderContentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeFolderContentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	authenticationToken()	Amazon WorkDocs authentication token.
static DescribeFolderContentsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	folderId()	The ID of the folder.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFolderContentsRequest.Builder>	serializableBuilderClass()
ResourceSortType	sort()	The sorting criteria.
String	sortAsString()	The sorting criteria.
DescribeFolderContentsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
FolderContentType	type()	The type of items.
String	typeAsString()	The type of items.

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.

folderId

public final String folderId()

The ID of the folder.

Returns:

The ID of the folder.

sort

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFolderContentsRequest.Builder,DescribeFolderContentsRequest>

Specified by:

toBuilder in class WorkDocsRequest

builder

public static DescribeFolderContentsRequest.Builder builder()

serializableBuilderClass

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