V1Alpha1.SnapshotService.SnapshotServiceBase Class

Namespace: Improbable.SpatialOS.Snapshot

Base class for server-side implementations of SnapshotService


Methods

ListSnapshots
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsResponse> ListSnapshots(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request, grpc::ServerCallContext context)

Lists snapshots under a deployment. By default, snapshots are sorted by creation time (descending).

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

GetSnapshot
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotResponse> GetSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request, grpc::ServerCallContext context)

Gets a snapshot.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

TakeSnapshot
global::System.Threading.Tasks.Task<global::Google.LongRunning.Operation> TakeSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request, grpc::ServerCallContext context)

Takes a snapshot. You can only take snapshots of running deployments.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Notes:
  • The returned operation result is of type snapshot upon successfully taking a snapshot.

UploadSnapshot
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotResponse> UploadSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request, grpc::ServerCallContext context)

Allocates space and returns a URL to upload a snapshot to.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

ConfirmUpload
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadResponse> ConfirmUpload(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request, grpc::ServerCallContext context)

Confirms that a snapshot is uploaded to the URL allocated by the UploadSnapshot RPC and makes it available for use in a deployment.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Updated about a year ago


V1Alpha1.SnapshotService.SnapshotServiceBase Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.