/*
* Copyright 2018-2023 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.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFolders" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SearchFoldersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* <p>
* The ID for the Amazon Web Services account that contains the folder.
* </p>
*/
private String awsAccountId;
/**
* <p>
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
* </p>
*/
private java.util.List<FolderSearchFilter> filters;
/**
* <p>
* The token for the next set of results, or null if there are no more results.
* </p>
*/
private String nextToken;
/**
* <p>
* The maximum number of results to be returned per request.
* </p>
*/
private Integer maxResults;
/**
* <p>
* The ID for the Amazon Web Services account that contains the folder.
* </p>
*
* @param awsAccountId
* The ID for the Amazon Web Services account that contains the folder.
*/
public void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
/**
* <p>
* The ID for the Amazon Web Services account that contains the folder.
* </p>
*
* @return The ID for the Amazon Web Services account that contains the folder.
*/
public String getAwsAccountId() {
return this.awsAccountId;
}
/**
* <p>
* The ID for the Amazon Web Services account that contains the folder.
* </p>
*
* @param awsAccountId
* The ID for the Amazon Web Services account that contains the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchFoldersRequest withAwsAccountId(String awsAccountId) {
setAwsAccountId(awsAccountId);
return this;
}
/**
* <p>
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
* </p>
*
* @return The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
*/
public java.util.List<FolderSearchFilter> getFilters() {
return filters;
}
/**
* <p>
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
* </p>
*
* @param filters
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
*/
public void setFilters(java.util.Collection<FolderSearchFilter> filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList<FolderSearchFilter>(filters);
}
/**
* <p>
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
* </p>
*
* @param filters
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchFoldersRequest withFilters(FolderSearchFilter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList<FolderSearchFilter>(filters.length));
}
for (FolderSearchFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
* <p>
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
* </p>
*
* @param filters
* The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
* <code>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</code>
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchFoldersRequest withFilters(java.util.Collection<FolderSearchFilter> filters) {
setFilters(filters);
return this;
}
/**
* <p>
* The token for the next set of results, or null if there are no more results.
* </p>
*
* @param nextToken
* The token for the next set of results, or null if there are no more results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* <p>
* The token for the next set of results, or null if there are no more results.
* </p>
*
* @return The token for the next set of results, or null if there are no more results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
* <p>
* The token for the next set of results, or null if there are no more results.
* </p>
*
* @param nextToken
* The token for the next set of results, or null if there are no more results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchFoldersRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* <p>
* The maximum number of results to be returned per request.
* </p>
*
* @param maxResults
* The maximum number of results to be returned per request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
* <p>
* The maximum number of results to be returned per request.
* </p>
*
* @return The maximum number of results to be returned per request.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
* <p>
* The maximum number of results to be returned per request.
* </p>
*
* @param maxResults
* The maximum number of results to be returned per request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchFoldersRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getAwsAccountId() != null)
sb.append("AwsAccountId: ").append(getAwsAccountId()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchFoldersRequest == false)
return false;
SearchFoldersRequest other = (SearchFoldersRequest) obj;
if (other.getAwsAccountId() == null ^ this.getAwsAccountId() == null)
return false;
if (other.getAwsAccountId() != null && other.getAwsAccountId().equals(this.getAwsAccountId()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == 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.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAwsAccountId() == null) ? 0 : getAwsAccountId().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public SearchFoldersRequest clone() {
return (SearchFoldersRequest) super.clone();
}
}