Sites

Menu

SnapshotServiceClient Class

Namespace: Improbable.SpatialOS.Snapshot.V1Alpha1

SnapshotService client wrapper, for convenient use.


Static Properties

DefaultEndpoint
ispc::PlatformApiEndpoint DefaultEndpoint { get; }

The default endpoint for the SnapshotService service, which is a host of "platform.api.improbable.io" and a port of 443.


Properties

GrpcClient
SnapshotService.SnapshotServiceClient GrpcClient { get; }

The underlying gRPC SnapshotService client.
TakeSnapshotOperationsClient
lro::OperationsClient TakeSnapshotOperationsClient { get; }

The long-running operations client for .


Static Methods

Create
SnapshotServiceClient Create(ispc::PlatformApiEndpoint endpoint = null, ispc::PlatformCredential credentials = null, SnapshotServiceSettings settings = null)

Synchronously creates a SnapshotServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.

Returns:
The created SnapshotServiceClient.

Parameters
  • ispc::PlatformApiEndpoint endpoint : Optional ispc::PlatformApiEndpoint.
  • ispc::PlatformCredential credentials : Optional, most likely a ispc::PlatformRefreshTokenCredential.
  • SnapshotServiceSettings settings : Optional SnapshotServiceSettings.
Create
SnapshotServiceClient Create(grpccore::Channel channel, SnapshotServiceSettings settings = null)

Creates a SnapshotServiceClient which uses the specified channel for remote operations.

Returns:
The created SnapshotServiceClient.

Parameters


Methods

ListSnapshotsAsync
gax::PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshotsAsync(ListSnapshotsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A pageable asynchronous sequence of Snapshot resources.

Parameters
  • ListSnapshotsRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
ListSnapshots
gax::PagedEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshots(ListSnapshotsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A pageable sequence of Snapshot resources.

Parameters
  • ListSnapshotsRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
GetSnapshotAsync
stt::Task<GetSnapshotResponse> GetSnapshotAsync(GetSnapshotRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • GetSnapshotRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
GetSnapshotAsync
stt::Task<GetSnapshotResponse> GetSnapshotAsync(GetSnapshotRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • GetSnapshotRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.
GetSnapshot
GetSnapshotResponse GetSnapshot(GetSnapshotRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • GetSnapshotRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
TakeSnapshotAsync
stt::Task<lro::Operation<Snapshot, TakeSnapshotMetadata>> TakeSnapshotAsync(TakeSnapshotRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • TakeSnapshotRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
PollOnceTakeSnapshotAsync
stt::Task<lro::Operation<Snapshot, TakeSnapshotMetadata>> PollOnceTakeSnapshotAsync(string operationName, gaxgrpc::CallSettings callSettings = null)

Asynchronously poll an operation once, using an from a previous invocation of .

Returns:
A task representing the result of polling the operation.

Parameters
  • string operationName : The name of a previously invoked operation. Must not be or empty.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
TakeSnapshot
lro::Operation<Snapshot, TakeSnapshotMetadata> TakeSnapshot(TakeSnapshotRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • TakeSnapshotRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
PollOnceTakeSnapshot
lro::Operation<Snapshot, TakeSnapshotMetadata> PollOnceTakeSnapshot(string operationName, gaxgrpc::CallSettings callSettings = null)

Poll an operation once, using an from a previous invocation of .

Returns:
The result of polling the operation.

Parameters
  • string operationName : The name of a previously invoked operation. Must not be or empty.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
UploadSnapshotAsync
stt::Task<UploadSnapshotResponse> UploadSnapshotAsync(UploadSnapshotRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • UploadSnapshotRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
UploadSnapshotAsync
stt::Task<UploadSnapshotResponse> UploadSnapshotAsync(UploadSnapshotRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • UploadSnapshotRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.
UploadSnapshot
UploadSnapshotResponse UploadSnapshot(UploadSnapshotRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • UploadSnapshotRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
ConfirmUploadAsync
stt::Task<ConfirmUploadResponse> ConfirmUploadAsync(ConfirmUploadRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • ConfirmUploadRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.
ConfirmUploadAsync
stt::Task<ConfirmUploadResponse> ConfirmUploadAsync(ConfirmUploadRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • ConfirmUploadRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.
ConfirmUpload
ConfirmUploadResponse ConfirmUpload(ConfirmUploadRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • ConfirmUploadRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums