com.amazonaws.services.customerprofiles.model.GetSimilarProfilesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-customerprofiles 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.customerprofiles.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 GetSimilarProfilesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The pagination token from the previous GetSimilarProfiles
API call.
*
*/
private String nextToken;
/**
*
* The maximum number of objects returned per page.
*
*/
private Integer maxResults;
/**
*
* The unique name of the domain.
*
*/
private String domainName;
/**
*
* Specify the type of matching to get similar profiles for.
*
*/
private String matchType;
/**
*
* The string indicating the search key to be used.
*
*/
private String searchKey;
/**
*
* The string based on SearchKey
to be searched for similar profiles.
*
*/
private String searchValue;
/**
*
* The pagination token from the previous GetSimilarProfiles
API call.
*
*
* @param nextToken
* The pagination token from the previous GetSimilarProfiles
API call.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The pagination token from the previous GetSimilarProfiles
API call.
*
*
* @return The pagination token from the previous GetSimilarProfiles
API call.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The pagination token from the previous GetSimilarProfiles
API call.
*
*
* @param nextToken
* The pagination token from the previous GetSimilarProfiles
API call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSimilarProfilesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of objects returned per page.
*
*
* @param maxResults
* The maximum number of objects returned per page.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of objects returned per page.
*
*
* @return The maximum number of objects returned per page.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of objects returned per page.
*
*
* @param maxResults
* The maximum number of objects returned per page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSimilarProfilesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The unique name of the domain.
*
*
* @param domainName
* The unique name of the domain.
*/
public void setDomainName(String domainName) {
this.domainName = domainName;
}
/**
*
* The unique name of the domain.
*
*
* @return The unique name of the domain.
*/
public String getDomainName() {
return this.domainName;
}
/**
*
* The unique name of the domain.
*
*
* @param domainName
* The unique name of the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSimilarProfilesRequest withDomainName(String domainName) {
setDomainName(domainName);
return this;
}
/**
*
* Specify the type of matching to get similar profiles for.
*
*
* @param matchType
* Specify the type of matching to get similar profiles for.
* @see MatchType
*/
public void setMatchType(String matchType) {
this.matchType = matchType;
}
/**
*
* Specify the type of matching to get similar profiles for.
*
*
* @return Specify the type of matching to get similar profiles for.
* @see MatchType
*/
public String getMatchType() {
return this.matchType;
}
/**
*
* Specify the type of matching to get similar profiles for.
*
*
* @param matchType
* Specify the type of matching to get similar profiles for.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MatchType
*/
public GetSimilarProfilesRequest withMatchType(String matchType) {
setMatchType(matchType);
return this;
}
/**
*
* Specify the type of matching to get similar profiles for.
*
*
* @param matchType
* Specify the type of matching to get similar profiles for.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MatchType
*/
public GetSimilarProfilesRequest withMatchType(MatchType matchType) {
this.matchType = matchType.toString();
return this;
}
/**
*
* The string indicating the search key to be used.
*
*
* @param searchKey
* The string indicating the search key to be used.
*/
public void setSearchKey(String searchKey) {
this.searchKey = searchKey;
}
/**
*
* The string indicating the search key to be used.
*
*
* @return The string indicating the search key to be used.
*/
public String getSearchKey() {
return this.searchKey;
}
/**
*
* The string indicating the search key to be used.
*
*
* @param searchKey
* The string indicating the search key to be used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSimilarProfilesRequest withSearchKey(String searchKey) {
setSearchKey(searchKey);
return this;
}
/**
*
* The string based on SearchKey
to be searched for similar profiles.
*
*
* @param searchValue
* The string based on SearchKey
to be searched for similar profiles.
*/
public void setSearchValue(String searchValue) {
this.searchValue = searchValue;
}
/**
*
* The string based on SearchKey
to be searched for similar profiles.
*
*
* @return The string based on SearchKey
to be searched for similar profiles.
*/
public String getSearchValue() {
return this.searchValue;
}
/**
*
* The string based on SearchKey
to be searched for similar profiles.
*
*
* @param searchValue
* The string based on SearchKey
to be searched for similar profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSimilarProfilesRequest withSearchValue(String searchValue) {
setSearchValue(searchValue);
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 (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getDomainName() != null)
sb.append("DomainName: ").append(getDomainName()).append(",");
if (getMatchType() != null)
sb.append("MatchType: ").append(getMatchType()).append(",");
if (getSearchKey() != null)
sb.append("SearchKey: ").append(getSearchKey()).append(",");
if (getSearchValue() != null)
sb.append("SearchValue: ").append(getSearchValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetSimilarProfilesRequest == false)
return false;
GetSimilarProfilesRequest other = (GetSimilarProfilesRequest) obj;
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.getDomainName() == null ^ this.getDomainName() == null)
return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false)
return false;
if (other.getMatchType() == null ^ this.getMatchType() == null)
return false;
if (other.getMatchType() != null && other.getMatchType().equals(this.getMatchType()) == false)
return false;
if (other.getSearchKey() == null ^ this.getSearchKey() == null)
return false;
if (other.getSearchKey() != null && other.getSearchKey().equals(this.getSearchKey()) == false)
return false;
if (other.getSearchValue() == null ^ this.getSearchValue() == null)
return false;
if (other.getSearchValue() != null && other.getSearchValue().equals(this.getSearchValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getDomainName() == null) ? 0 : getDomainName().hashCode());
hashCode = prime * hashCode + ((getMatchType() == null) ? 0 : getMatchType().hashCode());
hashCode = prime * hashCode + ((getSearchKey() == null) ? 0 : getSearchKey().hashCode());
hashCode = prime * hashCode + ((getSearchValue() == null) ? 0 : getSearchValue().hashCode());
return hashCode;
}
@Override
public GetSimilarProfilesRequest clone() {
return (GetSimilarProfilesRequest) super.clone();
}
}