/* * Copyright 2010-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.connect.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Searches users in an Amazon Connect instance, with optional filtering. *

* *

* AfterContactWorkTimeLimit is returned in milliseconds. *

* */ public class SearchUsersRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *

*

* Constraints:
* Length: 1 - 100
*/ private String instanceId; /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Constraints:
* Length: 1 - 2500
*/ private String nextToken; /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
*/ private Integer maxResults; /** *

* Filters to be applied to search results. *

*/ private UserSearchFilter searchFilter; /** *

* The search criteria to be used to return users. *

* *

* The name and description fields support * "contains" queries with a minimum of 2 characters and a maximum of 25 * characters. Any queries with character lengths outside of this range will * throw invalid results. *

* */ private UserSearchCriteria searchCriteria; /** *

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *

*

* Constraints:
* Length: 1 - 100
* * @return

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *

*/ public String getInstanceId() { return instanceId; } /** *

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *

*

* Constraints:
* Length: 1 - 100
* * @param instanceId

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *

*/ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } /** *

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 100
* * @param instanceId

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchUsersRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Constraints:
* Length: 1 - 2500
* * @return

* The token for the next set of results. Use the value returned in * the previous response in the next request to retrieve the next * set of results. *

*/ public String getNextToken() { return nextToken; } /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Constraints:
* Length: 1 - 2500
* * @param nextToken

* The token for the next set of results. Use the value returned * in the previous response in the next request to retrieve the * next set of results. *

*/ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2500
* * @param nextToken

* The token for the next set of results. Use the value returned * in the previous response in the next request to retrieve the * next set of results. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchUsersRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
* * @return

* The maximum number of results to return per page. *

*/ public Integer getMaxResults() { return maxResults; } /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
* * @param maxResults

* The maximum number of results to return per page. *

*/ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* The maximum number of results to return per page. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 100
* * @param maxResults

* The maximum number of results to return per page. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchUsersRequest withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** *

* Filters to be applied to search results. *

* * @return

* Filters to be applied to search results. *

*/ public UserSearchFilter getSearchFilter() { return searchFilter; } /** *

* Filters to be applied to search results. *

* * @param searchFilter

* Filters to be applied to search results. *

*/ public void setSearchFilter(UserSearchFilter searchFilter) { this.searchFilter = searchFilter; } /** *

* Filters to be applied to search results. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param searchFilter

* Filters to be applied to search results. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchUsersRequest withSearchFilter(UserSearchFilter searchFilter) { this.searchFilter = searchFilter; return this; } /** *

* The search criteria to be used to return users. *

* *

* The name and description fields support * "contains" queries with a minimum of 2 characters and a maximum of 25 * characters. Any queries with character lengths outside of this range will * throw invalid results. *

* * * @return

* The search criteria to be used to return users. *

* *

* The name and description fields support * "contains" queries with a minimum of 2 characters and a maximum * of 25 characters. Any queries with character lengths outside of * this range will throw invalid results. *

* */ public UserSearchCriteria getSearchCriteria() { return searchCriteria; } /** *

* The search criteria to be used to return users. *

* *

* The name and description fields support * "contains" queries with a minimum of 2 characters and a maximum of 25 * characters. Any queries with character lengths outside of this range will * throw invalid results. *

* * * @param searchCriteria

* The search criteria to be used to return users. *

* *

* The name and description fields * support "contains" queries with a minimum of 2 characters and * a maximum of 25 characters. Any queries with character lengths * outside of this range will throw invalid results. *

* */ public void setSearchCriteria(UserSearchCriteria searchCriteria) { this.searchCriteria = searchCriteria; } /** *

* The search criteria to be used to return users. *

* *

* The name and description fields support * "contains" queries with a minimum of 2 characters and a maximum of 25 * characters. Any queries with character lengths outside of this range will * throw invalid results. *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @param searchCriteria

* The search criteria to be used to return users. *

* *

* The name and description fields * support "contains" queries with a minimum of 2 characters and * a maximum of 25 characters. Any queries with character lengths * outside of this range will throw invalid results. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SearchUsersRequest withSearchCriteria(UserSearchCriteria searchCriteria) { this.searchCriteria = searchCriteria; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getInstanceId() != null) sb.append("InstanceId: " + getInstanceId() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ","); if (getSearchFilter() != null) sb.append("SearchFilter: " + getSearchFilter() + ","); if (getSearchCriteria() != null) sb.append("SearchCriteria: " + getSearchCriteria()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getSearchFilter() == null) ? 0 : getSearchFilter().hashCode()); hashCode = prime * hashCode + ((getSearchCriteria() == null) ? 0 : getSearchCriteria().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SearchUsersRequest == false) return false; SearchUsersRequest other = (SearchUsersRequest) obj; if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false; if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == 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.getSearchFilter() == null ^ this.getSearchFilter() == null) return false; if (other.getSearchFilter() != null && other.getSearchFilter().equals(this.getSearchFilter()) == false) return false; if (other.getSearchCriteria() == null ^ this.getSearchCriteria() == null) return false; if (other.getSearchCriteria() != null && other.getSearchCriteria().equals(this.getSearchCriteria()) == false) return false; return true; } }