Package software.amazon.awssdk.services.directory.model

Class DescribeDirectoriesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.directory.model.DirectoryRequest

software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>

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

Contains the inputs for the DescribeDirectories operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDirectoriesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDirectoriesRequest.Builder	builder()
List<String>	directoryIds()	A list of identifiers of the directories for which to obtain the information.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDirectoryIds()	For responses, this returns true if the service returned a value for the DirectoryIds property.
int	hashCode()
Integer	limit()	The maximum number of items to return.
String	nextToken()	The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDirectoriesRequest.Builder>	serializableBuilderClass()
DescribeDirectoriesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasDirectoryIds

public final boolean hasDirectoryIds()

For responses, this returns true if the service returned a value for the DirectoryIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

directoryIds

public final List<String> directoryIds()

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDirectoryIds() method.

Returns:

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

nextToken

public final String nextToken()

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

Returns:

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

limit

public final Integer limit()

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Returns:

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

toBuilder

public DescribeDirectoriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>

Specified by:

toBuilder in class DirectoryRequest

builder

public static DescribeDirectoriesRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo