Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client (v0.43.0)

Version 0.43.0

• 0.58.0 (latest)
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.

Client for the SpecialistPoolService service.

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.

Inherits

• Object

Includes

• Google::Cloud::AIPlatform::V1::SpecialistPoolService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the SpecialistPoolService Client class.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

Example

# Modify the configuration for all SpecialistPoolService clients
::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the SpecialistPoolService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

#create_specialist_pool

def create_specialist_pool(request, options = nil) -> ::Gapic::Operation
def create_specialist_pool(parent: nil, specialist_pool: nil) -> ::Gapic::Operation

Creates a SpecialistPool.

Overloads

def create_specialist_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_specialist_pool via a request object, either of type CreateSpecialistPoolRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::CreateSpecialistPoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_specialist_pool(parent: nil, specialist_pool: nil) -> ::Gapic::Operation

Pass arguments to create_specialist_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.
• specialist_pool (::Google::Cloud::AIPlatform::V1::SpecialistPool, ::Hash) — Required. The SpecialistPool to create.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateSpecialistPoolRequest.new

# Call the create_specialist_pool method.
result = client.create_specialist_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_specialist_pool

def delete_specialist_pool(request, options = nil) -> ::Gapic::Operation
def delete_specialist_pool(name: nil, force: nil) -> ::Gapic::Operation

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

Overloads

def delete_specialist_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_specialist_pool via a request object, either of type DeleteSpecialistPoolRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::DeleteSpecialistPoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_specialist_pool(name: nil, force: nil) -> ::Gapic::Operation

Pass arguments to delete_specialist_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• name (::String) — Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}
• force (::Boolean) — If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteSpecialistPoolRequest.new

# Call the delete_specialist_pool method.
result = client.delete_specialist_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_specialist_pool

def get_specialist_pool(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::SpecialistPool
def get_specialist_pool(name: nil) -> ::Google::Cloud::AIPlatform::V1::SpecialistPool

Gets a SpecialistPool.

Overloads

def get_specialist_pool(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::SpecialistPool

Pass arguments to get_specialist_pool via a request object, either of type GetSpecialistPoolRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::GetSpecialistPoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_specialist_pool(name: nil) -> ::Google::Cloud::AIPlatform::V1::SpecialistPool

Pass arguments to get_specialist_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• name (::String) — Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::SpecialistPool)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::SpecialistPool)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetSpecialistPoolRequest.new

# Call the get_specialist_pool method.
result = client.get_specialist_pool request

# The returned object is of type Google::Cloud::AIPlatform::V1::SpecialistPool.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

• (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new SpecialistPoolService client object.

Yields

• (config) — Configure the SpecialistPoolService client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new do |config|
  config.timeout = 10.0
end

#list_specialist_pools

def list_specialist_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SpecialistPool>
def list_specialist_pools(parent: nil, page_size: nil, page_token: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SpecialistPool>

Lists SpecialistPools in a Location.

Overloads

def list_specialist_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SpecialistPool>

Pass arguments to list_specialist_pools via a request object, either of type ListSpecialistPoolsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::ListSpecialistPoolsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_specialist_pools(parent: nil, page_size: nil, page_token: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SpecialistPool>

Pass arguments to list_specialist_pools via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — Required. The name of the SpecialistPool's parent resource. Format: projects/{project}/locations/{location}
• page_size (::Integer) — The standard list page size.
• page_token (::String) — The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.
• read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read. FieldMask represents a set of

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SpecialistPool>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SpecialistPool>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListSpecialistPoolsRequest.new

# Call the list_specialist_pools method.
result = client.list_specialist_pools request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::SpecialistPool.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

• (Google::Cloud::Location::Locations::Client)

#operations_client

def operations_client() -> ::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Operations

Get the associated client for long-running operations.

Returns

• (::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Operations)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_specialist_pool

def update_specialist_pool(request, options = nil) -> ::Gapic::Operation
def update_specialist_pool(specialist_pool: nil, update_mask: nil) -> ::Gapic::Operation

Updates a SpecialistPool.

Overloads

def update_specialist_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_specialist_pool via a request object, either of type UpdateSpecialistPoolRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::UpdateSpecialistPoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_specialist_pool(specialist_pool: nil, update_mask: nil) -> ::Gapic::Operation

Pass arguments to update_specialist_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• specialist_pool (::Google::Cloud::AIPlatform::V1::SpecialistPool, ::Hash) — Required. The SpecialistPool which replaces the resource on the server.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update mask applies to the resource.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::UpdateSpecialistPoolRequest.new

# Call the update_specialist_pool method.
result = client.update_specialist_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end