com.amazonaws.services.ivsrealtime.model.ListParticipantsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ivsrealtime 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.ivsrealtime.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 ListParticipantsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*/
private Boolean filterByPublished;
/**
*
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*/
private String filterByState;
/**
*
* Filters the response list to match the specified user ID. Only one of filterByUserId,
* filterByPublished, or filterByState can be provided per request. A userId
* is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the
* customer’s own systems.
*
*/
private String filterByUserId;
/**
*
* Maximum number of results to return. Default: 50.
*
*/
private Integer maxResults;
/**
*
* The first participant to retrieve. This is used for pagination; see the nextToken response field.
*
*/
private String nextToken;
/**
*
* ID of the session within the stage.
*
*/
private String sessionId;
/**
*
* Stage ARN.
*
*/
private String stageArn;
/**
*
* Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @param filterByPublished
* Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided
* per request.
*/
public void setFilterByPublished(Boolean filterByPublished) {
this.filterByPublished = filterByPublished;
}
/**
*
* Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @return Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be
* provided per request.
*/
public Boolean getFilterByPublished() {
return this.filterByPublished;
}
/**
*
* Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @param filterByPublished
* Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided
* per request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListParticipantsRequest withFilterByPublished(Boolean filterByPublished) {
setFilterByPublished(filterByPublished);
return this;
}
/**
*
* Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @return Filters the response list to only show participants who published during the stage session. Only one of
* filterByUserId, filterByPublished, or filterByState can be
* provided per request.
*/
public Boolean isFilterByPublished() {
return this.filterByPublished;
}
/**
*
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @param filterByState
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided
* per request.
* @see ParticipantState
*/
public void setFilterByState(String filterByState) {
this.filterByState = filterByState;
}
/**
*
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @return Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be
* provided per request.
* @see ParticipantState
*/
public String getFilterByState() {
return this.filterByState;
}
/**
*
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @param filterByState
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided
* per request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ParticipantState
*/
public ListParticipantsRequest withFilterByState(String filterByState) {
setFilterByState(filterByState);
return this;
}
/**
*
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided per
* request.
*
*
* @param filterByState
* Filters the response list to only show participants in the specified state. Only one of
* filterByUserId, filterByPublished, or filterByState can be provided
* per request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ParticipantState
*/
public ListParticipantsRequest withFilterByState(ParticipantState filterByState) {
this.filterByState = filterByState.toString();
return this;
}
/**
*
* Filters the response list to match the specified user ID. Only one of filterByUserId,
* filterByPublished, or filterByState can be provided per request. A userId
* is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the
* customer’s own systems.
*
*
* @param filterByUserId
* Filters the response list to match the specified user ID. Only one of filterByUserId,
* filterByPublished, or filterByState can be provided per request. A
* userId is a customer-assigned name to help identify the token; this can be used to link a
* participant to a user in the customer’s own systems.
*/
public void setFilterByUserId(String filterByUserId) {
this.filterByUserId = filterByUserId;
}
/**
*
* Filters the response list to match the specified user ID. Only one of filterByUserId,
* filterByPublished, or filterByState can be provided per request. A userId
* is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the
* customer’s own systems.
*
*
* @return Filters the response list to match the specified user ID. Only one of filterByUserId,
* filterByPublished, or filterByState can be provided per request. A
* userId is a customer-assigned name to help identify the token; this can be used to link a
* participant to a user in the customer’s own systems.
*/
public String getFilterByUserId() {
return this.filterByUserId;
}
/**
*
* Filters the response list to match the specified user ID. Only one of filterByUserId,
* filterByPublished, or filterByState can be provided per request. A userId
* is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the
* customer’s own systems.
*
*
* @param filterByUserId
* Filters the response list to match the specified user ID. Only one of filterByUserId,
* filterByPublished, or filterByState can be provided per request. A
* userId is a customer-assigned name to help identify the token; this can be used to link a
* participant to a user in the customer’s own systems.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListParticipantsRequest withFilterByUserId(String filterByUserId) {
setFilterByUserId(filterByUserId);
return this;
}
/**
*
* Maximum number of results to return. Default: 50.
*
*
* @param maxResults
* Maximum number of results to return. Default: 50.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* Maximum number of results to return. Default: 50.
*
*
* @return Maximum number of results to return. Default: 50.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* Maximum number of results to return. Default: 50.
*
*
* @param maxResults
* Maximum number of results to return. Default: 50.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListParticipantsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The first participant to retrieve. This is used for pagination; see the nextToken response field.
*
*
* @param nextToken
* The first participant to retrieve. This is used for pagination; see the nextToken response
* field.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The first participant to retrieve. This is used for pagination; see the nextToken response field.
*
*
* @return The first participant to retrieve. This is used for pagination; see the nextToken response
* field.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The first participant to retrieve. This is used for pagination; see the nextToken response field.
*
*
* @param nextToken
* The first participant to retrieve. This is used for pagination; see the nextToken response
* field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListParticipantsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* ID of the session within the stage.
*
*
* @param sessionId
* ID of the session within the stage.
*/
public void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
/**
*
* ID of the session within the stage.
*
*
* @return ID of the session within the stage.
*/
public String getSessionId() {
return this.sessionId;
}
/**
*
* ID of the session within the stage.
*
*
* @param sessionId
* ID of the session within the stage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListParticipantsRequest withSessionId(String sessionId) {
setSessionId(sessionId);
return this;
}
/**
*
* Stage ARN.
*
*
* @param stageArn
* Stage ARN.
*/
public void setStageArn(String stageArn) {
this.stageArn = stageArn;
}
/**
*
* Stage ARN.
*
*
* @return Stage ARN.
*/
public String getStageArn() {
return this.stageArn;
}
/**
*
* Stage ARN.
*
*
* @param stageArn
* Stage ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListParticipantsRequest withStageArn(String stageArn) {
setStageArn(stageArn);
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 (getFilterByPublished() != null)
sb.append("FilterByPublished: ").append(getFilterByPublished()).append(",");
if (getFilterByState() != null)
sb.append("FilterByState: ").append(getFilterByState()).append(",");
if (getFilterByUserId() != null)
sb.append("FilterByUserId: ").append(getFilterByUserId()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getSessionId() != null)
sb.append("SessionId: ").append(getSessionId()).append(",");
if (getStageArn() != null)
sb.append("StageArn: ").append(getStageArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListParticipantsRequest == false)
return false;
ListParticipantsRequest other = (ListParticipantsRequest) obj;
if (other.getFilterByPublished() == null ^ this.getFilterByPublished() == null)
return false;
if (other.getFilterByPublished() != null && other.getFilterByPublished().equals(this.getFilterByPublished()) == false)
return false;
if (other.getFilterByState() == null ^ this.getFilterByState() == null)
return false;
if (other.getFilterByState() != null && other.getFilterByState().equals(this.getFilterByState()) == false)
return false;
if (other.getFilterByUserId() == null ^ this.getFilterByUserId() == null)
return false;
if (other.getFilterByUserId() != null && other.getFilterByUserId().equals(this.getFilterByUserId()) == 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.getSessionId() == null ^ this.getSessionId() == null)
return false;
if (other.getSessionId() != null && other.getSessionId().equals(this.getSessionId()) == false)
return false;
if (other.getStageArn() == null ^ this.getStageArn() == null)
return false;
if (other.getStageArn() != null && other.getStageArn().equals(this.getStageArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilterByPublished() == null) ? 0 : getFilterByPublished().hashCode());
hashCode = prime * hashCode + ((getFilterByState() == null) ? 0 : getFilterByState().hashCode());
hashCode = prime * hashCode + ((getFilterByUserId() == null) ? 0 : getFilterByUserId().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getSessionId() == null) ? 0 : getSessionId().hashCode());
hashCode = prime * hashCode + ((getStageArn() == null) ? 0 : getStageArn().hashCode());
return hashCode;
}
@Override
public ListParticipantsRequest clone() {
return (ListParticipantsRequest) super.clone();
}
}