com.amazonaws.services.chime.model.ListChannelsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-chime 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.chime.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 ListChannelsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ARN of the AppInstance.
*
*/
private String appInstanceArn;
/**
*
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
*
*/
private String privacy;
/**
*
* The maximum number of channels that you want to return.
*
*/
private Integer maxResults;
/**
*
* The token passed by previous API calls until all requested channels are returned.
*
*/
private String nextToken;
/**
*
* The AppInstanceUserArn of the user that makes the API call.
*
*/
private String chimeBearer;
/**
*
* The ARN of the AppInstance.
*
*
* @param appInstanceArn
* The ARN of the AppInstance.
*/
public void setAppInstanceArn(String appInstanceArn) {
this.appInstanceArn = appInstanceArn;
}
/**
*
* The ARN of the AppInstance.
*
*
* @return The ARN of the AppInstance.
*/
public String getAppInstanceArn() {
return this.appInstanceArn;
}
/**
*
* The ARN of the AppInstance.
*
*
* @param appInstanceArn
* The ARN of the AppInstance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListChannelsRequest withAppInstanceArn(String appInstanceArn) {
setAppInstanceArn(appInstanceArn);
return this;
}
/**
*
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
*
*
* @param privacy
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
* @see ChannelPrivacy
*/
public void setPrivacy(String privacy) {
this.privacy = privacy;
}
/**
*
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
*
*
* @return The privacy setting. PUBLIC retrieves all the public channels. PRIVATE
* retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
* @see ChannelPrivacy
*/
public String getPrivacy() {
return this.privacy;
}
/**
*
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
*
*
* @param privacy
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelPrivacy
*/
public ListChannelsRequest withPrivacy(String privacy) {
setPrivacy(privacy);
return this;
}
/**
*
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
*
*
* @param privacy
* The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
* private channels. Only an AppInstanceAdmin can retrieve private channels.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelPrivacy
*/
public ListChannelsRequest withPrivacy(ChannelPrivacy privacy) {
this.privacy = privacy.toString();
return this;
}
/**
*
* The maximum number of channels that you want to return.
*
*
* @param maxResults
* The maximum number of channels that you want to return.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of channels that you want to return.
*
*
* @return The maximum number of channels that you want to return.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of channels that you want to return.
*
*
* @param maxResults
* The maximum number of channels that you want to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListChannelsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token passed by previous API calls until all requested channels are returned.
*
*
* @param nextToken
* The token passed by previous API calls until all requested channels are returned.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token passed by previous API calls until all requested channels are returned.
*
*
* @return The token passed by previous API calls until all requested channels are returned.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token passed by previous API calls until all requested channels are returned.
*
*
* @param nextToken
* The token passed by previous API calls until all requested channels are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListChannelsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The AppInstanceUserArn of the user that makes the API call.
*
*
* @param chimeBearer
* The AppInstanceUserArn of the user that makes the API call.
*/
public void setChimeBearer(String chimeBearer) {
this.chimeBearer = chimeBearer;
}
/**
*
* The AppInstanceUserArn of the user that makes the API call.
*
*
* @return The AppInstanceUserArn of the user that makes the API call.
*/
public String getChimeBearer() {
return this.chimeBearer;
}
/**
*
* The AppInstanceUserArn of the user that makes the API call.
*
*
* @param chimeBearer
* The AppInstanceUserArn of the user that makes the API call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListChannelsRequest withChimeBearer(String chimeBearer) {
setChimeBearer(chimeBearer);
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 (getAppInstanceArn() != null)
sb.append("AppInstanceArn: ").append(getAppInstanceArn()).append(",");
if (getPrivacy() != null)
sb.append("Privacy: ").append(getPrivacy()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append("***Sensitive Data Redacted***").append(",");
if (getChimeBearer() != null)
sb.append("ChimeBearer: ").append(getChimeBearer());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListChannelsRequest == false)
return false;
ListChannelsRequest other = (ListChannelsRequest) obj;
if (other.getAppInstanceArn() == null ^ this.getAppInstanceArn() == null)
return false;
if (other.getAppInstanceArn() != null && other.getAppInstanceArn().equals(this.getAppInstanceArn()) == false)
return false;
if (other.getPrivacy() == null ^ this.getPrivacy() == null)
return false;
if (other.getPrivacy() != null && other.getPrivacy().equals(this.getPrivacy()) == 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.getChimeBearer() == null ^ this.getChimeBearer() == null)
return false;
if (other.getChimeBearer() != null && other.getChimeBearer().equals(this.getChimeBearer()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAppInstanceArn() == null) ? 0 : getAppInstanceArn().hashCode());
hashCode = prime * hashCode + ((getPrivacy() == null) ? 0 : getPrivacy().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getChimeBearer() == null) ? 0 : getChimeBearer().hashCode());
return hashCode;
}
@Override
public ListChannelsRequest clone() {
return (ListChannelsRequest) super.clone();
}
}