Class ListParticipantsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ivsrealtime.model.IvsRealTimeRequest
software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListParticipantsRequest extends IvsRealTimeRequest implements ToCopyableBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>

  • Method Details

    • stageArn

      public final String stageArn()

      Stage ARN.

      Returns:
      Stage ARN.

    • sessionId

      public final String sessionId()

      ID of the session within the stage.

      Returns:
      ID of the session within the stage.

    • filterByUserId

      public final String filterByUserId()

      Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState 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.

      Returns:
      Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState 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.

    • filterByPublished

      public final Boolean filterByPublished()

      Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

      Returns:
      Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

    • filterByState

      public final ParticipantState filterByState()

      Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

      If the service returns an enum value that is not available in the current SDK version, filterByState will return ParticipantState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByStateAsString().

      Returns:
      Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
      See Also:

    • filterByStateAsString

      public final String filterByStateAsString()

      Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

      If the service returns an enum value that is not available in the current SDK version, filterByState will return ParticipantState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByStateAsString().

      Returns:
      Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
      See Also:

    • nextToken

      public final String nextToken()

      The first participant to retrieve. This is used for pagination; see the nextToken response field.

      Returns:
      The first participant to retrieve. This is used for pagination; see the nextToken response field.

    • maxResults

      public final Integer maxResults()

      Maximum number of results to return. Default: 50.

      Returns:
      Maximum number of results to return. Default: 50.

    • filterByRecordingState

      public final ParticipantRecordingFilterByRecordingState filterByRecordingState()

      Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

      If the service returns an enum value that is not available in the current SDK version, filterByRecordingState will return ParticipantRecordingFilterByRecordingState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByRecordingStateAsString().

      Returns:
      Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
      See Also:

    • filterByRecordingStateAsString

      public final String filterByRecordingStateAsString()

      Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

      If the service returns an enum value that is not available in the current SDK version, filterByRecordingState will return ParticipantRecordingFilterByRecordingState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByRecordingStateAsString().

      Returns:
      Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
      See Also:

    • toBuilder

      public ListParticipantsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>
      Specified by:
      toBuilder in class IvsRealTimeRequest
      Returns:
      a builder for type T

    • builder

      public static ListParticipantsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListParticipantsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.