@Generated(value="software.amazon.awssdk:codegen") public final class DescribeDirectoriesRequest extends DirectoryRequest implements ToCopyableBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>
Contains the inputs for the DescribeDirectories operation.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeDirectoriesRequest.Builder |
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.
|
overrideConfiguration
copy
public final boolean hasDirectoryIds()
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.
An empty list results in an InvalidParameterException
being thrown.
public final String nextToken()
The DescribeDirectoriesResult.NextToken
value from a previous call to DescribeDirectories.
Pass null if this is the first call.
DescribeDirectoriesResult.NextToken
value from a previous call to
DescribeDirectories. Pass null if this is the first call.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.
public DescribeDirectoriesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>
toBuilder
in class DirectoryRequest
public static DescribeDirectoriesRequest.Builder builder()
public static Class<? extends DescribeDirectoriesRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.