Cloud Run Admin v2 API - Class WorkerPoolsClientImpl (2.16.0)

public sealed class WorkerPoolsClientImpl : WorkerPoolsClient

Reference documentation and code samples for the Cloud Run Admin v2 API class WorkerPoolsClientImpl.

WorkerPools client wrapper implementation, for convenient use.

Inheritance

object > WorkerPoolsClient > WorkerPoolsClientImpl

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Remarks

Cloud Run WorkerPool Control Plane API.

Constructors

WorkerPoolsClientImpl(WorkerPoolsClient, WorkerPoolsSettings, ILogger)

public WorkerPoolsClientImpl(WorkerPools.WorkerPoolsClient grpcClient, WorkerPoolsSettings settings, ILogger logger)

Constructs a client wrapper for the WorkerPools service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient WorkerPoolsWorkerPoolsClient

The underlying gRPC client.

settings WorkerPoolsSettings

The base WorkerPoolsSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

CreateWorkerPoolOperationsClient

public override OperationsClient CreateWorkerPoolOperationsClient { get; }

The long-running operations client for CreateWorkerPool.

Property Value
Type Description
OperationsClient
Overrides

DeleteWorkerPoolOperationsClient

public override OperationsClient DeleteWorkerPoolOperationsClient { get; }

The long-running operations client for DeleteWorkerPool.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override WorkerPools.WorkerPoolsClient GrpcClient { get; }

The underlying gRPC WorkerPools client

Property Value
Type Description
WorkerPoolsWorkerPoolsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateWorkerPoolOperationsClient

public override OperationsClient UpdateWorkerPoolOperationsClient { get; }

The long-running operations client for UpdateWorkerPool.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateWorkerPool(CreateWorkerPoolRequest, CallSettings)

public override Operation<WorkerPool, WorkerPool> CreateWorkerPool(CreateWorkerPoolRequest request, CallSettings callSettings = null)

Creates a new WorkerPool in a given project and location.

Parameters
Name Description
request CreateWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationWorkerPoolWorkerPool

The RPC response.

Overrides

CreateWorkerPoolAsync(CreateWorkerPoolRequest, CallSettings)

public override Task<Operation<WorkerPool, WorkerPool>> CreateWorkerPoolAsync(CreateWorkerPoolRequest request, CallSettings callSettings = null)

Creates a new WorkerPool in a given project and location.

Parameters
Name Description
request CreateWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationWorkerPoolWorkerPool

A Task containing the RPC response.

Overrides

DeleteWorkerPool(DeleteWorkerPoolRequest, CallSettings)

public override Operation<WorkerPool, WorkerPool> DeleteWorkerPool(DeleteWorkerPoolRequest request, CallSettings callSettings = null)

Deletes a WorkerPool.

Parameters
Name Description
request DeleteWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationWorkerPoolWorkerPool

The RPC response.

Overrides

DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, CallSettings)

public override Task<Operation<WorkerPool, WorkerPool>> DeleteWorkerPoolAsync(DeleteWorkerPoolRequest request, CallSettings callSettings = null)

Deletes a WorkerPool.

Parameters
Name Description
request DeleteWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationWorkerPoolWorkerPool

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.

Parameters
Name Description
request GetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.

Parameters
Name Description
request GetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Overrides

GetWorkerPool(GetWorkerPoolRequest, CallSettings)

public override WorkerPool GetWorkerPool(GetWorkerPoolRequest request, CallSettings callSettings = null)

Gets information about a WorkerPool.

Parameters
Name Description
request GetWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
WorkerPool

The RPC response.

Overrides

GetWorkerPoolAsync(GetWorkerPoolRequest, CallSettings)

public override Task<WorkerPool> GetWorkerPoolAsync(GetWorkerPoolRequest request, CallSettings callSettings = null)

Gets information about a WorkerPool.

Parameters
Name Description
request GetWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWorkerPool

A Task containing the RPC response.

Overrides

ListWorkerPools(ListWorkerPoolsRequest, CallSettings)

public override PagedEnumerable<ListWorkerPoolsResponse, WorkerPool> ListWorkerPools(ListWorkerPoolsRequest request, CallSettings callSettings = null)

Lists WorkerPools. Results are sorted by creation time, descending.

Parameters
Name Description
request ListWorkerPoolsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListWorkerPoolsResponseWorkerPool

A pageable sequence of WorkerPool resources.

Overrides

ListWorkerPoolsAsync(ListWorkerPoolsRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkerPoolsResponse, WorkerPool> ListWorkerPoolsAsync(ListWorkerPoolsRequest request, CallSettings callSettings = null)

Lists WorkerPools. Results are sorted by creation time, descending.

Parameters
Name Description
request ListWorkerPoolsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListWorkerPoolsResponseWorkerPool

A pageable asynchronous sequence of WorkerPool resources.

Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Parameters
Name Description
request TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TestIamPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Parameters
Name Description
request TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Overrides

UpdateWorkerPool(UpdateWorkerPoolRequest, CallSettings)

public override Operation<WorkerPool, WorkerPool> UpdateWorkerPool(UpdateWorkerPoolRequest request, CallSettings callSettings = null)

Updates a WorkerPool.

Parameters
Name Description
request UpdateWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationWorkerPoolWorkerPool

The RPC response.

Overrides

UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, CallSettings)

public override Task<Operation<WorkerPool, WorkerPool>> UpdateWorkerPoolAsync(UpdateWorkerPoolRequest request, CallSettings callSettings = null)

Updates a WorkerPool.

Parameters
Name Description
request UpdateWorkerPoolRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationWorkerPoolWorkerPool

A Task containing the RPC response.

Overrides