/* * 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.chimesdkmessaging.model; import java.io.Serializable; /** *

* A Field of the channel that you want to search. *

*/ public class SearchField implements Serializable { /** *

* An enum value that indicates the key to search the channel * on. MEMBERS allows you to search channels based on * memberships. You can use it with the EQUALS operator to get * channels whose memberships are equal to the specified values, and with * the INCLUDES operator to get channels whose memberships * include the specified values. *

*

* Constraints:
* Allowed Values: MEMBERS */ private String key; /** *

* The values that you want to search for, a list of strings. The values * must be AppInstanceUserArns specified as a list of strings. *

* *

* This operation isn't supported for AppInstanceUsers with * large number of memberships. *

* */ private java.util.List values; /** *

* The operator used to compare field values, currently EQUALS * or INCLUDES. Use the EQUALS operator to find * channels whose memberships equal the specified values. Use the * INCLUDES operator to find channels whose memberships include * the specified values. *

*

* Constraints:
* Allowed Values: EQUALS, INCLUDES */ private String operator; /** *

* An enum value that indicates the key to search the channel * on. MEMBERS allows you to search channels based on * memberships. You can use it with the EQUALS operator to get * channels whose memberships are equal to the specified values, and with * the INCLUDES operator to get channels whose memberships * include the specified values. *

*

* Constraints:
* Allowed Values: MEMBERS * * @return

* An enum value that indicates the key to search the * channel on. MEMBERS allows you to search channels * based on memberships. You can use it with the EQUALS * operator to get channels whose memberships are equal to the * specified values, and with the INCLUDES operator to * get channels whose memberships include the specified values. *

* @see SearchFieldKey */ public String getKey() { return key; } /** *

* An enum value that indicates the key to search the channel * on. MEMBERS allows you to search channels based on * memberships. You can use it with the EQUALS operator to get * channels whose memberships are equal to the specified values, and with * the INCLUDES operator to get channels whose memberships * include the specified values. *

*

* Constraints:
* Allowed Values: MEMBERS * * @param key

* An enum value that indicates the key to search * the channel on. MEMBERS allows you to search * channels based on memberships. You can use it with the * EQUALS operator to get channels whose memberships * are equal to the specified values, and with the * INCLUDES operator to get channels whose * memberships include the specified values. *

* @see SearchFieldKey */ public void setKey(String key) { this.key = key; } /** *

* An enum value that indicates the key to search the channel * on. MEMBERS allows you to search channels based on * memberships. You can use it with the EQUALS operator to get * channels whose memberships are equal to the specified values, and with * the INCLUDES operator to get channels whose memberships * include the specified values. *

*

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

* Constraints:
* Allowed Values: MEMBERS * * @param key

* An enum value that indicates the key to search * the channel on. MEMBERS allows you to search * channels based on memberships. You can use it with the * EQUALS operator to get channels whose memberships * are equal to the specified values, and with the * INCLUDES operator to get channels whose * memberships include the specified values. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SearchFieldKey */ public SearchField withKey(String key) { this.key = key; return this; } /** *

* An enum value that indicates the key to search the channel * on. MEMBERS allows you to search channels based on * memberships. You can use it with the EQUALS operator to get * channels whose memberships are equal to the specified values, and with * the INCLUDES operator to get channels whose memberships * include the specified values. *

*

* Constraints:
* Allowed Values: MEMBERS * * @param key

* An enum value that indicates the key to search * the channel on. MEMBERS allows you to search * channels based on memberships. You can use it with the * EQUALS operator to get channels whose memberships * are equal to the specified values, and with the * INCLUDES operator to get channels whose * memberships include the specified values. *

* @see SearchFieldKey */ public void setKey(SearchFieldKey key) { this.key = key.toString(); } /** *

* An enum value that indicates the key to search the channel * on. MEMBERS allows you to search channels based on * memberships. You can use it with the EQUALS operator to get * channels whose memberships are equal to the specified values, and with * the INCLUDES operator to get channels whose memberships * include the specified values. *

*

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

* Constraints:
* Allowed Values: MEMBERS * * @param key

* An enum value that indicates the key to search * the channel on. MEMBERS allows you to search * channels based on memberships. You can use it with the * EQUALS operator to get channels whose memberships * are equal to the specified values, and with the * INCLUDES operator to get channels whose * memberships include the specified values. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SearchFieldKey */ public SearchField withKey(SearchFieldKey key) { this.key = key.toString(); return this; } /** *

* The values that you want to search for, a list of strings. The values * must be AppInstanceUserArns specified as a list of strings. *

* *

* This operation isn't supported for AppInstanceUsers with * large number of memberships. *

* * * @return

* The values that you want to search for, a list of strings. The * values must be AppInstanceUserArns specified as a * list of strings. *

* *

* This operation isn't supported for AppInstanceUsers * with large number of memberships. *

* */ public java.util.List getValues() { return values; } /** *

* The values that you want to search for, a list of strings. The values * must be AppInstanceUserArns specified as a list of strings. *

* *

* This operation isn't supported for AppInstanceUsers with * large number of memberships. *

* * * @param values

* The values that you want to search for, a list of strings. The * values must be AppInstanceUserArns specified as a * list of strings. *

* *

* This operation isn't supported for * AppInstanceUsers with large number of * memberships. *

* */ public void setValues(java.util.Collection values) { if (values == null) { this.values = null; return; } this.values = new java.util.ArrayList(values); } /** *

* The values that you want to search for, a list of strings. The values * must be AppInstanceUserArns specified as a list of strings. *

* *

* This operation isn't supported for AppInstanceUsers with * large number of memberships. *

* *

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

* The values that you want to search for, a list of strings. The * values must be AppInstanceUserArns specified as a * list of strings. *

* *

* This operation isn't supported for * AppInstanceUsers with large number of * memberships. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SearchField withValues(String... values) { if (getValues() == null) { this.values = new java.util.ArrayList(values.length); } for (String value : values) { this.values.add(value); } return this; } /** *

* The values that you want to search for, a list of strings. The values * must be AppInstanceUserArns specified as a list of strings. *

* *

* This operation isn't supported for AppInstanceUsers with * large number of memberships. *

* *

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

* The values that you want to search for, a list of strings. The * values must be AppInstanceUserArns specified as a * list of strings. *

* *

* This operation isn't supported for * AppInstanceUsers with large number of * memberships. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SearchField withValues(java.util.Collection values) { setValues(values); return this; } /** *

* The operator used to compare field values, currently EQUALS * or INCLUDES. Use the EQUALS operator to find * channels whose memberships equal the specified values. Use the * INCLUDES operator to find channels whose memberships include * the specified values. *

*

* Constraints:
* Allowed Values: EQUALS, INCLUDES * * @return

* The operator used to compare field values, currently * EQUALS or INCLUDES. Use the * EQUALS operator to find channels whose memberships * equal the specified values. Use the INCLUDES * operator to find channels whose memberships include the specified * values. *

* @see SearchFieldOperator */ public String getOperator() { return operator; } /** *

* The operator used to compare field values, currently EQUALS * or INCLUDES. Use the EQUALS operator to find * channels whose memberships equal the specified values. Use the * INCLUDES operator to find channels whose memberships include * the specified values. *

*

* Constraints:
* Allowed Values: EQUALS, INCLUDES * * @param operator

* The operator used to compare field values, currently * EQUALS or INCLUDES. Use the * EQUALS operator to find channels whose * memberships equal the specified values. Use the * INCLUDES operator to find channels whose * memberships include the specified values. *

* @see SearchFieldOperator */ public void setOperator(String operator) { this.operator = operator; } /** *

* The operator used to compare field values, currently EQUALS * or INCLUDES. Use the EQUALS operator to find * channels whose memberships equal the specified values. Use the * INCLUDES operator to find channels whose memberships include * the specified values. *

*

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

* Constraints:
* Allowed Values: EQUALS, INCLUDES * * @param operator

* The operator used to compare field values, currently * EQUALS or INCLUDES. Use the * EQUALS operator to find channels whose * memberships equal the specified values. Use the * INCLUDES operator to find channels whose * memberships include the specified values. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SearchFieldOperator */ public SearchField withOperator(String operator) { this.operator = operator; return this; } /** *

* The operator used to compare field values, currently EQUALS * or INCLUDES. Use the EQUALS operator to find * channels whose memberships equal the specified values. Use the * INCLUDES operator to find channels whose memberships include * the specified values. *

*

* Constraints:
* Allowed Values: EQUALS, INCLUDES * * @param operator

* The operator used to compare field values, currently * EQUALS or INCLUDES. Use the * EQUALS operator to find channels whose * memberships equal the specified values. Use the * INCLUDES operator to find channels whose * memberships include the specified values. *

* @see SearchFieldOperator */ public void setOperator(SearchFieldOperator operator) { this.operator = operator.toString(); } /** *

* The operator used to compare field values, currently EQUALS * or INCLUDES. Use the EQUALS operator to find * channels whose memberships equal the specified values. Use the * INCLUDES operator to find channels whose memberships include * the specified values. *

*

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

* Constraints:
* Allowed Values: EQUALS, INCLUDES * * @param operator

* The operator used to compare field values, currently * EQUALS or INCLUDES. Use the * EQUALS operator to find channels whose * memberships equal the specified values. Use the * INCLUDES operator to find channels whose * memberships include the specified values. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SearchFieldOperator */ public SearchField withOperator(SearchFieldOperator operator) { this.operator = operator.toString(); 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 (getKey() != null) sb.append("Key: " + getKey() + ","); if (getValues() != null) sb.append("Values: " + getValues() + ","); if (getOperator() != null) sb.append("Operator: " + getOperator()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode()); hashCode = prime * hashCode + ((getValues() == null) ? 0 : getValues().hashCode()); hashCode = prime * hashCode + ((getOperator() == null) ? 0 : getOperator().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SearchField == false) return false; SearchField other = (SearchField) obj; if (other.getKey() == null ^ this.getKey() == null) return false; if (other.getKey() != null && other.getKey().equals(this.getKey()) == false) return false; if (other.getValues() == null ^ this.getValues() == null) return false; if (other.getValues() != null && other.getValues().equals(this.getValues()) == false) return false; if (other.getOperator() == null ^ this.getOperator() == null) return false; if (other.getOperator() != null && other.getOperator().equals(this.getOperator()) == false) return false; return true; } }