com.amazonaws.services.datazone.model.SearchRequest Maven / Gradle / Ivy
/*
* 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.datazone.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 SearchRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies additional attributes for the Search action.
*
*/
private java.util.List additionalAttributes;
/**
*
* The identifier of the Amazon DataZone domain.
*
*/
private String domainIdentifier;
/**
*
* Specifies the search filters.
*
*/
private FilterClause filters;
/**
*
* The maximum number of results to return in a single call to Search. When the number of results to be
* listed is greater than the value of MaxResults, the response contains a NextToken value
* that you can use in a subsequent call to Search to list the next set of results.
*
*/
private Integer maxResults;
/**
*
* When the number of results is greater than the default value for the MaxResults parameter, or if you
* explicitly specify a value for MaxResults that is less than the number of results, the response
* includes a pagination token named NextToken. You can specify this NextToken value in a
* subsequent call to Search to list the next set of results.
*
*/
private String nextToken;
/**
*
* The identifier of the owning project specified for the search.
*
*/
private String owningProjectIdentifier;
/** */
private java.util.List searchIn;
/**
*
* The scope of the search.
*
*/
private String searchScope;
/**
*
* Specifies the text for which to search.
*
*/
private String searchText;
/**
*
* Specifies the way in which the search results are to be sorted.
*
*/
private SearchSort sort;
/**
*
* Specifies additional attributes for the Search action.
*
*
* @return Specifies additional attributes for the Search action.
* @see SearchOutputAdditionalAttribute
*/
public java.util.List getAdditionalAttributes() {
return additionalAttributes;
}
/**
*
* Specifies additional attributes for the Search action.
*
*
* @param additionalAttributes
* Specifies additional attributes for the Search action.
* @see SearchOutputAdditionalAttribute
*/
public void setAdditionalAttributes(java.util.Collection additionalAttributes) {
if (additionalAttributes == null) {
this.additionalAttributes = null;
return;
}
this.additionalAttributes = new java.util.ArrayList(additionalAttributes);
}
/**
*
* Specifies additional attributes for the Search action.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAdditionalAttributes(java.util.Collection)} or {@link #withAdditionalAttributes(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param additionalAttributes
* Specifies additional attributes for the Search action.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SearchOutputAdditionalAttribute
*/
public SearchRequest withAdditionalAttributes(String... additionalAttributes) {
if (this.additionalAttributes == null) {
setAdditionalAttributes(new java.util.ArrayList(additionalAttributes.length));
}
for (String ele : additionalAttributes) {
this.additionalAttributes.add(ele);
}
return this;
}
/**
*
* Specifies additional attributes for the Search action.
*
*
* @param additionalAttributes
* Specifies additional attributes for the Search action.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SearchOutputAdditionalAttribute
*/
public SearchRequest withAdditionalAttributes(java.util.Collection additionalAttributes) {
setAdditionalAttributes(additionalAttributes);
return this;
}
/**
*
* Specifies additional attributes for the Search action.
*
*
* @param additionalAttributes
* Specifies additional attributes for the Search action.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SearchOutputAdditionalAttribute
*/
public SearchRequest withAdditionalAttributes(SearchOutputAdditionalAttribute... additionalAttributes) {
java.util.ArrayList additionalAttributesCopy = new java.util.ArrayList(additionalAttributes.length);
for (SearchOutputAdditionalAttribute value : additionalAttributes) {
additionalAttributesCopy.add(value.toString());
}
if (getAdditionalAttributes() == null) {
setAdditionalAttributes(additionalAttributesCopy);
} else {
getAdditionalAttributes().addAll(additionalAttributesCopy);
}
return this;
}
/**
*
* The identifier of the Amazon DataZone domain.
*
*
* @param domainIdentifier
* The identifier of the Amazon DataZone domain.
*/
public void setDomainIdentifier(String domainIdentifier) {
this.domainIdentifier = domainIdentifier;
}
/**
*
* The identifier of the Amazon DataZone domain.
*
*
* @return The identifier of the Amazon DataZone domain.
*/
public String getDomainIdentifier() {
return this.domainIdentifier;
}
/**
*
* The identifier of the Amazon DataZone domain.
*
*
* @param domainIdentifier
* The identifier of the Amazon DataZone domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withDomainIdentifier(String domainIdentifier) {
setDomainIdentifier(domainIdentifier);
return this;
}
/**
*
* Specifies the search filters.
*
*
* @param filters
* Specifies the search filters.
*/
public void setFilters(FilterClause filters) {
this.filters = filters;
}
/**
*
* Specifies the search filters.
*
*
* @return Specifies the search filters.
*/
public FilterClause getFilters() {
return this.filters;
}
/**
*
* Specifies the search filters.
*
*
* @param filters
* Specifies the search filters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withFilters(FilterClause filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of results to return in a single call to Search. When the number of results to be
* listed is greater than the value of MaxResults, the response contains a NextToken value
* that you can use in a subsequent call to Search to list the next set of results.
*
*
* @param maxResults
* The maximum number of results to return in a single call to Search. When the number of
* results to be listed is greater than the value of MaxResults, the response contains a
* NextToken value that you can use in a subsequent call to Search to list the next
* set of results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return in a single call to Search. When the number of results to be
* listed is greater than the value of MaxResults, the response contains a NextToken value
* that you can use in a subsequent call to Search to list the next set of results.
*
*
* @return The maximum number of results to return in a single call to Search. When the number of
* results to be listed is greater than the value of MaxResults, the response contains a
* NextToken value that you can use in a subsequent call to Search to list the
* next set of results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return in a single call to Search. When the number of results to be
* listed is greater than the value of MaxResults, the response contains a NextToken value
* that you can use in a subsequent call to Search to list the next set of results.
*
*
* @param maxResults
* The maximum number of results to return in a single call to Search. When the number of
* results to be listed is greater than the value of MaxResults, the response contains a
* NextToken value that you can use in a subsequent call to Search to list the next
* set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* When the number of results is greater than the default value for the MaxResults parameter, or if you
* explicitly specify a value for MaxResults that is less than the number of results, the response
* includes a pagination token named NextToken. You can specify this NextToken value in a
* subsequent call to Search to list the next set of results.
*
*
* @param nextToken
* When the number of results is greater than the default value for the MaxResults parameter, or
* if you explicitly specify a value for MaxResults that is less than the number of results, the
* response includes a pagination token named NextToken. You can specify this
* NextToken value in a subsequent call to Search to list the next set of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* When the number of results is greater than the default value for the MaxResults parameter, or if you
* explicitly specify a value for MaxResults that is less than the number of results, the response
* includes a pagination token named NextToken. You can specify this NextToken value in a
* subsequent call to Search to list the next set of results.
*
*
* @return When the number of results is greater than the default value for the MaxResults parameter,
* or if you explicitly specify a value for MaxResults that is less than the number of results,
* the response includes a pagination token named NextToken. You can specify this
* NextToken value in a subsequent call to Search to list the next set of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* When the number of results is greater than the default value for the MaxResults parameter, or if you
* explicitly specify a value for MaxResults that is less than the number of results, the response
* includes a pagination token named NextToken. You can specify this NextToken value in a
* subsequent call to Search to list the next set of results.
*
*
* @param nextToken
* When the number of results is greater than the default value for the MaxResults parameter, or
* if you explicitly specify a value for MaxResults that is less than the number of results, the
* response includes a pagination token named NextToken. You can specify this
* NextToken value in a subsequent call to Search to list the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The identifier of the owning project specified for the search.
*
*
* @param owningProjectIdentifier
* The identifier of the owning project specified for the search.
*/
public void setOwningProjectIdentifier(String owningProjectIdentifier) {
this.owningProjectIdentifier = owningProjectIdentifier;
}
/**
*
* The identifier of the owning project specified for the search.
*
*
* @return The identifier of the owning project specified for the search.
*/
public String getOwningProjectIdentifier() {
return this.owningProjectIdentifier;
}
/**
*
* The identifier of the owning project specified for the search.
*
*
* @param owningProjectIdentifier
* The identifier of the owning project specified for the search.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withOwningProjectIdentifier(String owningProjectIdentifier) {
setOwningProjectIdentifier(owningProjectIdentifier);
return this;
}
/**
*
*
* @return
*/
public java.util.List getSearchIn() {
return searchIn;
}
/**
*
*
* @param searchIn
*/
public void setSearchIn(java.util.Collection searchIn) {
if (searchIn == null) {
this.searchIn = null;
return;
}
this.searchIn = new java.util.ArrayList(searchIn);
}
/**
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSearchIn(java.util.Collection)} or {@link #withSearchIn(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param searchIn
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withSearchIn(SearchInItem... searchIn) {
if (this.searchIn == null) {
setSearchIn(new java.util.ArrayList(searchIn.length));
}
for (SearchInItem ele : searchIn) {
this.searchIn.add(ele);
}
return this;
}
/**
*
*
* @param searchIn
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withSearchIn(java.util.Collection searchIn) {
setSearchIn(searchIn);
return this;
}
/**
*
* The scope of the search.
*
*
* @param searchScope
* The scope of the search.
* @see InventorySearchScope
*/
public void setSearchScope(String searchScope) {
this.searchScope = searchScope;
}
/**
*
* The scope of the search.
*
*
* @return The scope of the search.
* @see InventorySearchScope
*/
public String getSearchScope() {
return this.searchScope;
}
/**
*
* The scope of the search.
*
*
* @param searchScope
* The scope of the search.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InventorySearchScope
*/
public SearchRequest withSearchScope(String searchScope) {
setSearchScope(searchScope);
return this;
}
/**
*
* The scope of the search.
*
*
* @param searchScope
* The scope of the search.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InventorySearchScope
*/
public SearchRequest withSearchScope(InventorySearchScope searchScope) {
this.searchScope = searchScope.toString();
return this;
}
/**
*
* Specifies the text for which to search.
*
*
* @param searchText
* Specifies the text for which to search.
*/
public void setSearchText(String searchText) {
this.searchText = searchText;
}
/**
*
* Specifies the text for which to search.
*
*
* @return Specifies the text for which to search.
*/
public String getSearchText() {
return this.searchText;
}
/**
*
* Specifies the text for which to search.
*
*
* @param searchText
* Specifies the text for which to search.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withSearchText(String searchText) {
setSearchText(searchText);
return this;
}
/**
*
* Specifies the way in which the search results are to be sorted.
*
*
* @param sort
* Specifies the way in which the search results are to be sorted.
*/
public void setSort(SearchSort sort) {
this.sort = sort;
}
/**
*
* Specifies the way in which the search results are to be sorted.
*
*
* @return Specifies the way in which the search results are to be sorted.
*/
public SearchSort getSort() {
return this.sort;
}
/**
*
* Specifies the way in which the search results are to be sorted.
*
*
* @param sort
* Specifies the way in which the search results are to be sorted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchRequest withSort(SearchSort sort) {
setSort(sort);
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 (getAdditionalAttributes() != null)
sb.append("AdditionalAttributes: ").append(getAdditionalAttributes()).append(",");
if (getDomainIdentifier() != null)
sb.append("DomainIdentifier: ").append(getDomainIdentifier()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getOwningProjectIdentifier() != null)
sb.append("OwningProjectIdentifier: ").append(getOwningProjectIdentifier()).append(",");
if (getSearchIn() != null)
sb.append("SearchIn: ").append(getSearchIn()).append(",");
if (getSearchScope() != null)
sb.append("SearchScope: ").append(getSearchScope()).append(",");
if (getSearchText() != null)
sb.append("SearchText: ").append(getSearchText()).append(",");
if (getSort() != null)
sb.append("Sort: ").append(getSort());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchRequest == false)
return false;
SearchRequest other = (SearchRequest) obj;
if (other.getAdditionalAttributes() == null ^ this.getAdditionalAttributes() == null)
return false;
if (other.getAdditionalAttributes() != null && other.getAdditionalAttributes().equals(this.getAdditionalAttributes()) == false)
return false;
if (other.getDomainIdentifier() == null ^ this.getDomainIdentifier() == null)
return false;
if (other.getDomainIdentifier() != null && other.getDomainIdentifier().equals(this.getDomainIdentifier()) == 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.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == 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.getOwningProjectIdentifier() == null ^ this.getOwningProjectIdentifier() == null)
return false;
if (other.getOwningProjectIdentifier() != null && other.getOwningProjectIdentifier().equals(this.getOwningProjectIdentifier()) == false)
return false;
if (other.getSearchIn() == null ^ this.getSearchIn() == null)
return false;
if (other.getSearchIn() != null && other.getSearchIn().equals(this.getSearchIn()) == false)
return false;
if (other.getSearchScope() == null ^ this.getSearchScope() == null)
return false;
if (other.getSearchScope() != null && other.getSearchScope().equals(this.getSearchScope()) == false)
return false;
if (other.getSearchText() == null ^ this.getSearchText() == null)
return false;
if (other.getSearchText() != null && other.getSearchText().equals(this.getSearchText()) == false)
return false;
if (other.getSort() == null ^ this.getSort() == null)
return false;
if (other.getSort() != null && other.getSort().equals(this.getSort()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAdditionalAttributes() == null) ? 0 : getAdditionalAttributes().hashCode());
hashCode = prime * hashCode + ((getDomainIdentifier() == null) ? 0 : getDomainIdentifier().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getOwningProjectIdentifier() == null) ? 0 : getOwningProjectIdentifier().hashCode());
hashCode = prime * hashCode + ((getSearchIn() == null) ? 0 : getSearchIn().hashCode());
hashCode = prime * hashCode + ((getSearchScope() == null) ? 0 : getSearchScope().hashCode());
hashCode = prime * hashCode + ((getSearchText() == null) ? 0 : getSearchText().hashCode());
hashCode = prime * hashCode + ((getSort() == null) ? 0 : getSort().hashCode());
return hashCode;
}
@Override
public SearchRequest clone() {
return (SearchRequest) super.clone();
}
}