@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IvsRealTimeAsyncClient extends AwsClient
builder()
method.
Introduction
The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Terminology:
A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID There is a 1:1 mapping between participant tokens and participants.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
Stage — A stage is a virtual space where participants can exchange video in real time.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value,
both set by you. For example, you might set a tag as topic:nature to label a particular video category.
See Tagging AWS Resources for more
information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages
has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
Stages Endpoints
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static IvsRealTimeAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
IvsRealTimeAsyncClient. |
static IvsRealTimeAsyncClient |
create()
Create a
IvsRealTimeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateParticipantTokenResponse> |
createParticipantToken(Consumer<CreateParticipantTokenRequest.Builder> createParticipantTokenRequest)
Creates an additional token for a specified stage.
|
default CompletableFuture<CreateParticipantTokenResponse> |
createParticipantToken(CreateParticipantTokenRequest createParticipantTokenRequest)
Creates an additional token for a specified stage.
|
default CompletableFuture<CreateStageResponse> |
createStage(Consumer<CreateStageRequest.Builder> createStageRequest)
Creates a new stage (and optionally participant tokens).
|
default CompletableFuture<CreateStageResponse> |
createStage(CreateStageRequest createStageRequest)
Creates a new stage (and optionally participant tokens).
|
default CompletableFuture<DeleteStageResponse> |
deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
|
default CompletableFuture<DeleteStageResponse> |
deleteStage(DeleteStageRequest deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
|
default CompletableFuture<DisconnectParticipantResponse> |
disconnectParticipant(Consumer<DisconnectParticipantRequest.Builder> disconnectParticipantRequest)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
|
default CompletableFuture<DisconnectParticipantResponse> |
disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
|
default CompletableFuture<GetParticipantResponse> |
getParticipant(Consumer<GetParticipantRequest.Builder> getParticipantRequest)
Gets information about the specified participant token.
|
default CompletableFuture<GetParticipantResponse> |
getParticipant(GetParticipantRequest getParticipantRequest)
Gets information about the specified participant token.
|
default CompletableFuture<GetStageResponse> |
getStage(Consumer<GetStageRequest.Builder> getStageRequest)
Gets information for the specified stage.
|
default CompletableFuture<GetStageResponse> |
getStage(GetStageRequest getStageRequest)
Gets information for the specified stage.
|
default CompletableFuture<GetStageSessionResponse> |
getStageSession(Consumer<GetStageSessionRequest.Builder> getStageSessionRequest)
Gets information for the specified stage session.
|
default CompletableFuture<GetStageSessionResponse> |
getStageSession(GetStageSessionRequest getStageSessionRequest)
Gets information for the specified stage session.
|
default CompletableFuture<ListParticipantEventsResponse> |
listParticipantEvents(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
|
default CompletableFuture<ListParticipantEventsResponse> |
listParticipantEvents(ListParticipantEventsRequest listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
|
default ListParticipantEventsPublisher |
listParticipantEventsPaginator(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
|
default ListParticipantEventsPublisher |
listParticipantEventsPaginator(ListParticipantEventsRequest listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
|
default CompletableFuture<ListParticipantsResponse> |
listParticipants(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest)
Lists all participants in a specified stage session.
|
default CompletableFuture<ListParticipantsResponse> |
listParticipants(ListParticipantsRequest listParticipantsRequest)
Lists all participants in a specified stage session.
|
default ListParticipantsPublisher |
listParticipantsPaginator(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest)
Lists all participants in a specified stage session.
|
default ListParticipantsPublisher |
listParticipantsPaginator(ListParticipantsRequest listParticipantsRequest)
Lists all participants in a specified stage session.
|
default CompletableFuture<ListStagesResponse> |
listStages(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
|
default CompletableFuture<ListStagesResponse> |
listStages(ListStagesRequest listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
|
default CompletableFuture<ListStageSessionsResponse> |
listStageSessions(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest)
Gets all sessions for a specified stage.
|
default CompletableFuture<ListStageSessionsResponse> |
listStageSessions(ListStageSessionsRequest listStageSessionsRequest)
Gets all sessions for a specified stage.
|
default ListStageSessionsPublisher |
listStageSessionsPaginator(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest)
Gets all sessions for a specified stage.
|
default ListStageSessionsPublisher |
listStageSessionsPaginator(ListStageSessionsRequest listStageSessionsRequest)
Gets all sessions for a specified stage.
|
default ListStagesPublisher |
listStagesPaginator(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
|
default ListStagesPublisher |
listStagesPaginator(ListStagesRequest listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default IvsRealTimeServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
default CompletableFuture<UpdateStageResponse> |
updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
Updates a stage’s configuration.
|
default CompletableFuture<UpdateStageResponse> |
updateStage(UpdateStageRequest updateStageRequest)
Updates a stage’s configuration.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateParticipantTokenResponse> createParticipantToken(CreateParticipantTokenRequest createParticipantTokenRequest)
Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
createParticipantTokenRequest - default CompletableFuture<CreateParticipantTokenResponse> createParticipantToken(Consumer<CreateParticipantTokenRequest.Builder> createParticipantTokenRequest)
Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
This is a convenience which creates an instance of the CreateParticipantTokenRequest.Builder avoiding the
need to create one manually via CreateParticipantTokenRequest.builder()
createParticipantTokenRequest - A Consumer that will call methods on
CreateParticipantTokenRequest.Builder to create
a request.default CompletableFuture<CreateStageResponse> createStage(CreateStageRequest createStageRequest)
Creates a new stage (and optionally participant tokens).
createStageRequest - default CompletableFuture<CreateStageResponse> createStage(Consumer<CreateStageRequest.Builder> createStageRequest)
Creates a new stage (and optionally participant tokens).
This is a convenience which creates an instance of the CreateStageRequest.Builder avoiding the need to
create one manually via CreateStageRequest.builder()
createStageRequest - A Consumer that will call methods on
CreateStageRequest.Builder to create a request.default CompletableFuture<DeleteStageResponse> deleteStage(DeleteStageRequest deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
deleteStageRequest - default CompletableFuture<DeleteStageResponse> deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
This is a convenience which creates an instance of the DeleteStageRequest.Builder avoiding the need to
create one manually via DeleteStageRequest.builder()
deleteStageRequest - A Consumer that will call methods on
DeleteStageRequest.Builder to create a request.default CompletableFuture<DisconnectParticipantResponse> disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantRequest - default CompletableFuture<DisconnectParticipantResponse> disconnectParticipant(Consumer<DisconnectParticipantRequest.Builder> disconnectParticipantRequest)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
This is a convenience which creates an instance of the DisconnectParticipantRequest.Builder avoiding the
need to create one manually via DisconnectParticipantRequest.builder()
disconnectParticipantRequest - A Consumer that will call methods on
DisconnectParticipantRequest.Builder to create a
request.default CompletableFuture<GetParticipantResponse> getParticipant(GetParticipantRequest getParticipantRequest)
Gets information about the specified participant token.
getParticipantRequest - default CompletableFuture<GetParticipantResponse> getParticipant(Consumer<GetParticipantRequest.Builder> getParticipantRequest)
Gets information about the specified participant token.
This is a convenience which creates an instance of the GetParticipantRequest.Builder avoiding the need to
create one manually via GetParticipantRequest.builder()
getParticipantRequest - A Consumer that will call methods on
GetParticipantRequest.Builder to create a
request.default CompletableFuture<GetStageResponse> getStage(GetStageRequest getStageRequest)
Gets information for the specified stage.
getStageRequest - default CompletableFuture<GetStageResponse> getStage(Consumer<GetStageRequest.Builder> getStageRequest)
Gets information for the specified stage.
This is a convenience which creates an instance of the GetStageRequest.Builder avoiding the need to
create one manually via GetStageRequest.builder()
getStageRequest - A Consumer that will call methods on
GetStageRequest.Builder to create a request.default CompletableFuture<GetStageSessionResponse> getStageSession(GetStageSessionRequest getStageSessionRequest)
Gets information for the specified stage session.
getStageSessionRequest - default CompletableFuture<GetStageSessionResponse> getStageSession(Consumer<GetStageSessionRequest.Builder> getStageSessionRequest)
Gets information for the specified stage session.
This is a convenience which creates an instance of the GetStageSessionRequest.Builder avoiding the need
to create one manually via GetStageSessionRequest.builder()
getStageSessionRequest - A Consumer that will call methods on
GetStageSessionRequest.Builder to create a
request.default CompletableFuture<ListParticipantEventsResponse> listParticipantEvents(ListParticipantEventsRequest listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
listParticipantEventsRequest - default CompletableFuture<ListParticipantEventsResponse> listParticipantEvents(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
This is a convenience which creates an instance of the ListParticipantEventsRequest.Builder avoiding the
need to create one manually via ListParticipantEventsRequest.builder()
listParticipantEventsRequest - A Consumer that will call methods on
ListParticipantEventsRequest.Builder to create a
request.default ListParticipantEventsPublisher listParticipantEventsPaginator(ListParticipantEventsRequest listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
This is a variant of
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.
listParticipantEventsRequest - default ListParticipantEventsPublisher listParticipantEventsPaginator(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
This is a variant of
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.
This is a convenience which creates an instance of the ListParticipantEventsRequest.Builder avoiding the
need to create one manually via ListParticipantEventsRequest.builder()
listParticipantEventsRequest - A Consumer that will call methods on
ListParticipantEventsRequest.Builder to create a
request.default CompletableFuture<ListParticipantsResponse> listParticipants(ListParticipantsRequest listParticipantsRequest)
Lists all participants in a specified stage session.
listParticipantsRequest - default CompletableFuture<ListParticipantsResponse> listParticipants(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest)
Lists all participants in a specified stage session.
This is a convenience which creates an instance of the ListParticipantsRequest.Builder avoiding the need
to create one manually via ListParticipantsRequest.builder()
listParticipantsRequest - A Consumer that will call methods on
ListParticipantsRequest.Builder to create a
request.default ListParticipantsPublisher listParticipantsPaginator(ListParticipantsRequest listParticipantsRequest)
Lists all participants in a specified stage session.
This is a variant of
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.
listParticipantsRequest - default ListParticipantsPublisher listParticipantsPaginator(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest)
Lists all participants in a specified stage session.
This is a variant of
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.
This is a convenience which creates an instance of the ListParticipantsRequest.Builder avoiding the need
to create one manually via ListParticipantsRequest.builder()
listParticipantsRequest - A Consumer that will call methods on
ListParticipantsRequest.Builder to create a
request.default CompletableFuture<ListStageSessionsResponse> listStageSessions(ListStageSessionsRequest listStageSessionsRequest)
Gets all sessions for a specified stage.
listStageSessionsRequest - default CompletableFuture<ListStageSessionsResponse> listStageSessions(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest)
Gets all sessions for a specified stage.
This is a convenience which creates an instance of the ListStageSessionsRequest.Builder avoiding the need
to create one manually via ListStageSessionsRequest.builder()
listStageSessionsRequest - A Consumer that will call methods on
ListStageSessionsRequest.Builder to create a
request.default ListStageSessionsPublisher listStageSessionsPaginator(ListStageSessionsRequest listStageSessionsRequest)
Gets all sessions for a specified stage.
This is a variant of
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.
listStageSessionsRequest - default ListStageSessionsPublisher listStageSessionsPaginator(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest)
Gets all sessions for a specified stage.
This is a variant of
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.
This is a convenience which creates an instance of the ListStageSessionsRequest.Builder avoiding the need
to create one manually via ListStageSessionsRequest.builder()
listStageSessionsRequest - A Consumer that will call methods on
ListStageSessionsRequest.Builder to create a
request.default CompletableFuture<ListStagesResponse> listStages(ListStagesRequest listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesRequest - default CompletableFuture<ListStagesResponse> listStages(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the ListStagesRequest.Builder avoiding the need to
create one manually via ListStagesRequest.builder()
listStagesRequest - A Consumer that will call methods on
ListStagesRequest.Builder to create a request.default ListStagesPublisher listStagesPaginator(ListStagesRequest listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
This is a variant of listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest) operation.
listStagesRequest - default ListStagesPublisher listStagesPaginator(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
This is a variant of listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest) operation.
This is a convenience which creates an instance of the ListStagesRequest.Builder avoiding the need to
create one manually via ListStagesRequest.builder()
listStagesRequest - A Consumer that will call methods on
ListStagesRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource with the specified ARN.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.default CompletableFuture<UpdateStageResponse> updateStage(UpdateStageRequest updateStageRequest)
Updates a stage’s configuration.
updateStageRequest - default CompletableFuture<UpdateStageResponse> updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
Updates a stage’s configuration.
This is a convenience which creates an instance of the UpdateStageRequest.Builder avoiding the need to
create one manually via UpdateStageRequest.builder()
updateStageRequest - A Consumer that will call methods on
UpdateStageRequest.Builder to create a request.default IvsRealTimeServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic IvsRealTimeAsyncClient create()
IvsRealTimeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IvsRealTimeAsyncClientBuilder builder()
IvsRealTimeAsyncClient.Copyright © 2023. All rights reserved.