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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetResourcesRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<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()
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authenticationToken

public String authenticationToken()

The Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API operation using AWS credentials.

Returns:

The Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API operation using AWS credentials.

userId

public 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 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 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 Integer limit()

The maximum number of resources to return.

Returns:

The maximum number of resources to return.

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.

toBuilder

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

Specified by:

toBuilder in class WorkDocsRequest

Returns:

a builder for type T

builder

public static GetResourcesRequest.Builder builder()

serializableBuilderClass

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.