- 0.61.0 (latest)
- 0.60.0
- 0.59.0
- 0.58.0
- 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::DeploymentResourcePoolService::Client.
Client for the DeploymentResourcePoolService service.
A service that manages the DeploymentResourcePool resource.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the DeploymentResourcePoolService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# 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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#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.
def create_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
create_deployment_resource_pool
via a request object, either of type
CreateDeploymentResourcePoolRequest or an equivalent Hash.
- 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
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).
-
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])?$/
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def delete_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
delete_deployment_resource_pool
via a request object, either of type
Google::Cloud::AIPlatform::V1::DeleteDeploymentResourcePoolRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the DeploymentResourcePool to delete.
Format:
projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def get_deployment_resource_pool(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::DeploymentResourcePool
get_deployment_resource_pool
via a request object, either of type
GetDeploymentResourcePoolRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the DeploymentResourcePool to retrieve.
Format:
projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::DeploymentResourcePool)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
- (Google::Iam::V1::IAMPolicy::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new DeploymentResourcePoolService client object.
- (config) — Configure the DeploymentResourcePoolService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# 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.
def list_deployment_resource_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeploymentResourcePool>
list_deployment_resource_pools
via a request object, either of type
ListDeploymentResourcePoolsRequest or an equivalent Hash.
- 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>
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeploymentResourcePool>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeploymentResourcePool>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
- (Google::Cloud::Location::Locations::Client)
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#operations_client
def operations_client() -> ::Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Operations
Get the associated client for long-running operations.
#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.
def query_deployed_models(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeployedModel>
query_deployed_models
via a request object, either of type
QueryDeployedModelsRequest or an equivalent Hash.
- 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>
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeployedModel>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DeployedModel>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
- (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.
def update_deployment_resource_pool(request, options = nil) -> ::Gapic::Operation
update_deployment_resource_pool
via a request object, either of type
UpdateDeploymentResourcePoolRequest or an equivalent Hash.
- 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
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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