Sites

Menu
These are the docs for 14.3, an old version of SpatialOS. 14.5 is the newest →

SnapshotServiceClient Class

Namespace: Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotService

Client for SnapshotService

Inheritance

grpc::ClientBase<SnapshotServiceClient>


Constructors

SnapshotServiceClient
SnapshotServiceClient(grpc::Channel channel)

Creates a new client for SnapshotService

Parameters
  • grpc::Channel channel : The channel to use to make remote calls.
SnapshotServiceClient
SnapshotServiceClient(grpc::CallInvoker callInvoker)

Creates a new client for SnapshotService that uses a custom .

Parameters
  • grpc::CallInvoker callInvoker : The callInvoker to use to make remote calls.
SnapshotServiceClient
SnapshotServiceClient()

Protected parameterless constructor to allow creation of test doubles.
SnapshotServiceClient
SnapshotServiceClient(ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameters
  • ClientBaseConfiguration configuration : The client configuration.


Methods

ListSnapshots
global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsResponse ListSnapshots(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
ListSnapshots
global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsResponse ListSnapshots(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request, grpc::CallOptions options)

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
ListSnapshotsAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsResponse> ListSnapshotsAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
ListSnapshotsAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsResponse> ListSnapshotsAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request, grpc::CallOptions options)

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
GetSnapshot
global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotResponse GetSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a snapshot.

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
GetSnapshot
global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotResponse GetSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request, grpc::CallOptions options)

Gets a snapshot.

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
GetSnapshotAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotResponse> GetSnapshotAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a snapshot.

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
GetSnapshotAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotResponse> GetSnapshotAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request, grpc::CallOptions options)

Gets a snapshot.

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
TakeSnapshot
global::Google.LongRunning.Operation TakeSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.

Notes:
  • The returned operation result is of type upon successfully taking a snapshot.
TakeSnapshot
global::Google.LongRunning.Operation TakeSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request, grpc::CallOptions options)

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.

Notes:
  • The returned operation result is of type upon successfully taking a snapshot.
TakeSnapshotAsync
grpc::AsyncUnaryCall<global::Google.LongRunning.Operation> TakeSnapshotAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.

Notes:
  • The returned operation result is of type upon successfully taking a snapshot.
TakeSnapshotAsync
grpc::AsyncUnaryCall<global::Google.LongRunning.Operation> TakeSnapshotAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request, grpc::CallOptions options)

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.

Notes:
  • The returned operation result is of type upon successfully taking a snapshot.
UploadSnapshot
global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotResponse UploadSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
UploadSnapshot
global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotResponse UploadSnapshot(global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request, grpc::CallOptions options)

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
UploadSnapshotAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotResponse> UploadSnapshotAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
UploadSnapshotAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotResponse> UploadSnapshotAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request, grpc::CallOptions options)

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
ConfirmUpload
global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadResponse ConfirmUpload(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
ConfirmUpload
global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadResponse ConfirmUpload(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request, grpc::CallOptions options)

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

Returns:
The response received from the server.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
ConfirmUploadAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadResponse> ConfirmUploadAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request, grpc::Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request : The request to send to the server.
  • grpc::Metadata headers : The initial metadata to send with the call. This parameter is optional.
  • DateTime? deadline : An optional deadline for the call. The call will be cancelled if deadline is hit.
  • CancellationToken cancellationToken : An optional token for canceling the call.
ConfirmUploadAsync
grpc::AsyncUnaryCall<global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadResponse> ConfirmUploadAsync(global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request, grpc::CallOptions options)

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

Returns:
The call object.

Parameters
  • global::Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest request : The request to send to the server.
  • grpc::CallOptions options : The options for the call.
CreateOperationsClient
lro::Operations.OperationsClient CreateOperationsClient()

Creates a new instance of lro::Operations.OperationsClient using the same call invoker as this client.

Returns:
A new Operations client for the same target as this client.


Overrides

NewInstance
override SnapshotServiceClient NewInstance(ClientBaseConfiguration configuration)

Creates a new instance of client from given .

Parameters
  • ClientBaseConfiguration configuration :

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums