com.amazonaws.services.directory.model.DescribeDirectoriesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-directory Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.directory.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Contains the inputs for the DescribeDirectories operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDirectoriesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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 com.amazonaws.internal.SdkInternalList directoryIds;
/**
*
* The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
* Pass null if this is the first call.
*
*/
private String nextToken;
/**
*
* 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.
*
*/
private Integer limit;
/**
*
* 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.
*
*
* @return 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 java.util.List getDirectoryIds() {
if (directoryIds == null) {
directoryIds = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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 setDirectoryIds(java.util.Collection directoryIds) {
if (directoryIds == null) {
this.directoryIds = null;
return;
}
this.directoryIds = new com.amazonaws.internal.SdkInternalList(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
* {@link #setDirectoryIds(java.util.Collection)} or {@link #withDirectoryIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDirectoriesRequest withDirectoryIds(String... directoryIds) {
if (this.directoryIds == null) {
setDirectoryIds(new com.amazonaws.internal.SdkInternalList(directoryIds.length));
}
for (String ele : directoryIds) {
this.directoryIds.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDirectoriesRequest withDirectoryIds(java.util.Collection directoryIds) {
setDirectoryIds(directoryIds);
return this;
}
/**
*
* The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
* Pass null if this is the first call.
*
*
* @param nextToken
* The DescribeDirectoriesResult.NextToken value from a previous call to
* DescribeDirectories. Pass null if this is the first call.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
* Pass null if this is the first call.
*
*
* @return The DescribeDirectoriesResult.NextToken value from a previous call to
* DescribeDirectories. Pass null if this is the first call.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
* Pass null if this is the first call.
*
*
* @param nextToken
* The DescribeDirectoriesResult.NextToken value from a previous call to
* DescribeDirectories. Pass null if this is the first call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDirectoriesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setLimit(Integer limit) {
this.limit = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDirectoriesRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDirectoryIds() != null)
sb.append("DirectoryIds: ").append(getDirectoryIds()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDirectoriesRequest == false)
return false;
DescribeDirectoriesRequest other = (DescribeDirectoriesRequest) obj;
if (other.getDirectoryIds() == null ^ this.getDirectoryIds() == null)
return false;
if (other.getDirectoryIds() != null && other.getDirectoryIds().equals(this.getDirectoryIds()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDirectoryIds() == null) ? 0 : getDirectoryIds().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
return hashCode;
}
@Override
public DescribeDirectoriesRequest clone() {
return (DescribeDirectoriesRequest) super.clone();
}
}