/* * 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; import com.amazonaws.AmazonWebServiceRequest; /** *

* Allows the ChimeBearer to search channels by channel members. * Users or bots can search across the channels that they belong to. Users in * the AppInstanceAdmin role can search across all channels. *

*

* The x-amz-chime-bearer request header is mandatory. Use the ARN * of the AppInstanceUser or AppInstanceBot that makes * the API call as the value in the header. *

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

* The AppInstanceUserArn of the user making the API call. *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
*/ private String chimeBearer; /** *

* A list of the Field objects in the channel being searched. *

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

* The maximum number of channels that you want returned. *

*

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

* The token returned from previous API requests until the number of * channels is reached. *

*

* Constraints:
* Length: 0 - 2048
* Pattern: .*
*/ private String nextToken; /** *

* The AppInstanceUserArn of the user making the API call. *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @return

* The AppInstanceUserArn of the user making the API * call. *

*/ public String getChimeBearer() { return chimeBearer; } /** *

* The AppInstanceUserArn of the user making the API call. *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param chimeBearer

* The AppInstanceUserArn of the user making the API * call. *

*/ public void setChimeBearer(String chimeBearer) { this.chimeBearer = chimeBearer; } /** *

* The AppInstanceUserArn of the user making the API call. *

*

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

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param chimeBearer

* The AppInstanceUserArn of the user making the API * call. *

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

* A list of the Field objects in the channel being searched. *

* * @return

* A list of the Field objects in the channel being * searched. *

*/ public java.util.List getFields() { return fields; } /** *

* A list of the Field objects in the channel being searched. *

* * @param fields

* A list of the Field objects in the channel being * searched. *

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

* A list of the Field objects in the channel being searched. *

*

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

* A list of the Field objects in the channel being * searched. *

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

* A list of the Field objects in the channel being searched. *

*

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

* A list of the Field objects in the channel being * searched. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchChannelsRequest withFields(java.util.Collection fields) { setFields(fields); return this; } /** *

* The maximum number of channels that you want returned. *

*

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

* The maximum number of channels that you want returned. *

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

* The maximum number of channels that you want returned. *

*

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

* The maximum number of channels that you want returned. *

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

* The maximum number of channels that you want returned. *

*

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

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

* The maximum number of channels that you want returned. *

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

* The token returned from previous API requests until the number of * channels is reached. *

*

* Constraints:
* Length: 0 - 2048
* Pattern: .*
* * @return

* The token returned from previous API requests until the number of * channels is reached. *

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

* The token returned from previous API requests until the number of * channels is reached. *

*

* Constraints:
* Length: 0 - 2048
* Pattern: .*
* * @param nextToken

* The token returned from previous API requests until the number * of channels is reached. *

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

* The token returned from previous API requests until the number of * channels is reached. *

*

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

* Constraints:
* Length: 0 - 2048
* Pattern: .*
* * @param nextToken

* The token returned from previous API requests until the number * of channels is reached. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchChannelsRequest withNextToken(String nextToken) { this.nextToken = nextToken; 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 (getChimeBearer() != null) sb.append("ChimeBearer: " + getChimeBearer() + ","); if (getFields() != null) sb.append("Fields: " + getFields() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getChimeBearer() == null) ? 0 : getChimeBearer().hashCode()); hashCode = prime * hashCode + ((getFields() == null) ? 0 : getFields().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SearchChannelsRequest == false) return false; SearchChannelsRequest other = (SearchChannelsRequest) obj; if (other.getChimeBearer() == null ^ this.getChimeBearer() == null) return false; if (other.getChimeBearer() != null && other.getChimeBearer().equals(this.getChimeBearer()) == false) return false; if (other.getFields() == null ^ this.getFields() == null) return false; if (other.getFields() != null && other.getFields().equals(this.getFields()) == 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; return true; } }