com.amazonaws.services.directory.model

Class DescribeDirectoriesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.directory.model.DescribeDirectoriesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeDirectoriesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDirectories operation.

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

See Also:

AWSDirectoryService.describeDirectories(DescribeDirectoriesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDirectoriesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDirectoriesRequest	clone()
boolean	equals(Object obj)
List<String>	getDirectoryIds() A list of identifiers of the directories to obtain the information for.
Integer	getLimit() The maximum number of items to return.
String	getNextToken() The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
int	hashCode()
void	setDirectoryIds(Collection<String> directoryIds) A list of identifiers of the directories to obtain the information for.
void	setLimit(Integer limit) The maximum number of items to return.
void	setNextToken(String nextToken) The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDirectoriesRequest	withDirectoryIds(Collection<String> directoryIds) A list of identifiers of the directories to obtain the information for.
DescribeDirectoriesRequest	withDirectoryIds(String... directoryIds) A list of identifiers of the directories to obtain the information for.
DescribeDirectoriesRequest	withLimit(Integer limit) The maximum number of items to return.
DescribeDirectoriesRequest	withNextToken(String nextToken) The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeDirectoriesRequest

public DescribeDirectoriesRequest()

Method Detail

getDirectoryIds

public List<String> getDirectoryIds()

A list of identifiers of the directories to obtain the information for. 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:

A list of identifiers of the directories to obtain the information for. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

setDirectoryIds

public void setDirectoryIds(Collection<String> directoryIds)

A list of identifiers of the directories to obtain the information for. 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 to obtain the information for. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

withDirectoryIds

public DescribeDirectoriesRequest withDirectoryIds(String... directoryIds)

A list of identifiers of the directories to obtain the information for. 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.

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

Parameters:

directoryIds - A list of identifiers of the directories to obtain the information for. 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:

A reference to this updated object so that method calls can be chained together.

withDirectoryIds

public DescribeDirectoriesRequest withDirectoryIds(Collection<String> directoryIds)

A list of identifiers of the directories to obtain the information for. 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 a reference to this object so that method calls can be chained together.

Parameters:

directoryIds - A list of identifiers of the directories to obtain the information for. 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:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

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

Returns:

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

setNextToken

public void setNextToken(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.

withNextToken

public DescribeDirectoriesRequest withNextToken(String nextToken)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

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.

Constraints:
Range: 0 -

Returns:

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.

setLimit

public void setLimit(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.

Constraints:
Range: 0 -

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.

withLimit

public DescribeDirectoriesRequest withLimit(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.

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

Constraints:
Range: 0 -

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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeDirectoriesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest