@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeDirectoriesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Contains the inputs for the DescribeDirectories operation.
NOOP
Constructor and Description |
---|
DescribeDirectoriesRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeDirectoriesRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getDirectoryIds()
A list of identifiers of the directories for which to obtain the information.
|
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 for which to obtain the information.
|
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.
|
DescribeDirectoriesRequest |
withDirectoryIds(Collection<String> directoryIds)
A list of identifiers of the directories for which to obtain the information.
|
DescribeDirectoriesRequest |
withDirectoryIds(String... directoryIds)
A list of identifiers of the directories for which to obtain the information.
|
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. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public List<String> getDirectoryIds()
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.
An empty list results in an InvalidParameterException
being thrown.
public void setDirectoryIds(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.
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.
public DescribeDirectoriesRequest withDirectoryIds(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.
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.
public DescribeDirectoriesRequest withDirectoryIds(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.
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.
public void setNextToken(String nextToken)
The DescribeDirectoriesResult.NextToken
value from a previous call to DescribeDirectories.
Pass null if this is the first call.
nextToken
- The DescribeDirectoriesResult.NextToken
value from a previous call to
DescribeDirectories. Pass null if this is the first call.public String getNextToken()
The DescribeDirectoriesResult.NextToken
value from a previous call to DescribeDirectories.
Pass null if this is the first call.
DescribeDirectoriesResult.NextToken
value from a previous call to
DescribeDirectories. Pass null if this is the first call.public DescribeDirectoriesRequest withNextToken(String nextToken)
The DescribeDirectoriesResult.NextToken
value from a previous call to DescribeDirectories.
Pass null if this is the first call.
nextToken
- The DescribeDirectoriesResult.NextToken
value from a previous call to
DescribeDirectories. Pass null if this is the first call.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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public DescribeDirectoriesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()