Class: Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb

Overview

REST client for the DeploymentResourcePoolService service.

A service that manages the DeploymentResourcePool resource.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#deployment_resource_pool_path, #location_path, #project_path, #reservation_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new DeploymentResourcePoolService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the DeploymentResourcePoolService client.

Yield Parameters:



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 128

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = ::Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @deployment_resource_pool_service_stub = ::Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @deployment_resource_pool_service_stub.endpoint
    config.universe_domain = @deployment_resource_pool_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @deployment_resource_pool_service_stub.endpoint
    config.universe_domain = @deployment_resource_pool_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

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

Returns:

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


201
202
203
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 201

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

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

Returns:

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


194
195
196
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 194

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



187
188
189
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 187

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the DeploymentResourcePoolService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "AIPlatform", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



98
99
100
101
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 98

def configure
  yield @config if block_given?
  @config
end

#create_deployment_resource_pool(request, options = nil) ⇒ ::Gapic::Operation #create_deployment_resource_pool(parent: nil, deployment_resource_pool: nil, deployment_resource_pool_id: nil) ⇒ ::Gapic::Operation

Create a DeploymentResourcePool.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The DeploymentResourcePool to create.

    • deployment_resource_pool_id (::String) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 265

def create_deployment_resource_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateDeploymentResourcePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_deployment_resource_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_deployment_resource_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_deployment_resource_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @deployment_resource_pool_service_stub.create_deployment_resource_pool request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_deployment_resource_pool(request, options = nil) ⇒ ::Gapic::Operation #delete_deployment_resource_pool(name: nil) ⇒ ::Gapic::Operation

Delete a DeploymentResourcePool.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the DeploymentResourcePool to delete. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 624

def delete_deployment_resource_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteDeploymentResourcePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_deployment_resource_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_deployment_resource_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_deployment_resource_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @deployment_resource_pool_service_stub.delete_deployment_resource_pool request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_deployment_resource_pool(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::DeploymentResourcePool #get_deployment_resource_pool(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::DeploymentResourcePool

Get a DeploymentResourcePool.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the DeploymentResourcePool to retrieve. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 347

def get_deployment_resource_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetDeploymentResourcePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_deployment_resource_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_deployment_resource_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_deployment_resource_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @deployment_resource_pool_service_stub.get_deployment_resource_pool request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

List DeploymentResourcePools in a location.

Examples:

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::Rest::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

Overloads:

  • #list_deployment_resource_pools(request, options = nil) ⇒ ::Gapic::Rest::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_deployment_resource_pools(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::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) (defaults to: nil) —

      Required. The parent Location which owns this collection of DeploymentResourcePools. Format: projects/{project}/locations/{location}

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.

    • page_token (::String) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 441

def list_deployment_resource_pools request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListDeploymentResourcePoolsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_deployment_resource_pools.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_deployment_resource_pools.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_deployment_resource_pools.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @deployment_resource_pool_service_stub.list_deployment_resource_pools request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @deployment_resource_pool_service_stub, :list_deployment_resource_pools, "deployment_resource_pools", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#query_deployed_models(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::QueryDeployedModelsResponse #query_deployed_models(deployment_resource_pool: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::AIPlatform::V1::QueryDeployedModelsResponse

List DeployedModels that have been deployed on this DeploymentResourcePool.

Examples:

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::Rest::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

Overloads:

  • #query_deployed_models(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::QueryDeployedModelsResponse

    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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #query_deployed_models(deployment_resource_pool: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::AIPlatform::V1::QueryDeployedModelsResponse

    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) (defaults to: nil) —

      Required. The name of the target DeploymentResourcePool to query. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of DeployedModels to return. The service may return fewer than this value.

    • page_token (::String) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 720

def query_deployed_models request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::QueryDeployedModelsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.query_deployed_models.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_deployed_models.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.query_deployed_models.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @deployment_resource_pool_service_stub.query_deployed_models request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


108
109
110
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 108

def universe_domain
  @deployment_resource_pool_service_stub.universe_domain
end

#update_deployment_resource_pool(request, options = nil) ⇒ ::Gapic::Operation #update_deployment_resource_pool(deployment_resource_pool: nil, update_mask: nil) ⇒ ::Gapic::Operation

Update a DeploymentResourcePool.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The list of fields to update.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb', line 535

def update_deployment_resource_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateDeploymentResourcePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_deployment_resource_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_deployment_resource_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_deployment_resource_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @deployment_resource_pool_service_stub.update_deployment_resource_pool request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end