public class WorkerPools.WorkerPoolsClient : ClientBase<WorkerPools.WorkerPoolsClient>
Reference documentation and code samples for the Cloud Run Admin v2 API class WorkerPools.WorkerPoolsClient.
Client for WorkerPools
Inheritance
object > ClientBase > ClientBaseWorkerPoolsWorkerPoolsClient > WorkerPools.WorkerPoolsClientNamespace
Google.Cloud.Run.V2Assembly
Google.Cloud.Run.V2.dll
Constructors
WorkerPoolsClient()
protected WorkerPoolsClient()
Protected parameterless constructor to allow creation of test doubles.
WorkerPoolsClient(CallInvoker)
public WorkerPoolsClient(CallInvoker callInvoker)
Creates a new client for WorkerPools that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
WorkerPoolsClient(ChannelBase)
public WorkerPoolsClient(ChannelBase channel)
Creates a new client for WorkerPools
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
WorkerPoolsClient(ClientBaseConfiguration)
protected WorkerPoolsClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()
Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()
Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
CreateWorkerPool(CreateWorkerPoolRequest, CallOptions)
public virtual Operation CreateWorkerPool(CreateWorkerPoolRequest request, CallOptions options)
Creates a new WorkerPool in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
CreateWorkerPool(CreateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateWorkerPool(CreateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new WorkerPool in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
CreateWorkerPoolAsync(CreateWorkerPoolRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateWorkerPoolAsync(CreateWorkerPoolRequest request, CallOptions options)
Creates a new WorkerPool in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateWorkerPoolAsync(CreateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateWorkerPoolAsync(CreateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new WorkerPool in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteWorkerPool(DeleteWorkerPoolRequest, CallOptions)
public virtual Operation DeleteWorkerPool(DeleteWorkerPoolRequest request, CallOptions options)
Deletes a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
DeleteWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
DeleteWorkerPool(DeleteWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteWorkerPool(DeleteWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
DeleteWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteWorkerPoolAsync(DeleteWorkerPoolRequest request, CallOptions options)
Deletes a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
DeleteWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteWorkerPoolAsync(DeleteWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteWorkerPoolAsync(DeleteWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
DeleteWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
GetIamPolicy(GetIamPolicyRequest, CallOptions)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
GetWorkerPool(GetWorkerPoolRequest, CallOptions)
public virtual WorkerPool GetWorkerPool(GetWorkerPoolRequest request, CallOptions options)
Gets information about a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
GetWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
WorkerPool |
The response received from the server. |
GetWorkerPool(GetWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual WorkerPool GetWorkerPool(GetWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets information about a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
GetWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
WorkerPool |
The response received from the server. |
GetWorkerPoolAsync(GetWorkerPoolRequest, CallOptions)
public virtual AsyncUnaryCall<WorkerPool> GetWorkerPoolAsync(GetWorkerPoolRequest request, CallOptions options)
Gets information about a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
GetWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallWorkerPool |
The call object. |
GetWorkerPoolAsync(GetWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<WorkerPool> GetWorkerPoolAsync(GetWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets information about a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
GetWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallWorkerPool |
The call object. |
ListWorkerPools(ListWorkerPoolsRequest, CallOptions)
public virtual ListWorkerPoolsResponse ListWorkerPools(ListWorkerPoolsRequest request, CallOptions options)
Lists WorkerPools. Results are sorted by creation time, descending.
Parameters | |
---|---|
Name | Description |
request |
ListWorkerPoolsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListWorkerPoolsResponse |
The response received from the server. |
ListWorkerPools(ListWorkerPoolsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListWorkerPoolsResponse ListWorkerPools(ListWorkerPoolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists WorkerPools. Results are sorted by creation time, descending.
Parameters | |
---|---|
Name | Description |
request |
ListWorkerPoolsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListWorkerPoolsResponse |
The response received from the server. |
ListWorkerPoolsAsync(ListWorkerPoolsRequest, CallOptions)
public virtual AsyncUnaryCall<ListWorkerPoolsResponse> ListWorkerPoolsAsync(ListWorkerPoolsRequest request, CallOptions options)
Lists WorkerPools. Results are sorted by creation time, descending.
Parameters | |
---|---|
Name | Description |
request |
ListWorkerPoolsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListWorkerPoolsResponse |
The call object. |
ListWorkerPoolsAsync(ListWorkerPoolsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListWorkerPoolsResponse> ListWorkerPoolsAsync(ListWorkerPoolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists WorkerPools. Results are sorted by creation time, descending.
Parameters | |
---|---|
Name | Description |
request |
ListWorkerPoolsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListWorkerPoolsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override WorkerPools.WorkerPoolsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
WorkerPoolsWorkerPoolsClient |
SetIamPolicy(SetIamPolicyRequest, CallOptions)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)
Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)
Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
TestIamPermissions(TestIamPermissionsRequest, CallOptions)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse |
The response received from the server. |
TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse |
The response received from the server. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTestIamPermissionsResponse |
The call object. |
TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTestIamPermissionsResponse |
The call object. |
UpdateWorkerPool(UpdateWorkerPoolRequest, CallOptions)
public virtual Operation UpdateWorkerPool(UpdateWorkerPoolRequest request, CallOptions options)
Updates a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
UpdateWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
UpdateWorkerPool(UpdateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateWorkerPool(UpdateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
UpdateWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateWorkerPoolAsync(UpdateWorkerPoolRequest request, CallOptions options)
Updates a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
UpdateWorkerPoolRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateWorkerPoolAsync(UpdateWorkerPoolRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateWorkerPoolAsync(UpdateWorkerPoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates a WorkerPool.
Parameters | |
---|---|
Name | Description |
request |
UpdateWorkerPoolRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |