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

Interface DescribeDirectoriesRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>, SdkBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>

Enclosing class:

DescribeDirectoriesRequest

public static interface DescribeDirectoriesRequest.Builder
extends CopyableBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>

Method Summary

Modifier and Type	Method	Description
DescribeDirectoriesRequest.Builder	directoryIds(String... directoryIds)	A list of identifiers of the directories for which to obtain the information.
DescribeDirectoriesRequest.Builder	directoryIds(Collection<String> directoryIds)	A list of identifiers of the directories for which to obtain the information.
DescribeDirectoriesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
DescribeDirectoriesRequest.Builder	nextToken(String nextToken)	The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.

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

copy

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

apply, build

Method Detail

directoryIds

DescribeDirectoriesRequest.Builder directoryIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

directoryIds

DescribeDirectoriesRequest.Builder directoryIds(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.

NOTE: This method appends the values to the existing list (if any). Use #setDirectoryIds(java.util.Collection) or #withDirectoryIds(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeDirectoriesRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

limit

DescribeDirectoriesRequest.Builder limit(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.