Cloud AI Platform v1 API - Class SpecialistPoolServiceClient (2.25.0)

public abstract class SpecialistPoolServiceClient

Reference documentation and code samples for the Cloud AI Platform v1 API class SpecialistPoolServiceClient.

SpecialistPoolService client wrapper, for convenient use.

Inheritance

object > SpecialistPoolServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for creating and managing Customer SpecialistPools. When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.

Properties

CreateSpecialistPoolOperationsClient

public virtual OperationsClient CreateSpecialistPoolOperationsClient { get; }

The long-running operations client for CreateSpecialistPool.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the SpecialistPoolService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default SpecialistPoolService scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

The default SpecialistPoolService scopes are:

DeleteSpecialistPoolOperationsClient

public virtual OperationsClient DeleteSpecialistPoolOperationsClient { get; }

The long-running operations client for DeleteSpecialistPool.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual SpecialistPoolService.SpecialistPoolServiceClient GrpcClient { get; }

The underlying gRPC SpecialistPoolService client

Property Value
TypeDescription
SpecialistPoolServiceSpecialistPoolServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UpdateSpecialistPoolOperationsClient

public virtual OperationsClient UpdateSpecialistPoolOperationsClient { get; }

The long-running operations client for UpdateSpecialistPool.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static SpecialistPoolServiceClient Create()

Synchronously creates a SpecialistPoolServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SpecialistPoolServiceClientBuilder.

Returns
TypeDescription
SpecialistPoolServiceClient

The created SpecialistPoolServiceClient.

CreateAsync(CancellationToken)

public static Task<SpecialistPoolServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a SpecialistPoolServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SpecialistPoolServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskSpecialistPoolServiceClient

The task representing the created SpecialistPoolServiceClient.

CreateSpecialistPool(LocationName, SpecialistPool, CallSettings)

public virtual Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> CreateSpecialistPool(LocationName parent, SpecialistPool specialistPool, CallSettings callSettings = null)

Creates a SpecialistPool.

Parameters
NameDescription
parentLocationName

Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.

specialistPoolSpecialistPool

Required. The SpecialistPool to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSpecialistPoolCreateSpecialistPoolOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SpecialistPool specialistPool = new SpecialistPool();
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = specialistPoolServiceClient.CreateSpecialistPool(parent, specialistPool);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceCreateSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPool(CreateSpecialistPoolRequest, CallSettings)

public virtual Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> CreateSpecialistPool(CreateSpecialistPoolRequest request, CallSettings callSettings = null)

Creates a SpecialistPool.

Parameters
NameDescription
requestCreateSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSpecialistPoolCreateSpecialistPoolOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
CreateSpecialistPoolRequest request = new CreateSpecialistPoolRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SpecialistPool = new SpecialistPool(),
};
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = specialistPoolServiceClient.CreateSpecialistPool(request);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceCreateSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPool(string, SpecialistPool, CallSettings)

public virtual Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> CreateSpecialistPool(string parent, SpecialistPool specialistPool, CallSettings callSettings = null)

Creates a SpecialistPool.

Parameters
NameDescription
parentstring

Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.

specialistPoolSpecialistPool

Required. The SpecialistPool to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSpecialistPoolCreateSpecialistPoolOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SpecialistPool specialistPool = new SpecialistPool();
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = specialistPoolServiceClient.CreateSpecialistPool(parent, specialistPool);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceCreateSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPoolAsync(LocationName, SpecialistPool, CallSettings)

public virtual Task<Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata>> CreateSpecialistPoolAsync(LocationName parent, SpecialistPool specialistPool, CallSettings callSettings = null)

Creates a SpecialistPool.

Parameters
NameDescription
parentLocationName

Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.

specialistPoolSpecialistPool

Required. The SpecialistPool to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSpecialistPoolCreateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SpecialistPool specialistPool = new SpecialistPool();
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.CreateSpecialistPoolAsync(parent, specialistPool);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceCreateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPoolAsync(LocationName, SpecialistPool, CancellationToken)

public virtual Task<Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata>> CreateSpecialistPoolAsync(LocationName parent, SpecialistPool specialistPool, CancellationToken cancellationToken)

Creates a SpecialistPool.

Parameters
NameDescription
parentLocationName

Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.

specialistPoolSpecialistPool

Required. The SpecialistPool to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationSpecialistPoolCreateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SpecialistPool specialistPool = new SpecialistPool();
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.CreateSpecialistPoolAsync(parent, specialistPool);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceCreateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPoolAsync(CreateSpecialistPoolRequest, CallSettings)

