software.amazon.awssdk.services.clouddirectory.model

Class ListDirectoriesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest

software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListDirectoriesRequest.Builder,ListDirectoriesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListDirectoriesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListDirectoriesRequest.Builder	builder()
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	maxResults() The maximum number of results to retrieve.
String	nextToken() The pagination token.
List<SdkField<?>>	sdkFields()
static Class<? extends ListDirectoriesRequest.Builder>	serializableBuilderClass()
DirectoryState	state() The state of the directories in the list.
String	stateAsString() The state of the directories in the list.
ListDirectoriesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

nextToken

public String nextToken()

The pagination token.

Returns:

The pagination token.

maxResults

public Integer maxResults()

The maximum number of results to retrieve.

Returns:

The maximum number of results to retrieve.

state

public DirectoryState state()

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

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

Returns:

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

See Also:

DirectoryState

stateAsString

public String stateAsString()

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

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

Returns:

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

See Also:

DirectoryState

toBuilder

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

Specified by:

toBuilder in class CloudDirectoryRequest

Returns:

a builder for type T

builder

public static ListDirectoriesRequest.Builder builder()

serializableBuilderClass

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