V1Alpha1.DeploymentServiceClient Class

Namespace: Improbable.SpatialOS.Deployment

DeploymentService client wrapper, for convenient use.


Static Properties

DefaultEndpoint
ispc::PlatformApiEndpoint DefaultEndpoint { get; }

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


Properties

GrpcClient
DeploymentService.DeploymentServiceClient GrpcClient { get; }

The underlying gRPC DeploymentService client.

CreateDeploymentOperationsClient
lro::OperationsClient CreateDeploymentOperationsClient { get; }

The long-running operations client for CreateDeployment.

DeleteDeploymentOperationsClient
lro::OperationsClient DeleteDeploymentOperationsClient { get; }

The long-running operations client for DeleteDeployment.


Static Methods

Create
DeploymentServiceClient Create(ispc::PlatformApiEndpoint endpoint = null, ispc::PlatformCredential credentials = null, DeploymentServiceSettings settings = null)

Synchronously creates a DeploymentServiceClient, 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 DeploymentServiceClient.

Parameters

Create
DeploymentServiceClient Create(grpccore::Channel channel, DeploymentServiceSettings settings = null)

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

Returns:
The created DeploymentServiceClient.

Parameters


Methods

ListDeploymentsAsync
gax::PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(ListDeploymentsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A pageable asynchronous sequence of Deployment resources.

Parameters
  • ListDeploymentsRequest 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.

ListDeployments
gax::PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(ListDeploymentsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A pageable sequence of Deployment resources.

Parameters
  • ListDeploymentsRequest 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.

GetDeploymentAsync
stt::Task<GetDeploymentResponse> GetDeploymentAsync(GetDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • GetDeploymentRequest 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.

GetDeploymentAsync
stt::Task<GetDeploymentResponse> GetDeploymentAsync(GetDeploymentRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • GetDeploymentRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

GetDeployment
GetDeploymentResponse GetDeployment(GetDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • GetDeploymentRequest 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.

GetRunningDeploymentByNameAsync
stt::Task<GetDeploymentResponse> GetRunningDeploymentByNameAsync(GetRunningDeploymentByNameRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • GetRunningDeploymentByNameRequest 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.

GetRunningDeploymentByNameAsync
stt::Task<GetDeploymentResponse> GetRunningDeploymentByNameAsync(GetRunningDeploymentByNameRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • GetRunningDeploymentByNameRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

GetRunningDeploymentByName
GetDeploymentResponse GetRunningDeploymentByName(GetRunningDeploymentByNameRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • GetRunningDeploymentByNameRequest 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.

CreateDeploymentAsync
stt::Task<lro::Operation<Deployment, CreateDeploymentMetadata>> CreateDeploymentAsync(CreateDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • CreateDeploymentRequest 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.

PollOnceCreateDeploymentAsync
stt::Task<lro::Operation<Deployment, CreateDeploymentMetadata>> PollOnceCreateDeploymentAsync(string operationName, gaxgrpc::CallSettings callSettings = null)

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

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

Parameters
  • string operationName : The name of a previously invoked operation. Must not be null or empty.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

CreateDeployment
lro::Operation<Deployment, CreateDeploymentMetadata> CreateDeployment(CreateDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • CreateDeploymentRequest 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.

PollOnceCreateDeployment
lro::Operation<Deployment, CreateDeploymentMetadata> PollOnceCreateDeployment(string operationName, gaxgrpc::CallSettings callSettings = null)

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

Returns:
The result of polling the operation.

Parameters
  • string operationName : The name of a previously invoked operation. Must not be null or empty.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

DeleteDeploymentAsync
stt::Task<lro::Operation<Deployment, DeleteDeploymentMetadata>> DeleteDeploymentAsync(DeleteDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • DeleteDeploymentRequest 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.

PollOnceDeleteDeploymentAsync
stt::Task<lro::Operation<Deployment, DeleteDeploymentMetadata>> PollOnceDeleteDeploymentAsync(string operationName, gaxgrpc::CallSettings callSettings = null)

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

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

Parameters
  • string operationName : The name of a previously invoked operation. Must not be null or empty.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

DeleteDeployment
lro::Operation<Deployment, DeleteDeploymentMetadata> DeleteDeployment(DeleteDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • DeleteDeploymentRequest 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.

PollOnceDeleteDeployment
lro::Operation<Deployment, DeleteDeploymentMetadata> PollOnceDeleteDeployment(string operationName, gaxgrpc::CallSettings callSettings = null)

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

Returns:
The result of polling the operation.

Parameters
  • string operationName : The name of a previously invoked operation. Must not be null or empty.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

UpdateDeploymentAsync
stt::Task<UpdateDeploymentResponse> UpdateDeploymentAsync(UpdateDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • UpdateDeploymentRequest 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.

UpdateDeploymentAsync
stt::Task<UpdateDeploymentResponse> UpdateDeploymentAsync(UpdateDeploymentRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • UpdateDeploymentRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

UpdateDeployment
UpdateDeploymentResponse UpdateDeployment(UpdateDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • UpdateDeploymentRequest 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.

SetDeploymentWorkerFlagsAsync
stt::Task<SetDeploymentWorkerFlagsResponse> SetDeploymentWorkerFlagsAsync(SetDeploymentWorkerFlagsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentWorkerFlagsRequest 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.

SetDeploymentWorkerFlagsAsync
stt::Task<SetDeploymentWorkerFlagsResponse> SetDeploymentWorkerFlagsAsync(SetDeploymentWorkerFlagsRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentWorkerFlagsRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

SetDeploymentWorkerFlags
SetDeploymentWorkerFlagsResponse SetDeploymentWorkerFlags(SetDeploymentWorkerFlagsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • SetDeploymentWorkerFlagsRequest 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.

SetDeploymentTagsAsync
stt::Task<SetDeploymentTagsResponse> SetDeploymentTagsAsync(SetDeploymentTagsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentTagsRequest 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.

SetDeploymentTagsAsync
stt::Task<SetDeploymentTagsResponse> SetDeploymentTagsAsync(SetDeploymentTagsRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentTagsRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

SetDeploymentTags
SetDeploymentTagsResponse SetDeploymentTags(SetDeploymentTagsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • SetDeploymentTagsRequest 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.

SetDeploymentWorkerCapacitiesAsync
stt::Task<SetDeploymentWorkerCapacitiesResponse> SetDeploymentWorkerCapacitiesAsync(SetDeploymentWorkerCapacitiesRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentWorkerCapacitiesRequest 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.

SetDeploymentWorkerCapacitiesAsync
stt::Task<SetDeploymentWorkerCapacitiesResponse> SetDeploymentWorkerCapacitiesAsync(SetDeploymentWorkerCapacitiesRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentWorkerCapacitiesRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

SetDeploymentWorkerCapacities
SetDeploymentWorkerCapacitiesResponse SetDeploymentWorkerCapacities(SetDeploymentWorkerCapacitiesRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • SetDeploymentWorkerCapacitiesRequest 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.

SetDeploymentWorkerRateLimitsAsync
stt::Task<SetDeploymentWorkerRateLimitsResponse> SetDeploymentWorkerRateLimitsAsync(SetDeploymentWorkerRateLimitsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentWorkerRateLimitsRequest 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.

SetDeploymentWorkerRateLimitsAsync
stt::Task<SetDeploymentWorkerRateLimitsResponse> SetDeploymentWorkerRateLimitsAsync(SetDeploymentWorkerRateLimitsRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • SetDeploymentWorkerRateLimitsRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

SetDeploymentWorkerRateLimits
SetDeploymentWorkerRateLimitsResponse SetDeploymentWorkerRateLimits(SetDeploymentWorkerRateLimitsRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • SetDeploymentWorkerRateLimitsRequest 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.

StopDeploymentAsync
stt::Task<StopDeploymentResponse> StopDeploymentAsync(StopDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • StopDeploymentRequest 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.

StopDeploymentAsync
stt::Task<StopDeploymentResponse> StopDeploymentAsync(StopDeploymentRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • StopDeploymentRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

StopDeployment
StopDeploymentResponse StopDeployment(StopDeploymentRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • StopDeploymentRequest 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.

Updated about a year ago


V1Alpha1.DeploymentServiceClient Class


Suggested Edits are limited on API Reference Pages

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