public virtual Task<Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata>> CreateSpecialistPoolAsync(CreateSpecialistPoolRequest request, CallSettings callSettings = null)

Creates a SpecialistPool.

Parameters
NameDescription
requestCreateSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSpecialistPoolCreateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
CreateSpecialistPoolRequest request = new CreateSpecialistPoolRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SpecialistPool = new SpecialistPool(),
};
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.CreateSpecialistPoolAsync(request);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceCreateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPoolAsync(CreateSpecialistPoolRequest, CancellationToken)

public virtual Task<Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata>> CreateSpecialistPoolAsync(CreateSpecialistPoolRequest request, CancellationToken cancellationToken)

Creates a SpecialistPool.

Parameters
NameDescription
requestCreateSpecialistPoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationSpecialistPoolCreateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
CreateSpecialistPoolRequest request = new CreateSpecialistPoolRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SpecialistPool = new SpecialistPool(),
};
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.CreateSpecialistPoolAsync(request);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceCreateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPoolAsync(string, SpecialistPool, CallSettings)

public virtual Task<Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata>> CreateSpecialistPoolAsync(string parent, SpecialistPool specialistPool, CallSettings callSettings = null)

Creates a SpecialistPool.

Parameters
NameDescription
parentstring

Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.

specialistPoolSpecialistPool

Required. The SpecialistPool to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSpecialistPoolCreateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SpecialistPool specialistPool = new SpecialistPool();
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.CreateSpecialistPoolAsync(parent, specialistPool);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceCreateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

CreateSpecialistPoolAsync(string, SpecialistPool, CancellationToken)

public virtual Task<Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata>> CreateSpecialistPoolAsync(string parent, SpecialistPool specialistPool, CancellationToken cancellationToken)

Creates a SpecialistPool.

Parameters
NameDescription
parentstring

Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.

specialistPoolSpecialistPool

