public class DescribeDirectoriesRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Contains the inputs for the DescribeDirectories operation.
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<java.lang.String> |
directoryIds
A list of identifiers of the directories for which to obtain the
information.
|
private java.lang.Integer |
limit
The maximum number of items to return.
|
private java.lang.String |
nextToken
The DescribeDirectoriesResult.NextToken value from a previous call
to DescribeDirectories.
|
NOOP
Constructor and Description |
---|
DescribeDirectoriesRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeDirectoriesRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getDirectoryIds()
A list of identifiers of the directories for which to obtain the
information.
|
java.lang.Integer |
getLimit()
The maximum number of items to return.
|
java.lang.String |
getNextToken()
The DescribeDirectoriesResult.NextToken value from a previous call
to DescribeDirectories.
|
int |
hashCode() |
void |
setDirectoryIds(java.util.Collection<java.lang.String> directoryIds)
A list of identifiers of the directories for which to obtain the
information.
|
void |
setLimit(java.lang.Integer limit)
The maximum number of items to return.
|
void |
setNextToken(java.lang.String nextToken)
The DescribeDirectoriesResult.NextToken value from a previous call
to DescribeDirectories.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeDirectoriesRequest |
withDirectoryIds(java.util.Collection<java.lang.String> directoryIds)
A list of identifiers of the directories for which to obtain the
information.
|
DescribeDirectoriesRequest |
withDirectoryIds(java.lang.String... directoryIds)
A list of identifiers of the directories for which to obtain the
information.
|
DescribeDirectoriesRequest |
withLimit(java.lang.Integer limit)
The maximum number of items to return.
|
DescribeDirectoriesRequest |
withNextToken(java.lang.String nextToken)
The DescribeDirectoriesResult.NextToken value from a previous call
to DescribeDirectories.
|
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
private SdkInternalList<java.lang.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.
private java.lang.String nextToken
The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
private java.lang.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.
public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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(java.util.Collection<java.lang.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(java.lang.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 java.lang.String getNextToken()
The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
public DescribeDirectoriesRequest withNextToken(java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeDirectoriesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()