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:
  • Constructor Details

    • DescribeDirectoriesRequest

      public DescribeDirectoriesRequest()
  • Method Details

    • 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) or withDirectoryIds(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 class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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 class AmazonWebServiceRequest
      See Also: