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(value="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 and Description
static interface	DescribeDirectoriesRequest.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasDirectoryIds() Returns true if the DirectoryIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Integer	limit() The maximum number of items to return.
String	nextToken() The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDirectoriesRequest.Builder>	serializableBuilderClass()
DescribeDirectoriesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasDirectoryIds

public final boolean hasDirectoryIds()

Returns true if the DirectoryIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasDirectoryIds() to see if a value was sent in this field.

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

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<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>

Specified by:

toBuilder in class DirectoryRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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