com.amazonaws.services.quicksight.model.SearchGroupsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight 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.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SearchGroupsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web
* Services account that contains your Amazon QuickSight account.
*
*/
private String awsAccountId;
/**
*
* A pagination token that can be used in a subsequent request.
*
*/
private String nextToken;
/**
*
* The maximum number of results to return from this request.
*
*/
private Integer maxResults;
/**
*
* The namespace that you want to search.
*
*/
private String namespace;
/**
*
* The structure for the search filters that you want to apply to your search.
*
*/
private java.util.List filters;
/**
*
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web
* Services account that contains your Amazon QuickSight account.
*
*
* @param awsAccountId
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon
* Web Services account that contains your Amazon QuickSight account.
*/
public void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
/**
*
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web
* Services account that contains your Amazon QuickSight account.
*
*
* @return The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon
* Web Services account that contains your Amazon QuickSight account.
*/
public String getAwsAccountId() {
return this.awsAccountId;
}
/**
*
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web
* Services account that contains your Amazon QuickSight account.
*
*
* @param awsAccountId
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon
* Web Services account that contains your Amazon QuickSight account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchGroupsRequest withAwsAccountId(String awsAccountId) {
setAwsAccountId(awsAccountId);
return this;
}
/**
*
* A pagination token that can be used in a subsequent request.
*
*
* @param nextToken
* A pagination token that can be used in a subsequent request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A pagination token that can be used in a subsequent request.
*
*
* @return A pagination token that can be used in a subsequent request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A pagination token that can be used in a subsequent request.
*
*
* @param nextToken
* A pagination token that can be used in a subsequent request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchGroupsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of results to return from this request.
*
*
* @param maxResults
* The maximum number of results to return from this request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return from this request.
*
*
* @return The maximum number of results to return from this request.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return from this request.
*
*
* @param maxResults
* The maximum number of results to return from this request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchGroupsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The namespace that you want to search.
*
*
* @param namespace
* The namespace that you want to search.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
*
* The namespace that you want to search.
*
*
* @return The namespace that you want to search.
*/
public String getNamespace() {
return this.namespace;
}
/**
*
* The namespace that you want to search.
*
*
* @param namespace
* The namespace that you want to search.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchGroupsRequest withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* The structure for the search filters that you want to apply to your search.
*
*
* @return The structure for the search filters that you want to apply to your search.
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* The structure for the search filters that you want to apply to your search.
*
*
* @param filters
* The structure for the search filters that you want to apply to your search.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* The structure for the search filters that you want to apply to your search.
*
*
* NOTE: 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.
*
*
* @param filters
* The structure for the search filters that you want to apply to your search.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchGroupsRequest withFilters(GroupSearchFilter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (GroupSearchFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* The structure for the search filters that you want to apply to your search.
*
*
* @param filters
* The structure for the search filters that you want to apply to your search.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchGroupsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
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 (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNamespace() != null)
sb.append("Namespace: ").append(getNamespace()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchGroupsRequest == false)
return false;
SearchGroupsRequest other = (SearchGroupsRequest) obj;
if (other.getAwsAccountId() == null ^ this.getAwsAccountId() == null)
return false;
if (other.getAwsAccountId() != null && other.getAwsAccountId().equals(this.getAwsAccountId()) == 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;
if (other.getNamespace() == null ^ this.getNamespace() == null)
return false;
if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == 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 + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public SearchGroupsRequest clone() {
return (SearchGroupsRequest) super.clone();
}
}