AbstractAWSGameSparks (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamesparks.AbstractAWSGameSparks

All Implemented Interfaces:

AWSGameSparks

Direct Known Subclasses:

AbstractAWSGameSparksAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSGameSparks
extends Object
implements AWSGameSparks
```
Abstract implementation of AWSGameSparks. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.gamesparks.AWSGameSparks
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateGameResult`	`createGame(CreateGameRequest request)` Creates a new game with an empty configuration.
`CreateSnapshotResult`	`createSnapshot(CreateSnapshotRequest request)` Creates a snapshot of the game configuration.
`CreateStageResult`	`createStage(CreateStageRequest request)` Creates a new stage for stage-by-stage game development and deployment.
`DeleteGameResult`	`deleteGame(DeleteGameRequest request)` Deletes a game.
`DeleteStageResult`	`deleteStage(DeleteStageRequest request)` Deletes a stage from a game, along with the associated game runtime.
`DisconnectPlayerResult`	`disconnectPlayer(DisconnectPlayerRequest request)` Disconnects a player from the game runtime.
`ExportSnapshotResult`	`exportSnapshot(ExportSnapshotRequest request)` Exports a game configuration snapshot.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetExtensionResult`	`getExtension(GetExtensionRequest request)` Gets details about a specified extension.
`GetExtensionVersionResult`	`getExtensionVersion(GetExtensionVersionRequest request)` Gets details about a specified extension version.
`GetGameResult`	`getGame(GetGameRequest request)` Gets details about a game.
`GetGameConfigurationResult`	`getGameConfiguration(GetGameConfigurationRequest request)` Gets the configuration of the game.
`GetGeneratedCodeJobResult`	`getGeneratedCodeJob(GetGeneratedCodeJobRequest request)` Gets details about a job that is generating code for a snapshot.
`GetPlayerConnectionStatusResult`	`getPlayerConnectionStatus(GetPlayerConnectionStatusRequest request)` Gets the status of a player's connection to the game runtime.
`GetSnapshotResult`	`getSnapshot(GetSnapshotRequest request)` Gets a copy of the game configuration in a snapshot.
`GetStageResult`	`getStage(GetStageRequest request)` Gets information about a stage.
`GetStageDeploymentResult`	`getStageDeployment(GetStageDeploymentRequest request)` Gets information about a stage deployment.
`ImportGameConfigurationResult`	`importGameConfiguration(ImportGameConfigurationRequest request)` Imports a game configuration.
`ListExtensionsResult`	`listExtensions(ListExtensionsRequest request)` Gets a paginated list of available extensions.
`ListExtensionVersionsResult`	`listExtensionVersions(ListExtensionVersionsRequest request)` Gets a paginated list of available versions for the extension.
`ListGamesResult`	`listGames(ListGamesRequest request)` Gets a paginated list of games.
`ListGeneratedCodeJobsResult`	`listGeneratedCodeJobs(ListGeneratedCodeJobsRequest request)` Gets a paginated list of code generation jobs for a snapshot.
`ListSnapshotsResult`	`listSnapshots(ListSnapshotsRequest request)` Gets a paginated list of snapshot summaries from the game.
`ListStageDeploymentsResult`	`listStageDeployments(ListStageDeploymentsRequest request)` Gets a paginated list of stage deployment summaries from the game.
`ListStagesResult`	`listStages(ListStagesRequest request)` Gets a paginated list of stage summaries from the game.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags associated with a GameSparks resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartGeneratedCodeJobResult`	`startGeneratedCodeJob(StartGeneratedCodeJobRequest request)` Starts an asynchronous process that generates client code for system-defined and custom messages.
`StartStageDeploymentResult`	`startStageDeployment(StartStageDeploymentRequest request)` Deploys a snapshot to the stage and creates a new game runtime.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds tags to a GameSparks resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from a GameSparks resource.
`UpdateGameResult`	`updateGame(UpdateGameRequest request)` Updates details of the game.
`UpdateGameConfigurationResult`	`updateGameConfiguration(UpdateGameConfigurationRequest request)` Updates one or more sections of the game configuration.
`UpdateSnapshotResult`	`updateSnapshot(UpdateSnapshotRequest request)` Updates the metadata of a GameSparks snapshot.
`UpdateStageResult`	`updateStage(UpdateStageRequest request)` Updates the metadata of a stage.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createGame
```
public CreateGameResult createGame(CreateGameRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Creates a new game with an empty configuration. After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration.
    
    Specified by:
    
    createGame in interface AWSGameSparks
    
    Returns:
    
    Result of the CreateGame operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSnapshot
```
public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Creates a snapshot of the game configuration.
    
    Specified by:
    
    createSnapshot in interface AWSGameSparks
    
    Returns:
    
    Result of the CreateSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStage
```
public CreateStageResult createStage(CreateStageRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Creates a new stage for stage-by-stage game development and deployment.
    
    Specified by:
    
    createStage in interface AWSGameSparks
    
    Returns:
    
    Result of the CreateStage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGame
```
public DeleteGameResult deleteGame(DeleteGameRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Deletes a game.
    
    Specified by:
    
    deleteGame in interface AWSGameSparks
    
    Returns:
    
    Result of the DeleteGame operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStage
```
public DeleteStageResult deleteStage(DeleteStageRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Deletes a stage from a game, along with the associated game runtime.
    
    Specified by:
    
    deleteStage in interface AWSGameSparks
    
    Returns:
    
    Result of the DeleteStage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disconnectPlayer
```
public DisconnectPlayerResult disconnectPlayer(DisconnectPlayerRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Disconnects a player from the game runtime.
    
    If a player has multiple connections, this operation attempts to close all of them.
    
    Specified by:
    
    disconnectPlayer in interface AWSGameSparks
    
    Returns:
    
    Result of the DisconnectPlayer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportSnapshot
```
public ExportSnapshotResult exportSnapshot(ExportSnapshotRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Exports a game configuration snapshot.
    
    Specified by:
    
    exportSnapshot in interface AWSGameSparks
    
    Returns:
    
    Result of the ExportSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getExtension
```
public GetExtensionResult getExtension(GetExtensionRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets details about a specified extension.
    
    Specified by:
    
    getExtension in interface AWSGameSparks
    
    Returns:
    
    Result of the GetExtension operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getExtensionVersion
```
public GetExtensionVersionResult getExtensionVersion(GetExtensionVersionRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets details about a specified extension version.
    
    Specified by:
    
    getExtensionVersion in interface AWSGameSparks
    
    Returns:
    
    Result of the GetExtensionVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGame
```
public GetGameResult getGame(GetGameRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets details about a game.
    
    Specified by:
    
    getGame in interface AWSGameSparks
    
    Returns:
    
    Result of the GetGame operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGameConfiguration
```
public GetGameConfigurationResult getGameConfiguration(GetGameConfigurationRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets the configuration of the game.
    
    Specified by:
    
    getGameConfiguration in interface AWSGameSparks
    
    Returns:
    
    Result of the GetGameConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGeneratedCodeJob
```
public GetGeneratedCodeJobResult getGeneratedCodeJob(GetGeneratedCodeJobRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets details about a job that is generating code for a snapshot.
    
    Specified by:
    
    getGeneratedCodeJob in interface AWSGameSparks
    
    Returns:
    
    Result of the GetGeneratedCodeJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPlayerConnectionStatus
```
public GetPlayerConnectionStatusResult getPlayerConnectionStatus(GetPlayerConnectionStatusRequest request)
```
    Description copied from interface: AWSGameSparks
    
    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.
    
    Specified by:
    
    getPlayerConnectionStatus in interface AWSGameSparks
    
    Returns:
    
    Result of the GetPlayerConnectionStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSnapshot
```
public GetSnapshotResult getSnapshot(GetSnapshotRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets a copy of the game configuration in a snapshot.
    
    Specified by:
    
    getSnapshot in interface AWSGameSparks
    
    Returns:
    
    Result of the GetSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getStage
```
public GetStageResult getStage(GetStageRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets information about a stage.
    
    Specified by:
    
    getStage in interface AWSGameSparks
    
    Returns:
    
    Result of the GetStage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getStageDeployment
```
public GetStageDeploymentResult getStageDeployment(GetStageDeploymentRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets information about a stage deployment.
    
    Specified by:
    
    getStageDeployment in interface AWSGameSparks
    
    Returns:
    
    Result of the GetStageDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importGameConfiguration
```
public ImportGameConfigurationResult importGameConfiguration(ImportGameConfigurationRequest request)
```
    Description copied from interface: AWSGameSparks
    
    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.
    
    Specified by:
    
    importGameConfiguration in interface AWSGameSparks
    
    Returns:
    
    Result of the ImportGameConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExtensionVersions
```
public ListExtensionVersionsResult listExtensionVersions(ListExtensionVersionsRequest request)
```
    Description copied from interface: AWSGameSparks
    
    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.
    
    Specified by:
    
    listExtensionVersions in interface AWSGameSparks
    
    Returns:
    
    Result of the ListExtensionVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExtensions
```
public ListExtensionsResult listExtensions(ListExtensionsRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets a paginated list of available extensions.
    
    Extensions provide features that games can use from scripts.
    
    Specified by:
    
    listExtensions in interface AWSGameSparks
    
    Returns:
    
    Result of the ListExtensions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGames
```
public ListGamesResult listGames(ListGamesRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets a paginated list of games.
    
    Specified by:
    
    listGames in interface AWSGameSparks
    
    Returns:
    
    Result of the ListGames operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGeneratedCodeJobs
```
public ListGeneratedCodeJobsResult listGeneratedCodeJobs(ListGeneratedCodeJobsRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets a paginated list of code generation jobs for a snapshot.
    
    Specified by:
    
    listGeneratedCodeJobs in interface AWSGameSparks
    
    Returns:
    
    Result of the ListGeneratedCodeJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSnapshots
```
public ListSnapshotsResult listSnapshots(ListSnapshotsRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets a paginated list of snapshot summaries from the game.
    
    Specified by:
    
    listSnapshots in interface AWSGameSparks
    
    Returns:
    
    Result of the ListSnapshots operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStageDeployments
```
public ListStageDeploymentsResult listStageDeployments(ListStageDeploymentsRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets a paginated list of stage deployment summaries from the game.
    
    Specified by:
    
    listStageDeployments in interface AWSGameSparks
    
    Returns:
    
    Result of the ListStageDeployments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStages
```
public ListStagesResult listStages(ListStagesRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Gets a paginated list of stage summaries from the game.
    
    Specified by:
    
    listStages in interface AWSGameSparks
    
    Returns:
    
    Result of the ListStages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Lists the tags associated with a GameSparks resource.
    
    Specified by:
    
    listTagsForResource in interface AWSGameSparks
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startGeneratedCodeJob
```
public StartGeneratedCodeJobResult startGeneratedCodeJob(StartGeneratedCodeJobRequest request)
```
    Description copied from interface: AWSGameSparks
    
    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.
    
    Specified by:
    
    startGeneratedCodeJob in interface AWSGameSparks
    
    Returns:
    
    Result of the StartGeneratedCodeJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startStageDeployment
```
public StartStageDeploymentResult startStageDeployment(StartStageDeploymentRequest request)
```
    Description copied from interface: AWSGameSparks
    
    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.
    
    Specified by:
    
    startStageDeployment in interface AWSGameSparks
    
    Returns:
    
    Result of the StartStageDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Adds tags to a GameSparks resource.
    
    Specified by:
    
    tagResource in interface AWSGameSparks
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Removes tags from a GameSparks resource.
    
    Specified by:
    
    untagResource in interface AWSGameSparks
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGame
```
public UpdateGameResult updateGame(UpdateGameRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Updates details of the game.
    
    Specified by:
    
    updateGame in interface AWSGameSparks
    
    Returns:
    
    Result of the UpdateGame operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGameConfiguration
```
public UpdateGameConfigurationResult updateGameConfiguration(UpdateGameConfigurationRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Updates one or more sections of the game configuration.
    
    Specified by:
    
    updateGameConfiguration in interface AWSGameSparks
    
    Returns:
    
    Result of the UpdateGameConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSnapshot
```
public UpdateSnapshotResult updateSnapshot(UpdateSnapshotRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Updates the metadata of a GameSparks snapshot.
    
    Specified by:
    
    updateSnapshot in interface AWSGameSparks
    
    Returns:
    
    Result of the UpdateSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStage
```
public UpdateStageResult updateStage(UpdateStageRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Updates the metadata of a stage.
    
    Specified by:
    
    updateStage in interface AWSGameSparks
    
    Returns:
    
    Result of the UpdateStage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSGameSparks
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSGameSparks
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSGameSparks
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSGameSparks
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSGameSparks

Field Summary

Fields inherited from interface com.amazonaws.services.gamesparks.AWSGameSparks

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createGame

createSnapshot

createStage

deleteGame

deleteStage

disconnectPlayer

exportSnapshot

getExtension

getExtensionVersion

getGame

getGameConfiguration

getGeneratedCodeJob

getPlayerConnectionStatus

getSnapshot

getStage

getStageDeployment

importGameConfiguration

listExtensionVersions

listExtensions

listGames

listGeneratedCodeJobs

listSnapshots

listStageDeployments

listStages

listTagsForResource

startGeneratedCodeJob

startStageDeployment

tagResource

untagResource

updateGame

updateGameConfiguration

updateSnapshot

updateStage

shutdown

getCachedResponseMetadata