software.amazon.awssdk.services.directory.model

Interface DescribeDirectoriesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>, DirectoryRequest.Builder, SdkBuilder<DescribeDirectoriesRequest.Builder,DescribeDirectoriesRequest>, SdkRequest.Builder

Enclosing class:

DescribeDirectoriesRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeDirectoriesRequest.Builder	directoryIds(Collection<String> directoryIds) A list of identifiers of the directories for which to obtain the information.
DescribeDirectoriesRequest.Builder	directoryIds(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.
DescribeDirectoriesRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeDirectoriesRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.directory.model.DirectoryRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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.

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.

requestOverrideConfig

DescribeDirectoriesRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeDirectoriesRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.