Required. The SpecialistPool to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationSpecialistPoolCreateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SpecialistPool specialistPool = new SpecialistPool();
// Make the request
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.CreateSpecialistPoolAsync(parent, specialistPool);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceCreateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPool(DeleteSpecialistPoolRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteSpecialistPool(DeleteSpecialistPoolRequest request, CallSettings callSettings = null)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
requestDeleteSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
DeleteSpecialistPoolRequest request = new DeleteSpecialistPoolRequest
{
    SpecialistPoolName = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]"),
    Force = false,
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = specialistPoolServiceClient.DeleteSpecialistPool(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceDeleteSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPool(SpecialistPoolName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteSpecialistPool(SpecialistPoolName name, CallSettings callSettings = null)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
nameSpecialistPoolName

Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
SpecialistPoolName name = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = specialistPoolServiceClient.DeleteSpecialistPool(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceDeleteSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPool(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteSpecialistPool(string name, CallSettings callSettings = null)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
namestring

Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/specialistPools/[SPECIALIST_POOL]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = specialistPoolServiceClient.DeleteSpecialistPool(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceDeleteSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPoolAsync(DeleteSpecialistPoolRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request, CallSettings callSettings = null)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
requestDeleteSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteSpecialistPoolRequest request = new DeleteSpecialistPoolRequest
{
    SpecialistPoolName = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]"),
    Force = false,
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await specialistPoolServiceClient.DeleteSpecialistPoolAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceDeleteSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPoolAsync(DeleteSpecialistPoolRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request, CancellationToken cancellationToken)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
requestDeleteSpecialistPoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteSpecialistPoolRequest request = new DeleteSpecialistPoolRequest
{
    SpecialistPoolName = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]"),
    Force = false,
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await specialistPoolServiceClient.DeleteSpecialistPoolAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceDeleteSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPoolAsync(SpecialistPoolName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSpecialistPoolAsync(SpecialistPoolName name, CallSettings callSettings = null)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
nameSpecialistPoolName

Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
SpecialistPoolName name = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await specialistPoolServiceClient.DeleteSpecialistPoolAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceDeleteSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPoolAsync(SpecialistPoolName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSpecialistPoolAsync(SpecialistPoolName name, CancellationToken cancellationToken)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
nameSpecialistPoolName

Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
SpecialistPoolName name = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await specialistPoolServiceClient.DeleteSpecialistPoolAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceDeleteSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPoolAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSpecialistPoolAsync(string name, CallSettings callSettings = null)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
namestring

Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/specialistPools/[SPECIALIST_POOL]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await specialistPoolServiceClient.DeleteSpecialistPoolAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceDeleteSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSpecialistPoolAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSpecialistPoolAsync(string name, CancellationToken cancellationToken)

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters
NameDescription
namestring

Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/specialistPools/[SPECIALIST_POOL]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await specialistPoolServiceClient.DeleteSpecialistPoolAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceDeleteSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetSpecialistPool(GetSpecialistPoolRequest, CallSettings)

public virtual SpecialistPool GetSpecialistPool(GetSpecialistPoolRequest request, CallSettings callSettings = null)

Gets a SpecialistPool.

Parameters
NameDescription
requestGetSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SpecialistPool

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
GetSpecialistPoolRequest request = new GetSpecialistPoolRequest
{
    SpecialistPoolName = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]"),
};
// Make the request
SpecialistPool response = specialistPoolServiceClient.GetSpecialistPool(request);

GetSpecialistPool(SpecialistPoolName, CallSettings)

public virtual SpecialistPool GetSpecialistPool(SpecialistPoolName name, CallSettings callSettings = null)

Gets a SpecialistPool.

Parameters
NameDescription
nameSpecialistPoolName

Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SpecialistPool

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
SpecialistPoolName name = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
// Make the request
SpecialistPool response = specialistPoolServiceClient.GetSpecialistPool(name);

GetSpecialistPool(string, CallSettings)

public virtual SpecialistPool GetSpecialistPool(string name, CallSettings callSettings = null)

Gets a SpecialistPool.

Parameters
NameDescription
namestring

Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SpecialistPool

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/specialistPools/[SPECIALIST_POOL]";
// Make the request
SpecialistPool response = specialistPoolServiceClient.GetSpecialistPool(name);

GetSpecialistPoolAsync(GetSpecialistPoolRequest, CallSettings)

public virtual Task<SpecialistPool> GetSpecialistPoolAsync(GetSpecialistPoolRequest request, CallSettings callSettings = null)

Gets a SpecialistPool.

Parameters
NameDescription
requestGetSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSpecialistPool

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
GetSpecialistPoolRequest request = new GetSpecialistPoolRequest
{
    SpecialistPoolName = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]"),
};
// Make the request
SpecialistPool response = await specialistPoolServiceClient.GetSpecialistPoolAsync(request);

GetSpecialistPoolAsync(GetSpecialistPoolRequest, CancellationToken)

public virtual Task<SpecialistPool> GetSpecialistPoolAsync(GetSpecialistPoolRequest request, CancellationToken cancellationToken)

Gets a SpecialistPool.

Parameters
NameDescription
requestGetSpecialistPoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskSpecialistPool

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
GetSpecialistPoolRequest request = new GetSpecialistPoolRequest
{
    SpecialistPoolName = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]"),
};
// Make the request
SpecialistPool response = await specialistPoolServiceClient.GetSpecialistPoolAsync(request);

GetSpecialistPoolAsync(SpecialistPoolName, CallSettings)

public virtual Task<SpecialistPool> GetSpecialistPoolAsync(SpecialistPoolName name, CallSettings callSettings = null)

Gets a SpecialistPool.

Parameters
NameDescription
nameSpecialistPoolName

Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSpecialistPool

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
SpecialistPoolName name = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
// Make the request
SpecialistPool response = await specialistPoolServiceClient.GetSpecialistPoolAsync(name);

GetSpecialistPoolAsync(SpecialistPoolName, CancellationToken)

public virtual Task<SpecialistPool> GetSpecialistPoolAsync(SpecialistPoolName name, CancellationToken cancellationToken)

Gets a SpecialistPool.

Parameters
NameDescription
nameSpecialistPoolName

Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskSpecialistPool

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
SpecialistPoolName name = SpecialistPoolName.FromProjectLocationSpecialistPool("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
// Make the request
SpecialistPool response = await specialistPoolServiceClient.GetSpecialistPoolAsync(name);

GetSpecialistPoolAsync(string, CallSettings)

public virtual Task<SpecialistPool> GetSpecialistPoolAsync(string name, CallSettings callSettings = null)

Gets a SpecialistPool.

Parameters
NameDescription
namestring

Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSpecialistPool

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/specialistPools/[SPECIALIST_POOL]";
// Make the request
SpecialistPool response = await specialistPoolServiceClient.GetSpecialistPoolAsync(name);

GetSpecialistPoolAsync(string, CancellationToken)

public virtual Task<SpecialistPool> GetSpecialistPoolAsync(string name, CancellationToken cancellationToken)

Gets a SpecialistPool.

Parameters
NameDescription
namestring

Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskSpecialistPool

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/specialistPools/[SPECIALIST_POOL]";
// Make the request
SpecialistPool response = await specialistPoolServiceClient.GetSpecialistPoolAsync(name);

ListSpecialistPools(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListSpecialistPoolsResponse, SpecialistPool> ListSpecialistPools(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SpecialistPools in a Location.

Parameters
NameDescription
parentLocationName

Required. The name of the SpecialistPool's parent resource. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListSpecialistPoolsResponseSpecialistPool

A pageable sequence of SpecialistPool resources.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListSpecialistPoolsResponse, SpecialistPool> response = specialistPoolServiceClient.ListSpecialistPools(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SpecialistPool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSpecialistPoolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SpecialistPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SpecialistPool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SpecialistPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSpecialistPools(ListSpecialistPoolsRequest, CallSettings)

public virtual PagedEnumerable<ListSpecialistPoolsResponse, SpecialistPool> ListSpecialistPools(ListSpecialistPoolsRequest request, CallSettings callSettings = null)

Lists SpecialistPools in a Location.

Parameters
NameDescription
requestListSpecialistPoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListSpecialistPoolsResponseSpecialistPool

A pageable sequence of SpecialistPool resources.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
ListSpecialistPoolsRequest request = new ListSpecialistPoolsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListSpecialistPoolsResponse, SpecialistPool> response = specialistPoolServiceClient.ListSpecialistPools(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (SpecialistPool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSpecialistPoolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SpecialistPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SpecialistPool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SpecialistPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSpecialistPools(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListSpecialistPoolsResponse, SpecialistPool> ListSpecialistPools(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SpecialistPools in a Location.

Parameters
NameDescription
parentstring

Required. The name of the SpecialistPool's parent resource. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListSpecialistPoolsResponseSpecialistPool

A pageable sequence of SpecialistPool resources.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListSpecialistPoolsResponse, SpecialistPool> response = specialistPoolServiceClient.ListSpecialistPools(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SpecialistPool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSpecialistPoolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SpecialistPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SpecialistPool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SpecialistPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSpecialistPoolsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSpecialistPoolsResponse, SpecialistPool> ListSpecialistPoolsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SpecialistPools in a Location.

Parameters
NameDescription
parentLocationName

Required. The name of the SpecialistPool's parent resource. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListSpecialistPoolsResponseSpecialistPool

A pageable asynchronous sequence of SpecialistPool resources.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListSpecialistPoolsResponse, SpecialistPool> response = specialistPoolServiceClient.ListSpecialistPoolsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SpecialistPool item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSpecialistPoolsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SpecialistPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SpecialistPool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SpecialistPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSpecialistPoolsAsync(ListSpecialistPoolsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListSpecialistPoolsResponse, SpecialistPool> ListSpecialistPoolsAsync(ListSpecialistPoolsRequest request, CallSettings callSettings = null)

Lists SpecialistPools in a Location.

Parameters
NameDescription
requestListSpecialistPoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListSpecialistPoolsResponseSpecialistPool

A pageable asynchronous sequence of SpecialistPool resources.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
ListSpecialistPoolsRequest request = new ListSpecialistPoolsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListSpecialistPoolsResponse, SpecialistPool> response = specialistPoolServiceClient.ListSpecialistPoolsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SpecialistPool item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSpecialistPoolsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SpecialistPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SpecialistPool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SpecialistPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSpecialistPoolsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSpecialistPoolsResponse, SpecialistPool> ListSpecialistPoolsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SpecialistPools in a Location.

Parameters
NameDescription
parentstring

Required. The name of the SpecialistPool's parent resource. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListSpecialistPoolsResponseSpecialistPool

A pageable asynchronous sequence of SpecialistPool resources.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListSpecialistPoolsResponse, SpecialistPool> response = specialistPoolServiceClient.ListSpecialistPoolsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SpecialistPool item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSpecialistPoolsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SpecialistPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SpecialistPool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SpecialistPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateSpecialistPool(string, CallSettings)

public virtual Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata> PollOnceCreateSpecialistPool(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSpecialistPoolCreateSpecialistPoolOperationMetadata

The result of polling the operation.

PollOnceCreateSpecialistPoolAsync(string, CallSettings)

public virtual Task<Operation<SpecialistPool, CreateSpecialistPoolOperationMetadata>> PollOnceCreateSpecialistPoolAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSpecialistPoolCreateSpecialistPoolOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteSpecialistPool(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteSpecialistPool(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteSpecialistPoolAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> PollOnceDeleteSpecialistPoolAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateSpecialistPool(string, CallSettings)

public virtual Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> PollOnceUpdateSpecialistPool(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

The result of polling the operation.

PollOnceUpdateSpecialistPoolAsync(string, CallSettings)

public virtual Task<Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata>> PollOnceUpdateSpecialistPoolAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateSpecialistPool(SpecialistPool, FieldMask, CallSettings)

public virtual Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> UpdateSpecialistPool(SpecialistPool specialistPool, FieldMask updateMask, CallSettings callSettings = null)

Updates a SpecialistPool.

Parameters
NameDescription
specialistPoolSpecialistPool

Required. The SpecialistPool which replaces the resource on the server.

updateMaskFieldMask

Required. The update mask applies to the resource.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
SpecialistPool specialistPool = new SpecialistPool();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> response = specialistPoolServiceClient.UpdateSpecialistPool(specialistPool, updateMask);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceUpdateSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

UpdateSpecialistPool(UpdateSpecialistPoolRequest, CallSettings)

public virtual Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> UpdateSpecialistPool(UpdateSpecialistPoolRequest request, CallSettings callSettings = null)

Updates a SpecialistPool.

Parameters
NameDescription
requestUpdateSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

The RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = SpecialistPoolServiceClient.Create();
// Initialize request argument(s)
UpdateSpecialistPoolRequest request = new UpdateSpecialistPoolRequest
{
    SpecialistPool = new SpecialistPool(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> response = specialistPoolServiceClient.UpdateSpecialistPool(request);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> retrievedResponse = specialistPoolServiceClient.PollOnceUpdateSpecialistPool(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

UpdateSpecialistPoolAsync(SpecialistPool, FieldMask, CallSettings)

public virtual Task<Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata>> UpdateSpecialistPoolAsync(SpecialistPool specialistPool, FieldMask updateMask, CallSettings callSettings = null)

Updates a SpecialistPool.

Parameters
NameDescription
specialistPoolSpecialistPool

Required. The SpecialistPool which replaces the resource on the server.

updateMaskFieldMask

Required. The update mask applies to the resource.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
SpecialistPool specialistPool = new SpecialistPool();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.UpdateSpecialistPoolAsync(specialistPool, updateMask);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceUpdateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

UpdateSpecialistPoolAsync(SpecialistPool, FieldMask, CancellationToken)

public virtual Task<Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata>> UpdateSpecialistPoolAsync(SpecialistPool specialistPool, FieldMask updateMask, CancellationToken cancellationToken)

Updates a SpecialistPool.

Parameters
NameDescription
specialistPoolSpecialistPool

Required. The SpecialistPool which replaces the resource on the server.

updateMaskFieldMask

Required. The update mask applies to the resource.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
SpecialistPool specialistPool = new SpecialistPool();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.UpdateSpecialistPoolAsync(specialistPool, updateMask);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceUpdateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

UpdateSpecialistPoolAsync(UpdateSpecialistPoolRequest, CallSettings)

public virtual Task<Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata>> UpdateSpecialistPoolAsync(UpdateSpecialistPoolRequest request, CallSettings callSettings = null)

Updates a SpecialistPool.

Parameters
NameDescription
requestUpdateSpecialistPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateSpecialistPoolRequest request = new UpdateSpecialistPoolRequest
{
    SpecialistPool = new SpecialistPool(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.UpdateSpecialistPoolAsync(request);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceUpdateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}

UpdateSpecialistPoolAsync(UpdateSpecialistPoolRequest, CancellationToken)

public virtual Task<Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata>> UpdateSpecialistPoolAsync(UpdateSpecialistPoolRequest request, CancellationToken cancellationToken)

Updates a SpecialistPool.

Parameters
NameDescription
requestUpdateSpecialistPoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationSpecialistPoolUpdateSpecialistPoolOperationMetadata

A Task containing the RPC response.

Example
// Create client
SpecialistPoolServiceClient specialistPoolServiceClient = await SpecialistPoolServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateSpecialistPoolRequest request = new UpdateSpecialistPoolRequest
{
    SpecialistPool = new SpecialistPool(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> response = await specialistPoolServiceClient.UpdateSpecialistPoolAsync(request);

// Poll until the returned long-running operation is complete
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SpecialistPool result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SpecialistPool, UpdateSpecialistPoolOperationMetadata> retrievedResponse = await specialistPoolServiceClient.PollOnceUpdateSpecialistPoolAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SpecialistPool retrievedResult = retrievedResponse.Result;
}