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
Contains the inputs for the DescribeDirectories operation.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeDirectoriesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeDirectoriesRequest
clone()
Creates a shallow clone of this request.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; useful for testing and debugging.DescribeDirectoriesRequest
withDirectoryIds(String... directoryIds)
A list of identifiers of the directories for which to obtain the information.DescribeDirectoriesRequest
withDirectoryIds(Collection<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.-
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
-
-
-
-
Method Detail
-
getDirectoryIds
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.- 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
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.- 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
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)
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
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.- 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
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.
-
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.
-
withNextToken
public DescribeDirectoriesRequest withNextToken(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.
-
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.
- 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
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.
- 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
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.
- 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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeDirectoriesRequest 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:
Object.clone()
-
-