Package 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("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	Description
static interface	DescribeDirectoriesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDirectoriesResponse.Builder	builder()
List<DirectoryDescription>	directoryDescriptions()	The list of DirectoryDescription objects that were retrieved.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDirectoryDescriptions()	For responses, this returns true if the service returned a value for the DirectoryDescriptions property.
int	hashCode()
String	nextToken()	If not null, more results are available.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDirectoriesResponse.Builder>	serializableBuilderClass()
DescribeDirectoriesResponse.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasDirectoryDescriptions

public final boolean hasDirectoryDescriptions()

For responses, this returns true if the service returned a value for the DirectoryDescriptions 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.

directoryDescriptions

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

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 hasDirectoryDescriptions() method.

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDirectoriesResponse.Builder,DescribeDirectoriesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDirectoriesResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo