Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Client (v0.55.0)

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

Client for the DeploymentResourcePoolService service.

A service that manages the DeploymentResourcePool resource.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the DeploymentResourcePoolService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all DeploymentResourcePoolService clients
::Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the DeploymentResourcePoolService 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
Returns

#create_deployment_resource_pool

def create_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
def create_deployment_resource_pool(parent: nil, deployment_resource_pool: nil, deployment_resource_pool_id: nil) -> ::Gapic::Operation

Create a DeploymentResourcePool.

Overloads 
def create_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_deployment_resource_pool via a request object, either of type CreateDeploymentResourcePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CreateDeploymentResourcePoolRequest, ::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_deployment_resource_pool(parent: nil, deployment_resource_pool: nil, deployment_resource_pool_id: nil) -> ::Gapic::Operation
Pass arguments to create_deployment_resource_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 location resource where this DeploymentResourcePool will be created. Format: projects/{project}/locations/{location}
  • deployment_resource_pool (::Google::Cloud::AIPlatform::V1::DeploymentResourcePool, ::Hash) — Required. The DeploymentResourcePool to create.
  • deployment_resource_pool_id (::String) — Required. The ID to use for the DeploymentResourcePool, which will become the final component of the DeploymentResourcePool's resource name.

    The maximum length is 63 characters, and valid characters are /^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/.

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::DeploymentResourcePoolService::Client.new

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

# Call the create_deployment_resource_pool method.
result = client.create_deployment_resource_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_deployment_resource_pool

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

Delete a DeploymentResourcePool.

Overloads 
def delete_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_deployment_resource_pool via a request object, either of type Google::Cloud::AIPlatform::V1::DeleteDeploymentResourcePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::DeleteDeploymentResourcePoolRequest, ::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_deployment_resource_pool(name: nil) -> ::Gapic::Operation
Pass arguments to delete_deployment_resource_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 DeploymentResourcePool to delete. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
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::DeploymentResourcePoolService::Client.new

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

# Call the delete_deployment_resource_pool method.
result = client.delete_deployment_resource_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_deployment_resource_pool

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

Get a DeploymentResourcePool.

Overloads 
def get_deployment_resource_pool(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::DeploymentResourcePool
Pass arguments to get_deployment_resource_pool via a request object, either of type GetDeploymentResourcePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GetDeploymentResourcePoolRequest, ::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_deployment_resource_pool(name: nil) -> ::Google::Cloud::AIPlatform::V1::DeploymentResourcePool
Pass arguments to get_deployment_resource_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 DeploymentResourcePool to retrieve. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::DeploymentResourcePoolService::Client.new

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

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

# The returned object is of type Google::Cloud::AIPlatform::V1::DeploymentResourcePool.
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 DeploymentResourcePoolService client object.

Yields
  • (config) — Configure the DeploymentResourcePoolService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Client.new

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

#list_deployment_resource_pools

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

List DeploymentResourcePools in a location.

Overloads 
def list_deployment_resource_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeploymentResourcePool>
Pass arguments to list_deployment_resource_pools via a request object, either of type ListDeploymentResourcePoolsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::ListDeploymentResourcePoolsRequest, ::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_deployment_resource_pools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeploymentResourcePool>
Pass arguments to list_deployment_resource_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 parent Location which owns this collection of DeploymentResourcePools. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.
  • page_token (::String) — A page token, received from a previous ListDeploymentResourcePools call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDeploymentResourcePools must match the call that provided the page token.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::DeploymentResourcePoolService::Client.new

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

# Call the list_deployment_resource_pools method.
result = client.list_deployment_resource_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::DeploymentResourcePool.
  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::DeploymentResourcePoolService::Operations

Get the associated client for long-running operations.

Returns

#query_deployed_models

def query_deployed_models(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeployedModel>
def query_deployed_models(deployment_resource_pool: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeployedModel>

List DeployedModels that have been deployed on this DeploymentResourcePool.

Overloads 
def query_deployed_models(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeployedModel>
Pass arguments to query_deployed_models via a request object, either of type QueryDeployedModelsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::QueryDeployedModelsRequest, ::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 query_deployed_models(deployment_resource_pool: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeployedModel>
Pass arguments to query_deployed_models 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
  • deployment_resource_pool (::String) — Required. The name of the target DeploymentResourcePool to query. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
  • page_size (::Integer) — The maximum number of DeployedModels to return. The service may return fewer than this value.
  • page_token (::String) — A page token, received from a previous QueryDeployedModels call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryDeployedModels must match the call that provided the page token.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::DeploymentResourcePoolService::Client.new

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

# Call the query_deployed_models method.
result = client.query_deployed_models 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::DeployedModel.
  p item
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_deployment_resource_pool

def update_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
def update_deployment_resource_pool(deployment_resource_pool: nil, update_mask: nil) -> ::Gapic::Operation

Update a DeploymentResourcePool.

Overloads 
def update_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_deployment_resource_pool via a request object, either of type UpdateDeploymentResourcePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::UpdateDeploymentResourcePoolRequest, ::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_deployment_resource_pool(deployment_resource_pool: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_deployment_resource_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
  • deployment_resource_pool (::Google::Cloud::AIPlatform::V1::DeploymentResourcePool, ::Hash) — Required. The DeploymentResourcePool to update.

    The DeploymentResourcePool's name field is used to identify the DeploymentResourcePool to update. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to update.
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::DeploymentResourcePoolService::Client.new

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

# Call the update_deployment_resource_pool method.
result = client.update_deployment_resource_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