Class DescribeDirectoriesRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Contains the inputs for the DescribeDirectories operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A list of identifiers of the directories for which to obtain the information.getLimit()
The maximum number of items to return.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
The maximum number of items to return.void
setNextToken
(String nextToken) The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.toString()
Returns a string representation of this object; useful for testing and debugging.withDirectoryIds
(String... directoryIds) A list of identifiers of the directories for which to obtain the information.withDirectoryIds
(Collection<String> directoryIds) A list of identifiers of the directories for which to obtain the information.The maximum number of items to return.withNextToken
(String nextToken) The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribeDirectoriesRequest
public DescribeDirectoriesRequest()
-
-
Method Details
-
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.- Returns:
- 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.
-
setDirectoryIds
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.
-
withDirectoryIds
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)
orwithDirectoryIds(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.
-
withDirectoryIds
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.
-
setNextToken
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.
-
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.
-
withNextToken
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.
-
setLimit
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.
-
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.
- 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.
-
withLimit
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-