software.amazon.awssdk.services.directory.model

Class DescribeDirectoriesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.directory.model.DirectoryResponse

software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDirectoriesResponse.Builder,DescribeDirectoriesResponse>

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

Contains the results of the DescribeDirectories operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDirectoriesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDirectoriesResponse.Builder	builder()
List<DirectoryDescription>	directoryDescriptions() The list of DirectoryDescription objects that were retrieved.
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 SdkResponse.
boolean	hasDirectoryDescriptions() Returns true if the DirectoryDescriptions 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()
String	nextToken() If not null, more results are available.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDirectoriesResponse.Builder>	serializableBuilderClass()
DescribeDirectoriesResponse.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.services.directory.model.DirectoryResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasDirectoryDescriptions

public boolean hasDirectoryDescriptions()

Returns true if the DirectoryDescriptions 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.

directoryDescriptions

public List<DirectoryDescription> directoryDescriptions()

The list of DirectoryDescription objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

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

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

Returns:

The list of DirectoryDescription objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

nextToken

public String nextToken()

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.

Returns:

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeDirectoriesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDirectoriesResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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.