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

Class GetResourcesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetResourcesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	authenticationToken()	The Amazon WorkDocs authentication token.
static GetResourcesRequest.Builder	builder()
ResourceCollectionType	collectionType()	The collection type.
String	collectionTypeAsString()	The collection type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of resources to return.
String	marker()	The marker for the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetResourcesRequest.Builder>	serializableBuilderClass()
GetResourcesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The user ID for the resource collection.

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

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

Returns:

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

userId

public final String userId()

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Returns:

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

collectionType

public final ResourceCollectionType collectionType()

The collection type.

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

Returns:

The collection type.

See Also:

ResourceCollectionType

collectionTypeAsString

public final String collectionTypeAsString()

The collection type.

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

Returns:

The collection type.

See Also:

ResourceCollectionType

limit

public final Integer limit()

The maximum number of resources to return.

Returns:

The maximum number of resources to return.

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.

toBuilder

public GetResourcesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

Specified by:

toBuilder in class WorkDocsRequest

builder

public static GetResourcesRequest.Builder builder()

serializableBuilderClass

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