@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface GameSparksAsyncClient extends SdkClient
builder()
method.
| 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 GameSparksAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
GameSparksAsyncClient. |
static GameSparksAsyncClient |
create()
Create a
GameSparksAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateGameResponse> |
createGame(Consumer<CreateGameRequest.Builder> createGameRequest)
Creates a new game with an empty configuration.
|
default CompletableFuture<CreateGameResponse> |
createGame(CreateGameRequest createGameRequest)
Creates a new game with an empty configuration.
|
default CompletableFuture<CreateSnapshotResponse> |
createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a snapshot of the game configuration.
|
default CompletableFuture<CreateSnapshotResponse> |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of the game configuration.
|
default CompletableFuture<CreateStageResponse> |
createStage(Consumer<CreateStageRequest.Builder> createStageRequest)
Creates a new stage for stage-by-stage game development and deployment.
|
default CompletableFuture<CreateStageResponse> |
createStage(CreateStageRequest createStageRequest)
Creates a new stage for stage-by-stage game development and deployment.
|
default CompletableFuture<DeleteGameResponse> |
deleteGame(Consumer<DeleteGameRequest.Builder> deleteGameRequest)
Deletes a game.
|
default CompletableFuture<DeleteGameResponse> |
deleteGame(DeleteGameRequest deleteGameRequest)
Deletes a game.
|
default CompletableFuture<DeleteStageResponse> |
deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)
Deletes a stage from a game, along with the associated game runtime.
|
default CompletableFuture<DeleteStageResponse> |
deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a stage from a game, along with the associated game runtime.
|
default CompletableFuture<DisconnectPlayerResponse> |
disconnectPlayer(Consumer<DisconnectPlayerRequest.Builder> disconnectPlayerRequest)
Disconnects a player from the game runtime.
|
default CompletableFuture<DisconnectPlayerResponse> |
disconnectPlayer(DisconnectPlayerRequest disconnectPlayerRequest)
Disconnects a player from the game runtime.
|
default CompletableFuture<ExportSnapshotResponse> |
exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest)
Exports a game configuration snapshot.
|
default CompletableFuture<ExportSnapshotResponse> |
exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
Exports a game configuration snapshot.
|
default CompletableFuture<GetExtensionResponse> |
getExtension(Consumer<GetExtensionRequest.Builder> getExtensionRequest)
Gets details about a specified extension.
|
default CompletableFuture<GetExtensionResponse> |
getExtension(GetExtensionRequest getExtensionRequest)
Gets details about a specified extension.
|
default CompletableFuture<GetExtensionVersionResponse> |
getExtensionVersion(Consumer<GetExtensionVersionRequest.Builder> getExtensionVersionRequest)
Gets details about a specified extension version.
|
default CompletableFuture<GetExtensionVersionResponse> |
getExtensionVersion(GetExtensionVersionRequest getExtensionVersionRequest)
Gets details about a specified extension version.
|
default CompletableFuture<GetGameResponse> |
getGame(Consumer<GetGameRequest.Builder> getGameRequest)
Gets details about a game.
|
default CompletableFuture<GetGameResponse> |
getGame(GetGameRequest getGameRequest)
Gets details about a game.
|
default CompletableFuture<GetGameConfigurationResponse> |
getGameConfiguration(Consumer<GetGameConfigurationRequest.Builder> getGameConfigurationRequest)
Gets the configuration of the game.
|
default CompletableFuture<GetGameConfigurationResponse> |
getGameConfiguration(GetGameConfigurationRequest getGameConfigurationRequest)
Gets the configuration of the game.
|
default CompletableFuture<GetGeneratedCodeJobResponse> |
getGeneratedCodeJob(Consumer<GetGeneratedCodeJobRequest.Builder> getGeneratedCodeJobRequest)
Gets details about a job that is generating code for a snapshot.
|
default CompletableFuture<GetGeneratedCodeJobResponse> |
getGeneratedCodeJob(GetGeneratedCodeJobRequest getGeneratedCodeJobRequest)
Gets details about a job that is generating code for a snapshot.
|
default CompletableFuture<GetPlayerConnectionStatusResponse> |
getPlayerConnectionStatus(Consumer<GetPlayerConnectionStatusRequest.Builder> getPlayerConnectionStatusRequest)
Gets the status of a player's connection to the game runtime.
|
default CompletableFuture<GetPlayerConnectionStatusResponse> |
getPlayerConnectionStatus(GetPlayerConnectionStatusRequest getPlayerConnectionStatusRequest)
Gets the status of a player's connection to the game runtime.
|
default CompletableFuture<GetSnapshotResponse> |
getSnapshot(Consumer<GetSnapshotRequest.Builder> getSnapshotRequest)
Gets a copy of the game configuration in a snapshot.
|
default CompletableFuture<GetSnapshotResponse> |
getSnapshot(GetSnapshotRequest getSnapshotRequest)
Gets a copy of the game configuration in a snapshot.
|
default CompletableFuture<GetStageResponse> |
getStage(Consumer<GetStageRequest.Builder> getStageRequest)
Gets information about a stage.
|
default CompletableFuture<GetStageResponse> |
getStage(GetStageRequest getStageRequest)
Gets information about a stage.
|
default CompletableFuture<GetStageDeploymentResponse> |
getStageDeployment(Consumer<GetStageDeploymentRequest.Builder> getStageDeploymentRequest)
Gets information about a stage deployment.
|
default CompletableFuture<GetStageDeploymentResponse> |
getStageDeployment(GetStageDeploymentRequest getStageDeploymentRequest)
Gets information about a stage deployment.
|
default CompletableFuture<ImportGameConfigurationResponse> |
importGameConfiguration(Consumer<ImportGameConfigurationRequest.Builder> importGameConfigurationRequest)
Imports a game configuration.
|
default CompletableFuture<ImportGameConfigurationResponse> |
importGameConfiguration(ImportGameConfigurationRequest importGameConfigurationRequest)
Imports a game configuration.
|
default CompletableFuture<ListExtensionsResponse> |
listExtensions(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest)
Gets a paginated list of available extensions.
|
default CompletableFuture<ListExtensionsResponse> |
listExtensions(ListExtensionsRequest listExtensionsRequest)
Gets a paginated list of available extensions.
|
default ListExtensionsPublisher |
listExtensionsPaginator(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest)
Gets a paginated list of available extensions.
|
default ListExtensionsPublisher |
listExtensionsPaginator(ListExtensionsRequest listExtensionsRequest)
Gets a paginated list of available extensions.
|
default CompletableFuture<ListExtensionVersionsResponse> |
listExtensionVersions(Consumer<ListExtensionVersionsRequest.Builder> listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
|
default CompletableFuture<ListExtensionVersionsResponse> |
listExtensionVersions(ListExtensionVersionsRequest listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
|
default ListExtensionVersionsPublisher |
listExtensionVersionsPaginator(Consumer<ListExtensionVersionsRequest.Builder> listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
|
default ListExtensionVersionsPublisher |
listExtensionVersionsPaginator(ListExtensionVersionsRequest listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
|
default CompletableFuture<ListGamesResponse> |
listGames(Consumer<ListGamesRequest.Builder> listGamesRequest)
Gets a paginated list of games.
|
default CompletableFuture<ListGamesResponse> |
listGames(ListGamesRequest listGamesRequest)
Gets a paginated list of games.
|
default ListGamesPublisher |
listGamesPaginator(Consumer<ListGamesRequest.Builder> listGamesRequest)
Gets a paginated list of games.
|
default ListGamesPublisher |
listGamesPaginator(ListGamesRequest listGamesRequest)
Gets a paginated list of games.
|
default CompletableFuture<ListGeneratedCodeJobsResponse> |
listGeneratedCodeJobs(Consumer<ListGeneratedCodeJobsRequest.Builder> listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
|
default CompletableFuture<ListGeneratedCodeJobsResponse> |
listGeneratedCodeJobs(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
|
default ListGeneratedCodeJobsPublisher |
listGeneratedCodeJobsPaginator(Consumer<ListGeneratedCodeJobsRequest.Builder> listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
|
default ListGeneratedCodeJobsPublisher |
listGeneratedCodeJobsPaginator(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
|
default CompletableFuture<ListSnapshotsResponse> |
listSnapshots(Consumer<ListSnapshotsRequest.Builder> listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
|
default CompletableFuture<ListSnapshotsResponse> |
listSnapshots(ListSnapshotsRequest listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
|
default ListSnapshotsPublisher |
listSnapshotsPaginator(Consumer<ListSnapshotsRequest.Builder> listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
|
default ListSnapshotsPublisher |
listSnapshotsPaginator(ListSnapshotsRequest listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
|
default CompletableFuture<ListStageDeploymentsResponse> |
listStageDeployments(Consumer<ListStageDeploymentsRequest.Builder> listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
|
default CompletableFuture<ListStageDeploymentsResponse> |
listStageDeployments(ListStageDeploymentsRequest listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
|
default ListStageDeploymentsPublisher |
listStageDeploymentsPaginator(Consumer<ListStageDeploymentsRequest.Builder> listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
|
default ListStageDeploymentsPublisher |
listStageDeploymentsPaginator(ListStageDeploymentsRequest listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
|
default CompletableFuture<ListStagesResponse> |
listStages(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets a paginated list of stage summaries from the game.
|
default CompletableFuture<ListStagesResponse> |
listStages(ListStagesRequest listStagesRequest)
Gets a paginated list of stage summaries from the game.
|
default ListStagesPublisher |
listStagesPaginator(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets a paginated list of stage summaries from the game.
|
default ListStagesPublisher |
listStagesPaginator(ListStagesRequest listStagesRequest)
Gets a paginated list of stage summaries from the game.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags associated with a GameSparks resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with a GameSparks resource.
|
default CompletableFuture<StartGeneratedCodeJobResponse> |
startGeneratedCodeJob(Consumer<StartGeneratedCodeJobRequest.Builder> startGeneratedCodeJobRequest)
Starts an asynchronous process that generates client code for system-defined and custom messages.
|
default CompletableFuture<StartGeneratedCodeJobResponse> |
startGeneratedCodeJob(StartGeneratedCodeJobRequest startGeneratedCodeJobRequest)
Starts an asynchronous process that generates client code for system-defined and custom messages.
|
default CompletableFuture<StartStageDeploymentResponse> |
startStageDeployment(Consumer<StartStageDeploymentRequest.Builder> startStageDeploymentRequest)
Deploys a snapshot to the stage and creates a new game runtime.
|
default CompletableFuture<StartStageDeploymentResponse> |
startStageDeployment(StartStageDeploymentRequest startStageDeploymentRequest)
Deploys a snapshot to the stage and creates a new game runtime.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to a GameSparks resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a GameSparks resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a GameSparks resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a GameSparks resource.
|
default CompletableFuture<UpdateGameResponse> |
updateGame(Consumer<UpdateGameRequest.Builder> updateGameRequest)
Updates details of the game.
|
default CompletableFuture<UpdateGameResponse> |
updateGame(UpdateGameRequest updateGameRequest)
Updates details of the game.
|
default CompletableFuture<UpdateGameConfigurationResponse> |
updateGameConfiguration(Consumer<UpdateGameConfigurationRequest.Builder> updateGameConfigurationRequest)
Updates one or more sections of the game configuration.
|
default CompletableFuture<UpdateGameConfigurationResponse> |
updateGameConfiguration(UpdateGameConfigurationRequest updateGameConfigurationRequest)
Updates one or more sections of the game configuration.
|
default CompletableFuture<UpdateSnapshotResponse> |
updateSnapshot(Consumer<UpdateSnapshotRequest.Builder> updateSnapshotRequest)
Updates the metadata of a GameSparks snapshot.
|
default CompletableFuture<UpdateSnapshotResponse> |
updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)
Updates the metadata of a GameSparks snapshot.
|
default CompletableFuture<UpdateStageResponse> |
updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
Updates the metadata of a stage.
|
default CompletableFuture<UpdateStageResponse> |
updateStage(UpdateStageRequest updateStageRequest)
Updates the metadata of a stage.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static GameSparksAsyncClient create()
GameSparksAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static GameSparksAsyncClientBuilder builder()
GameSparksAsyncClient.default CompletableFuture<CreateGameResponse> createGame(CreateGameRequest createGameRequest)
Creates a new game with an empty configuration. After creating your game, you can update the configuration using
UpdateGameConfiguration or ImportGameConfiguration.
createGameRequest - default CompletableFuture<CreateGameResponse> createGame(Consumer<CreateGameRequest.Builder> createGameRequest)
Creates a new game with an empty configuration. After creating your game, you can update the configuration using
UpdateGameConfiguration or ImportGameConfiguration.
This is a convenience which creates an instance of the CreateGameRequest.Builder avoiding the need to
create one manually via CreateGameRequest.builder()
createGameRequest - A Consumer that will call methods on CreateGameRequest.Builder to create a request.default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of the game configuration.
createSnapshotRequest - default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a snapshot of the game configuration.
This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to
create one manually via CreateSnapshotRequest.builder()
createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request.default CompletableFuture<CreateStageResponse> createStage(CreateStageRequest createStageRequest)
Creates a new stage for stage-by-stage game development and deployment.
createStageRequest - default CompletableFuture<CreateStageResponse> createStage(Consumer<CreateStageRequest.Builder> createStageRequest)
Creates a new stage for stage-by-stage game development and deployment.
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<DeleteGameResponse> deleteGame(DeleteGameRequest deleteGameRequest)
Deletes a game.
deleteGameRequest - default CompletableFuture<DeleteGameResponse> deleteGame(Consumer<DeleteGameRequest.Builder> deleteGameRequest)
Deletes a game.
This is a convenience which creates an instance of the DeleteGameRequest.Builder avoiding the need to
create one manually via DeleteGameRequest.builder()
deleteGameRequest - A Consumer that will call methods on DeleteGameRequest.Builder to create a request.default CompletableFuture<DeleteStageResponse> deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a stage from a game, along with the associated game runtime.
deleteStageRequest - default CompletableFuture<DeleteStageResponse> deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)
Deletes a stage from a game, along with the associated game runtime.
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<DisconnectPlayerResponse> disconnectPlayer(DisconnectPlayerRequest disconnectPlayerRequest)
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
disconnectPlayerRequest - default CompletableFuture<DisconnectPlayerResponse> disconnectPlayer(Consumer<DisconnectPlayerRequest.Builder> disconnectPlayerRequest)
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
This is a convenience which creates an instance of the DisconnectPlayerRequest.Builder avoiding the need
to create one manually via DisconnectPlayerRequest.builder()
disconnectPlayerRequest - A Consumer that will call methods on DisconnectPlayerRequest.Builder to create a request.default CompletableFuture<ExportSnapshotResponse> exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
Exports a game configuration snapshot.
exportSnapshotRequest - default CompletableFuture<ExportSnapshotResponse> exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest)
Exports a game configuration snapshot.
This is a convenience which creates an instance of the ExportSnapshotRequest.Builder avoiding the need to
create one manually via ExportSnapshotRequest.builder()
exportSnapshotRequest - A Consumer that will call methods on ExportSnapshotRequest.Builder to create a request.default CompletableFuture<GetExtensionResponse> getExtension(GetExtensionRequest getExtensionRequest)
Gets details about a specified extension.
getExtensionRequest - default CompletableFuture<GetExtensionResponse> getExtension(Consumer<GetExtensionRequest.Builder> getExtensionRequest)
Gets details about a specified extension.
This is a convenience which creates an instance of the GetExtensionRequest.Builder avoiding the need to
create one manually via GetExtensionRequest.builder()
getExtensionRequest - A Consumer that will call methods on GetExtensionRequest.Builder to create a request.default CompletableFuture<GetExtensionVersionResponse> getExtensionVersion(GetExtensionVersionRequest getExtensionVersionRequest)
Gets details about a specified extension version.
getExtensionVersionRequest - default CompletableFuture<GetExtensionVersionResponse> getExtensionVersion(Consumer<GetExtensionVersionRequest.Builder> getExtensionVersionRequest)
Gets details about a specified extension version.
This is a convenience which creates an instance of the GetExtensionVersionRequest.Builder avoiding the
need to create one manually via GetExtensionVersionRequest.builder()
getExtensionVersionRequest - A Consumer that will call methods on GetExtensionVersionRequest.Builder to create a
request.default CompletableFuture<GetGameResponse> getGame(GetGameRequest getGameRequest)
Gets details about a game.
getGameRequest - default CompletableFuture<GetGameResponse> getGame(Consumer<GetGameRequest.Builder> getGameRequest)
Gets details about a game.
This is a convenience which creates an instance of the GetGameRequest.Builder avoiding the need to create
one manually via GetGameRequest.builder()
getGameRequest - A Consumer that will call methods on GetGameRequest.Builder to create a request.default CompletableFuture<GetGameConfigurationResponse> getGameConfiguration(GetGameConfigurationRequest getGameConfigurationRequest)
Gets the configuration of the game.
getGameConfigurationRequest - default CompletableFuture<GetGameConfigurationResponse> getGameConfiguration(Consumer<GetGameConfigurationRequest.Builder> getGameConfigurationRequest)
Gets the configuration of the game.
This is a convenience which creates an instance of the GetGameConfigurationRequest.Builder avoiding the
need to create one manually via GetGameConfigurationRequest.builder()
getGameConfigurationRequest - A Consumer that will call methods on GetGameConfigurationRequest.Builder to create a
request.default CompletableFuture<GetGeneratedCodeJobResponse> getGeneratedCodeJob(GetGeneratedCodeJobRequest getGeneratedCodeJobRequest)
Gets details about a job that is generating code for a snapshot.
getGeneratedCodeJobRequest - default CompletableFuture<GetGeneratedCodeJobResponse> getGeneratedCodeJob(Consumer<GetGeneratedCodeJobRequest.Builder> getGeneratedCodeJobRequest)
Gets details about a job that is generating code for a snapshot.
This is a convenience which creates an instance of the GetGeneratedCodeJobRequest.Builder avoiding the
need to create one manually via GetGeneratedCodeJobRequest.builder()
getGeneratedCodeJobRequest - A Consumer that will call methods on GetGeneratedCodeJobRequest.Builder to create a
request.default CompletableFuture<GetPlayerConnectionStatusResponse> getPlayerConnectionStatus(GetPlayerConnectionStatusRequest getPlayerConnectionStatusRequest)
Gets the status of a player's connection to the game runtime.
It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.
getPlayerConnectionStatusRequest - default CompletableFuture<GetPlayerConnectionStatusResponse> getPlayerConnectionStatus(Consumer<GetPlayerConnectionStatusRequest.Builder> getPlayerConnectionStatusRequest)
Gets the status of a player's connection to the game runtime.
It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.
This is a convenience which creates an instance of the GetPlayerConnectionStatusRequest.Builder avoiding
the need to create one manually via GetPlayerConnectionStatusRequest.builder()
getPlayerConnectionStatusRequest - A Consumer that will call methods on GetPlayerConnectionStatusRequest.Builder to create a
request.default CompletableFuture<GetSnapshotResponse> getSnapshot(GetSnapshotRequest getSnapshotRequest)
Gets a copy of the game configuration in a snapshot.
getSnapshotRequest - default CompletableFuture<GetSnapshotResponse> getSnapshot(Consumer<GetSnapshotRequest.Builder> getSnapshotRequest)
Gets a copy of the game configuration in a snapshot.
This is a convenience which creates an instance of the GetSnapshotRequest.Builder avoiding the need to
create one manually via GetSnapshotRequest.builder()
getSnapshotRequest - A Consumer that will call methods on GetSnapshotRequest.Builder to create a request.default CompletableFuture<GetStageResponse> getStage(GetStageRequest getStageRequest)
Gets information about a stage.
getStageRequest - default CompletableFuture<GetStageResponse> getStage(Consumer<GetStageRequest.Builder> getStageRequest)
Gets information about a 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<GetStageDeploymentResponse> getStageDeployment(GetStageDeploymentRequest getStageDeploymentRequest)
Gets information about a stage deployment.
getStageDeploymentRequest - default CompletableFuture<GetStageDeploymentResponse> getStageDeployment(Consumer<GetStageDeploymentRequest.Builder> getStageDeploymentRequest)
Gets information about a stage deployment.
This is a convenience which creates an instance of the GetStageDeploymentRequest.Builder avoiding the
need to create one manually via GetStageDeploymentRequest.builder()
getStageDeploymentRequest - A Consumer that will call methods on GetStageDeploymentRequest.Builder to create a
request.default CompletableFuture<ImportGameConfigurationResponse> importGameConfiguration(ImportGameConfigurationRequest importGameConfigurationRequest)
Imports a game configuration.
This operation replaces the current configuration of the game with the provided input. This is not a reversible
operation. If you want to preserve the previous configuration, use CreateSnapshot to make a new
snapshot before importing.
importGameConfigurationRequest - default CompletableFuture<ImportGameConfigurationResponse> importGameConfiguration(Consumer<ImportGameConfigurationRequest.Builder> importGameConfigurationRequest)
Imports a game configuration.
This operation replaces the current configuration of the game with the provided input. This is not a reversible
operation. If you want to preserve the previous configuration, use CreateSnapshot to make a new
snapshot before importing.
This is a convenience which creates an instance of the ImportGameConfigurationRequest.Builder avoiding
the need to create one manually via ImportGameConfigurationRequest.builder()
importGameConfigurationRequest - A Consumer that will call methods on ImportGameConfigurationRequest.Builder to create a
request.default CompletableFuture<ListExtensionVersionsResponse> listExtensionVersions(ListExtensionVersionsRequest listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.
listExtensionVersionsRequest - default CompletableFuture<ListExtensionVersionsResponse> listExtensionVersions(Consumer<ListExtensionVersionsRequest.Builder> listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.
This is a convenience which creates an instance of the ListExtensionVersionsRequest.Builder avoiding the
need to create one manually via ListExtensionVersionsRequest.builder()
listExtensionVersionsRequest - A Consumer that will call methods on ListExtensionVersionsRequest.Builder to create a
request.default ListExtensionVersionsPublisher listExtensionVersionsPaginator(ListExtensionVersionsRequest listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.
This is a variant of
listExtensionVersions(software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsRequest)
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.gamesparks.paginators.ListExtensionVersionsPublisher publisher = client.listExtensionVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListExtensionVersionsPublisher publisher = client.listExtensionVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsResponse 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
listExtensionVersions(software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsRequest)
operation.
listExtensionVersionsRequest - default ListExtensionVersionsPublisher listExtensionVersionsPaginator(Consumer<ListExtensionVersionsRequest.Builder> listExtensionVersionsRequest)
Gets a paginated list of available versions for the extension.
Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.
This is a variant of
listExtensionVersions(software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsRequest)
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.gamesparks.paginators.ListExtensionVersionsPublisher publisher = client.listExtensionVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListExtensionVersionsPublisher publisher = client.listExtensionVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsResponse 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
listExtensionVersions(software.amazon.awssdk.services.gamesparks.model.ListExtensionVersionsRequest)
operation.
This is a convenience which creates an instance of the ListExtensionVersionsRequest.Builder avoiding the
need to create one manually via ListExtensionVersionsRequest.builder()
listExtensionVersionsRequest - A Consumer that will call methods on ListExtensionVersionsRequest.Builder to create a
request.default CompletableFuture<ListExtensionsResponse> listExtensions(ListExtensionsRequest listExtensionsRequest)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
listExtensionsRequest - default CompletableFuture<ListExtensionsResponse> listExtensions(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
This is a convenience which creates an instance of the ListExtensionsRequest.Builder avoiding the need to
create one manually via ListExtensionsRequest.builder()
listExtensionsRequest - A Consumer that will call methods on ListExtensionsRequest.Builder to create a request.default ListExtensionsPublisher listExtensionsPaginator(ListExtensionsRequest listExtensionsRequest)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
This is a variant of
listExtensions(software.amazon.awssdk.services.gamesparks.model.ListExtensionsRequest) 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.gamesparks.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListExtensionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListExtensionsResponse 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
listExtensions(software.amazon.awssdk.services.gamesparks.model.ListExtensionsRequest) operation.
listExtensionsRequest - default ListExtensionsPublisher listExtensionsPaginator(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest)
Gets a paginated list of available extensions.
Extensions provide features that games can use from scripts.
This is a variant of
listExtensions(software.amazon.awssdk.services.gamesparks.model.ListExtensionsRequest) 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.gamesparks.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListExtensionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListExtensionsResponse 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
listExtensions(software.amazon.awssdk.services.gamesparks.model.ListExtensionsRequest) operation.
This is a convenience which creates an instance of the ListExtensionsRequest.Builder avoiding the need to
create one manually via ListExtensionsRequest.builder()
listExtensionsRequest - A Consumer that will call methods on ListExtensionsRequest.Builder to create a request.default CompletableFuture<ListGamesResponse> listGames(ListGamesRequest listGamesRequest)
Gets a paginated list of games.
listGamesRequest - default CompletableFuture<ListGamesResponse> listGames(Consumer<ListGamesRequest.Builder> listGamesRequest)
Gets a paginated list of games.
This is a convenience which creates an instance of the ListGamesRequest.Builder avoiding the need to
create one manually via ListGamesRequest.builder()
listGamesRequest - A Consumer that will call methods on ListGamesRequest.Builder to create a request.default ListGamesPublisher listGamesPaginator(ListGamesRequest listGamesRequest)
Gets a paginated list of games.
This is a variant of listGames(software.amazon.awssdk.services.gamesparks.model.ListGamesRequest)
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.gamesparks.paginators.ListGamesPublisher publisher = client.listGamesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListGamesPublisher publisher = client.listGamesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListGamesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListGamesResponse 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
listGames(software.amazon.awssdk.services.gamesparks.model.ListGamesRequest) operation.
listGamesRequest - default ListGamesPublisher listGamesPaginator(Consumer<ListGamesRequest.Builder> listGamesRequest)
Gets a paginated list of games.
This is a variant of listGames(software.amazon.awssdk.services.gamesparks.model.ListGamesRequest)
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.gamesparks.paginators.ListGamesPublisher publisher = client.listGamesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListGamesPublisher publisher = client.listGamesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListGamesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListGamesResponse 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
listGames(software.amazon.awssdk.services.gamesparks.model.ListGamesRequest) operation.
This is a convenience which creates an instance of the ListGamesRequest.Builder avoiding the need to
create one manually via ListGamesRequest.builder()
listGamesRequest - A Consumer that will call methods on ListGamesRequest.Builder to create a request.default CompletableFuture<ListGeneratedCodeJobsResponse> listGeneratedCodeJobs(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
listGeneratedCodeJobsRequest - default CompletableFuture<ListGeneratedCodeJobsResponse> listGeneratedCodeJobs(Consumer<ListGeneratedCodeJobsRequest.Builder> listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
This is a convenience which creates an instance of the ListGeneratedCodeJobsRequest.Builder avoiding the
need to create one manually via ListGeneratedCodeJobsRequest.builder()
listGeneratedCodeJobsRequest - A Consumer that will call methods on ListGeneratedCodeJobsRequest.Builder to create a
request.default ListGeneratedCodeJobsPublisher listGeneratedCodeJobsPaginator(ListGeneratedCodeJobsRequest listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
This is a variant of
listGeneratedCodeJobs(software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsRequest)
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.gamesparks.paginators.ListGeneratedCodeJobsPublisher publisher = client.listGeneratedCodeJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListGeneratedCodeJobsPublisher publisher = client.listGeneratedCodeJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsResponse 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
listGeneratedCodeJobs(software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsRequest)
operation.
listGeneratedCodeJobsRequest - default ListGeneratedCodeJobsPublisher listGeneratedCodeJobsPaginator(Consumer<ListGeneratedCodeJobsRequest.Builder> listGeneratedCodeJobsRequest)
Gets a paginated list of code generation jobs for a snapshot.
This is a variant of
listGeneratedCodeJobs(software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsRequest)
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.gamesparks.paginators.ListGeneratedCodeJobsPublisher publisher = client.listGeneratedCodeJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListGeneratedCodeJobsPublisher publisher = client.listGeneratedCodeJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsResponse 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
listGeneratedCodeJobs(software.amazon.awssdk.services.gamesparks.model.ListGeneratedCodeJobsRequest)
operation.
This is a convenience which creates an instance of the ListGeneratedCodeJobsRequest.Builder avoiding the
need to create one manually via ListGeneratedCodeJobsRequest.builder()
listGeneratedCodeJobsRequest - A Consumer that will call methods on ListGeneratedCodeJobsRequest.Builder to create a
request.default CompletableFuture<ListSnapshotsResponse> listSnapshots(ListSnapshotsRequest listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
listSnapshotsRequest - default CompletableFuture<ListSnapshotsResponse> listSnapshots(Consumer<ListSnapshotsRequest.Builder> listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
This is a convenience which creates an instance of the ListSnapshotsRequest.Builder avoiding the need to
create one manually via ListSnapshotsRequest.builder()
listSnapshotsRequest - A Consumer that will call methods on ListSnapshotsRequest.Builder to create a request.default ListSnapshotsPublisher listSnapshotsPaginator(ListSnapshotsRequest listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
This is a variant of
listSnapshots(software.amazon.awssdk.services.gamesparks.model.ListSnapshotsRequest) 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.gamesparks.paginators.ListSnapshotsPublisher publisher = client.listSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListSnapshotsPublisher publisher = client.listSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListSnapshotsResponse 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
listSnapshots(software.amazon.awssdk.services.gamesparks.model.ListSnapshotsRequest) operation.
listSnapshotsRequest - default ListSnapshotsPublisher listSnapshotsPaginator(Consumer<ListSnapshotsRequest.Builder> listSnapshotsRequest)
Gets a paginated list of snapshot summaries from the game.
This is a variant of
listSnapshots(software.amazon.awssdk.services.gamesparks.model.ListSnapshotsRequest) 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.gamesparks.paginators.ListSnapshotsPublisher publisher = client.listSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListSnapshotsPublisher publisher = client.listSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListSnapshotsResponse 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
listSnapshots(software.amazon.awssdk.services.gamesparks.model.ListSnapshotsRequest) operation.
This is a convenience which creates an instance of the ListSnapshotsRequest.Builder avoiding the need to
create one manually via ListSnapshotsRequest.builder()
listSnapshotsRequest - A Consumer that will call methods on ListSnapshotsRequest.Builder to create a request.default CompletableFuture<ListStageDeploymentsResponse> listStageDeployments(ListStageDeploymentsRequest listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
listStageDeploymentsRequest - default CompletableFuture<ListStageDeploymentsResponse> listStageDeployments(Consumer<ListStageDeploymentsRequest.Builder> listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
This is a convenience which creates an instance of the ListStageDeploymentsRequest.Builder avoiding the
need to create one manually via ListStageDeploymentsRequest.builder()
listStageDeploymentsRequest - A Consumer that will call methods on ListStageDeploymentsRequest.Builder to create a
request.default ListStageDeploymentsPublisher listStageDeploymentsPaginator(ListStageDeploymentsRequest listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
This is a variant of
listStageDeployments(software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsRequest)
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.gamesparks.paginators.ListStageDeploymentsPublisher publisher = client.listStageDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListStageDeploymentsPublisher publisher = client.listStageDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsResponse 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
listStageDeployments(software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsRequest)
operation.
listStageDeploymentsRequest - default ListStageDeploymentsPublisher listStageDeploymentsPaginator(Consumer<ListStageDeploymentsRequest.Builder> listStageDeploymentsRequest)
Gets a paginated list of stage deployment summaries from the game.
This is a variant of
listStageDeployments(software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsRequest)
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.gamesparks.paginators.ListStageDeploymentsPublisher publisher = client.listStageDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.gamesparks.paginators.ListStageDeploymentsPublisher publisher = client.listStageDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsResponse 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
listStageDeployments(software.amazon.awssdk.services.gamesparks.model.ListStageDeploymentsRequest)
operation.
This is a convenience which creates an instance of the ListStageDeploymentsRequest.Builder avoiding the
need to create one manually via ListStageDeploymentsRequest.builder()
listStageDeploymentsRequest - A Consumer that will call methods on ListStageDeploymentsRequest.Builder to create a
request.default CompletableFuture<ListStagesResponse> listStages(ListStagesRequest listStagesRequest)
Gets a paginated list of stage summaries from the game.
listStagesRequest - default CompletableFuture<ListStagesResponse> listStages(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets a paginated list of stage summaries from the game.
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 a paginated list of stage summaries from the game.
This is a variant of listStages(software.amazon.awssdk.services.gamesparks.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.gamesparks.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.gamesparks.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListStagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.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.gamesparks.model.ListStagesRequest) operation.
listStagesRequest - default ListStagesPublisher listStagesPaginator(Consumer<ListStagesRequest.Builder> listStagesRequest)
Gets a paginated list of stage summaries from the game.
This is a variant of listStages(software.amazon.awssdk.services.gamesparks.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.gamesparks.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.gamesparks.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamesparks.model.ListStagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.gamesparks.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.gamesparks.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)
Lists the tags associated with a GameSparks resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags associated with a GameSparks resource.
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<StartGeneratedCodeJobResponse> startGeneratedCodeJob(StartGeneratedCodeJobRequest startGeneratedCodeJobRequest)
Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.
startGeneratedCodeJobRequest - default CompletableFuture<StartGeneratedCodeJobResponse> startGeneratedCodeJob(Consumer<StartGeneratedCodeJobRequest.Builder> startGeneratedCodeJobRequest)
Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.
This is a convenience which creates an instance of the StartGeneratedCodeJobRequest.Builder avoiding the
need to create one manually via StartGeneratedCodeJobRequest.builder()
startGeneratedCodeJobRequest - A Consumer that will call methods on StartGeneratedCodeJobRequest.Builder to create a
request.default CompletableFuture<StartStageDeploymentResponse> startStageDeployment(StartStageDeploymentRequest startStageDeploymentRequest)
Deploys a snapshot to the stage and creates a new game runtime.
After you call this operation, you can check the deployment status by using GetStageDeployment.
If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.
startStageDeploymentRequest - default CompletableFuture<StartStageDeploymentResponse> startStageDeployment(Consumer<StartStageDeploymentRequest.Builder> startStageDeploymentRequest)
Deploys a snapshot to the stage and creates a new game runtime.
After you call this operation, you can check the deployment status by using GetStageDeployment.
If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.
This is a convenience which creates an instance of the StartStageDeploymentRequest.Builder avoiding the
need to create one manually via StartStageDeploymentRequest.builder()
startStageDeploymentRequest - A Consumer that will call methods on StartStageDeploymentRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a GameSparks resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to a GameSparks resource.
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 a GameSparks resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a GameSparks resource.
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<UpdateGameResponse> updateGame(UpdateGameRequest updateGameRequest)
Updates details of the game.
updateGameRequest - default CompletableFuture<UpdateGameResponse> updateGame(Consumer<UpdateGameRequest.Builder> updateGameRequest)
Updates details of the game.
This is a convenience which creates an instance of the UpdateGameRequest.Builder avoiding the need to
create one manually via UpdateGameRequest.builder()
updateGameRequest - A Consumer that will call methods on UpdateGameRequest.Builder to create a request.default CompletableFuture<UpdateGameConfigurationResponse> updateGameConfiguration(UpdateGameConfigurationRequest updateGameConfigurationRequest)
Updates one or more sections of the game configuration.
updateGameConfigurationRequest - default CompletableFuture<UpdateGameConfigurationResponse> updateGameConfiguration(Consumer<UpdateGameConfigurationRequest.Builder> updateGameConfigurationRequest)
Updates one or more sections of the game configuration.
This is a convenience which creates an instance of the UpdateGameConfigurationRequest.Builder avoiding
the need to create one manually via UpdateGameConfigurationRequest.builder()
updateGameConfigurationRequest - A Consumer that will call methods on UpdateGameConfigurationRequest.Builder to create a
request.default CompletableFuture<UpdateSnapshotResponse> updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)
Updates the metadata of a GameSparks snapshot.
updateSnapshotRequest - default CompletableFuture<UpdateSnapshotResponse> updateSnapshot(Consumer<UpdateSnapshotRequest.Builder> updateSnapshotRequest)
Updates the metadata of a GameSparks snapshot.
This is a convenience which creates an instance of the UpdateSnapshotRequest.Builder avoiding the need to
create one manually via UpdateSnapshotRequest.builder()
updateSnapshotRequest - A Consumer that will call methods on UpdateSnapshotRequest.Builder to create a request.default CompletableFuture<UpdateStageResponse> updateStage(UpdateStageRequest updateStageRequest)
Updates the metadata of a stage.
updateStageRequest - default CompletableFuture<UpdateStageResponse> updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
Updates the metadata of a stage.
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.Copyright © 2022. All rights reserved.