# frozen_string_literal: true
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
require "google/cloud/errors"
require "google/cloud/automl/v1beta1/service_pb"
module Google
module Cloud
module AutoML
module V1beta1
module AutoML
##
# Client for the AutoMl service.
#
# AutoML Server API.
#
# The resource names are assigned by the server.
# The server never reuses names that it has created after the resources with
# those names are deleted.
#
# An ID of a resource is the last element of the item's resource name. For
# `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`, then
# the id for the item is `{dataset_id}`.
#
# Currently the only supported `location_id` is "us-central1".
#
# On any input that is documented to expect a string parameter in
# snake_case or kebab-case, either of those cases is accepted.
#
class Client
include Paths
# @private
attr_reader :auto_ml_stub
##
# Configure the AutoMl Client class.
#
# See {::Google::Cloud::AutoML::V1beta1::AutoML::Client::Configuration}
# for a description of the configuration fields.
#
# @example
#
# # Modify the configuration for all AutoMl clients
# ::Google::Cloud::AutoML::V1beta1::AutoML::Client.configure do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def self.configure
@configure ||= begin
namespace = ["Google", "Cloud", "AutoML", "V1beta1"]
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.rpcs.create_dataset.timeout = 5.0
default_config.rpcs.get_dataset.timeout = 5.0
default_config.rpcs.get_dataset.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.list_datasets.timeout = 5.0
default_config.rpcs.list_datasets.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.update_dataset.timeout = 5.0
default_config.rpcs.delete_dataset.timeout = 5.0
default_config.rpcs.delete_dataset.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.import_data.timeout = 5.0
default_config.rpcs.export_data.timeout = 5.0
default_config.rpcs.get_annotation_spec.timeout = 5.0
default_config.rpcs.get_annotation_spec.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.get_table_spec.timeout = 5.0
default_config.rpcs.get_table_spec.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.list_table_specs.timeout = 5.0
default_config.rpcs.list_table_specs.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.update_table_spec.timeout = 5.0
default_config.rpcs.get_column_spec.timeout = 5.0
default_config.rpcs.get_column_spec.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.list_column_specs.timeout = 5.0
default_config.rpcs.list_column_specs.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.update_column_spec.timeout = 5.0
default_config.rpcs.create_model.timeout = 5.0
default_config.rpcs.get_model.timeout = 5.0
default_config.rpcs.get_model.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.list_models.timeout = 5.0
default_config.rpcs.list_models.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.delete_model.timeout = 5.0
default_config.rpcs.delete_model.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.deploy_model.timeout = 5.0
default_config.rpcs.undeploy_model.timeout = 5.0
default_config.rpcs.export_model.timeout = 5.0
default_config.rpcs.export_evaluated_examples.timeout = 5.0
default_config.rpcs.get_model_evaluation.timeout = 5.0
default_config.rpcs.get_model_evaluation.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
}
default_config.rpcs.list_model_evaluations.timeout = 5.0
default_config
end
yield @configure if block_given?
@configure
end
##
# Configure the AutoMl 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 {::Google::Cloud::AutoML::V1beta1::AutoML::Client::Configuration}
# for a description of the configuration fields.
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def configure
yield @config if block_given?
@config
end
##
# Create a new AutoMl client object.
#
# @example
#
# # Create a client using the default configuration
# client = ::Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a client using a custom configuration
# client = ::Google::Cloud::AutoML::V1beta1::AutoML::Client.new do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the AutoMl client.
# @yieldparam config [Client::Configuration]
#
def initialize
# These require statements are intentionally placed here to initialize
# the gRPC module only when it's required.
# See https://github.com/googleapis/toolkit/issues/446
require "gapic/grpc"
require "google/cloud/automl/v1beta1/service_services_pb"
# 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 == Client.configure.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 = Operations.new do |config|
config.credentials = credentials
config.endpoint = @config.endpoint
end
@auto_ml_stub = ::Gapic::ServiceStub.new(
::Google::Cloud::AutoML::V1beta1::AutoMl::Stub,
credentials: credentials,
endpoint: @config.endpoint,
channel_args: @config.channel_args,
interceptors: @config.interceptors
)
end
##
# Get the associated client for long-running operations.
#
# @return [::Google::Cloud::AutoML::V1beta1::AutoML::Operations]
#
attr_reader :operations_client
# Service calls
##
# Creates a dataset.
#
# @overload create_dataset(request, options = nil)
# Pass arguments to `create_dataset` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::CreateDatasetRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::CreateDatasetRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload create_dataset(parent: nil, dataset: nil)
# Pass arguments to `create_dataset` 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).
#
# @param parent [::String]
# Required. The resource name of the project to create the dataset for.
# @param dataset [::Google::Cloud::AutoML::V1beta1::Dataset, ::Hash]
# Required. The dataset to create.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::Dataset]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::Dataset]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::CreateDatasetRequest.new
#
# # Call the create_dataset method.
# result = client.create_dataset request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::Dataset.
# p result
#
def create_dataset request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::CreateDatasetRequest
# 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
metadata = @config.rpcs.create_dataset.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.create_dataset.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_dataset.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :create_dataset, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a dataset.
#
# @overload get_dataset(request, options = nil)
# Pass arguments to `get_dataset` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::GetDatasetRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::GetDatasetRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_dataset(name: nil)
# Pass arguments to `get_dataset` 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).
#
# @param name [::String]
# Required. The resource name of the dataset to retrieve.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::Dataset]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::Dataset]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::GetDatasetRequest.new
#
# # Call the get_dataset method.
# result = client.get_dataset request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::Dataset.
# p result
#
def get_dataset request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::GetDatasetRequest
# 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
metadata = @config.rpcs.get_dataset.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_dataset.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_dataset.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :get_dataset, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Lists datasets in a project.
#
# @overload list_datasets(request, options = nil)
# Pass arguments to `list_datasets` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ListDatasetsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ListDatasetsRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_datasets(parent: nil, filter: nil, page_size: nil, page_token: nil)
# Pass arguments to `list_datasets` 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).
#
# @param parent [::String]
# Required. The resource name of the project from which to list datasets.
# @param filter [::String]
# An expression for filtering the results of the request.
#
# * `dataset_metadata` - for existence of the case (e.g.
# image_classification_dataset_metadata:*). Some examples of using the filter are:
#
# * `translation_dataset_metadata:*` --> The dataset has
# translation_dataset_metadata.
# @param page_size [::Integer]
# Requested page size. Server may return fewer results than requested.
# If unspecified, server will pick a default size.
# @param page_token [::String]
# A token identifying a page of results for the server to return
# Typically obtained via
# {::Google::Cloud::AutoML::V1beta1::ListDatasetsResponse#next_page_token ListDatasetsResponse.next_page_token} of the previous
# {::Google::Cloud::AutoML::V1beta1::AutoML::Client#list_datasets AutoMl.ListDatasets} call.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::Dataset>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::Dataset>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ListDatasetsRequest.new
#
# # Call the list_datasets method.
# result = client.list_datasets request
#
# # The returned object is of type Gapic::PagedEnumerable. You can
# # iterate over all elements by calling #each, and the enumerable
# # will lazily make API calls to fetch subsequent pages. Other
# # methods are also available for managing paging directly.
# result.each do |response|
# # Each element is of type ::Google::Cloud::AutoML::V1beta1::Dataset.
# p response
# end
#
def list_datasets request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ListDatasetsRequest
# 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
metadata = @config.rpcs.list_datasets.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_datasets.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_datasets.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :list_datasets, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @auto_ml_stub, :list_datasets, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Updates a dataset.
#
# @overload update_dataset(request, options = nil)
# Pass arguments to `update_dataset` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::UpdateDatasetRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::UpdateDatasetRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload update_dataset(dataset: nil, update_mask: nil)
# Pass arguments to `update_dataset` 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).
#
# @param dataset [::Google::Cloud::AutoML::V1beta1::Dataset, ::Hash]
# Required. The dataset which replaces the resource on the server.
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
# The update mask applies to the resource.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::Dataset]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::Dataset]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::UpdateDatasetRequest.new
#
# # Call the update_dataset method.
# result = client.update_dataset request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::Dataset.
# p result
#
def update_dataset request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::UpdateDatasetRequest
# 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
metadata = @config.rpcs.update_dataset.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.dataset&.name
header_params["dataset.name"] = request.dataset.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.update_dataset.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_dataset.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :update_dataset, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Deletes a dataset and all of its contents.
# Returns empty response in the
# {::Google::Longrunning::Operation#response response} field when it completes,
# and `delete_details` in the
# {::Google::Longrunning::Operation#metadata metadata} field.
#
# @overload delete_dataset(request, options = nil)
# Pass arguments to `delete_dataset` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::DeleteDatasetRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::DeleteDatasetRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload delete_dataset(name: nil)
# Pass arguments to `delete_dataset` 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).
#
# @param name [::String]
# Required. The resource name of the dataset to delete.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::DeleteDatasetRequest.new
#
# # Call the delete_dataset method.
# result = client.delete_dataset request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def delete_dataset request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::DeleteDatasetRequest
# 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
metadata = @config.rpcs.delete_dataset.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.delete_dataset.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_dataset.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :delete_dataset, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Imports data into a dataset.
# For Tables this method can only be called on an empty Dataset.
#
# For Tables:
# * A
# {::Google::Cloud::AutoML::V1beta1::InputConfig#params schema_inference_version}
# parameter must be explicitly set.
# Returns an empty response in the
# {::Google::Longrunning::Operation#response response} field when it completes.
#
# @overload import_data(request, options = nil)
# Pass arguments to `import_data` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ImportDataRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ImportDataRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload import_data(name: nil, input_config: nil)
# Pass arguments to `import_data` 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).
#
# @param name [::String]
# Required. Dataset name. Dataset must already exist. All imported
# annotations and examples will be added.
# @param input_config [::Google::Cloud::AutoML::V1beta1::InputConfig, ::Hash]
# Required. The desired input location and its domain specific semantics,
# if any.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ImportDataRequest.new
#
# # Call the import_data method.
# result = client.import_data request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def import_data request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ImportDataRequest
# 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
metadata = @config.rpcs.import_data.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.import_data.timeout,
metadata: metadata,
retry_policy: @config.rpcs.import_data.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :import_data, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Exports dataset's data to the provided output location.
# Returns an empty response in the
# {::Google::Longrunning::Operation#response response} field when it completes.
#
# @overload export_data(request, options = nil)
# Pass arguments to `export_data` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ExportDataRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ExportDataRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload export_data(name: nil, output_config: nil)
# Pass arguments to `export_data` 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).
#
# @param name [::String]
# Required. The resource name of the dataset.
# @param output_config [::Google::Cloud::AutoML::V1beta1::OutputConfig, ::Hash]
# Required. The desired output location.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ExportDataRequest.new
#
# # Call the export_data method.
# result = client.export_data request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def export_data request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ExportDataRequest
# 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
metadata = @config.rpcs.export_data.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.export_data.timeout,
metadata: metadata,
retry_policy: @config.rpcs.export_data.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :export_data, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets an annotation spec.
#
# @overload get_annotation_spec(request, options = nil)
# Pass arguments to `get_annotation_spec` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::GetAnnotationSpecRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::GetAnnotationSpecRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_annotation_spec(name: nil)
# Pass arguments to `get_annotation_spec` 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).
#
# @param name [::String]
# Required. The resource name of the annotation spec to retrieve.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::AnnotationSpec]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::AnnotationSpec]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::GetAnnotationSpecRequest.new
#
# # Call the get_annotation_spec method.
# result = client.get_annotation_spec request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::AnnotationSpec.
# p result
#
def get_annotation_spec request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::GetAnnotationSpecRequest
# 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
metadata = @config.rpcs.get_annotation_spec.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_annotation_spec.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_annotation_spec.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :get_annotation_spec, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a table spec.
#
# @overload get_table_spec(request, options = nil)
# Pass arguments to `get_table_spec` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::GetTableSpecRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::GetTableSpecRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_table_spec(name: nil, field_mask: nil)
# Pass arguments to `get_table_spec` 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).
#
# @param name [::String]
# Required. The resource name of the table spec to retrieve.
# @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
# Mask specifying which fields to read.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::TableSpec]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::TableSpec]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::GetTableSpecRequest.new
#
# # Call the get_table_spec method.
# result = client.get_table_spec request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::TableSpec.
# p result
#
def get_table_spec request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::GetTableSpecRequest
# 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
metadata = @config.rpcs.get_table_spec.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_table_spec.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_table_spec.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :get_table_spec, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Lists table specs in a dataset.
#
# @overload list_table_specs(request, options = nil)
# Pass arguments to `list_table_specs` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ListTableSpecsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ListTableSpecsRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_table_specs(parent: nil, field_mask: nil, filter: nil, page_size: nil, page_token: nil)
# Pass arguments to `list_table_specs` 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).
#
# @param parent [::String]
# Required. The resource name of the dataset to list table specs from.
# @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
# Mask specifying which fields to read.
# @param filter [::String]
# Filter expression, see go/filtering.
# @param page_size [::Integer]
# Requested page size. The server can return fewer results than requested.
# If unspecified, the server will pick a default size.
# @param page_token [::String]
# A token identifying a page of results for the server to return.
# Typically obtained from the
# {::Google::Cloud::AutoML::V1beta1::ListTableSpecsResponse#next_page_token ListTableSpecsResponse.next_page_token} field of the previous
# {::Google::Cloud::AutoML::V1beta1::AutoML::Client#list_table_specs AutoMl.ListTableSpecs} call.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::TableSpec>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::TableSpec>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ListTableSpecsRequest.new
#
# # Call the list_table_specs method.
# result = client.list_table_specs request
#
# # The returned object is of type Gapic::PagedEnumerable. You can
# # iterate over all elements by calling #each, and the enumerable
# # will lazily make API calls to fetch subsequent pages. Other
# # methods are also available for managing paging directly.
# result.each do |response|
# # Each element is of type ::Google::Cloud::AutoML::V1beta1::TableSpec.
# p response
# end
#
def list_table_specs request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ListTableSpecsRequest
# 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
metadata = @config.rpcs.list_table_specs.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_table_specs.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_table_specs.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :list_table_specs, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @auto_ml_stub, :list_table_specs, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Updates a table spec.
#
# @overload update_table_spec(request, options = nil)
# Pass arguments to `update_table_spec` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::UpdateTableSpecRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::UpdateTableSpecRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload update_table_spec(table_spec: nil, update_mask: nil)
# Pass arguments to `update_table_spec` 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).
#
# @param table_spec [::Google::Cloud::AutoML::V1beta1::TableSpec, ::Hash]
# Required. The table spec which replaces the resource on the server.
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
# The update mask applies to the resource.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::TableSpec]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::TableSpec]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::UpdateTableSpecRequest.new
#
# # Call the update_table_spec method.
# result = client.update_table_spec request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::TableSpec.
# p result
#
def update_table_spec request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::UpdateTableSpecRequest
# 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
metadata = @config.rpcs.update_table_spec.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.table_spec&.name
header_params["table_spec.name"] = request.table_spec.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.update_table_spec.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_table_spec.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :update_table_spec, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a column spec.
#
# @overload get_column_spec(request, options = nil)
# Pass arguments to `get_column_spec` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::GetColumnSpecRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::GetColumnSpecRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_column_spec(name: nil, field_mask: nil)
# Pass arguments to `get_column_spec` 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).
#
# @param name [::String]
# Required. The resource name of the column spec to retrieve.
# @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
# Mask specifying which fields to read.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::ColumnSpec]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::ColumnSpec]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::GetColumnSpecRequest.new
#
# # Call the get_column_spec method.
# result = client.get_column_spec request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::ColumnSpec.
# p result
#
def get_column_spec request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::GetColumnSpecRequest
# 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
metadata = @config.rpcs.get_column_spec.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_column_spec.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_column_spec.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :get_column_spec, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Lists column specs in a table spec.
#
# @overload list_column_specs(request, options = nil)
# Pass arguments to `list_column_specs` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ListColumnSpecsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ListColumnSpecsRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_column_specs(parent: nil, field_mask: nil, filter: nil, page_size: nil, page_token: nil)
# Pass arguments to `list_column_specs` 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).
#
# @param parent [::String]
# Required. The resource name of the table spec to list column specs from.
# @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
# Mask specifying which fields to read.
# @param filter [::String]
# Filter expression, see go/filtering.
# @param page_size [::Integer]
# Requested page size. The server can return fewer results than requested.
# If unspecified, the server will pick a default size.
# @param page_token [::String]
# A token identifying a page of results for the server to return.
# Typically obtained from the
# {::Google::Cloud::AutoML::V1beta1::ListColumnSpecsResponse#next_page_token ListColumnSpecsResponse.next_page_token} field of the previous
# {::Google::Cloud::AutoML::V1beta1::AutoML::Client#list_column_specs AutoMl.ListColumnSpecs} call.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::ColumnSpec>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::ColumnSpec>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ListColumnSpecsRequest.new
#
# # Call the list_column_specs method.
# result = client.list_column_specs request
#
# # The returned object is of type Gapic::PagedEnumerable. You can
# # iterate over all elements by calling #each, and the enumerable
# # will lazily make API calls to fetch subsequent pages. Other
# # methods are also available for managing paging directly.
# result.each do |response|
# # Each element is of type ::Google::Cloud::AutoML::V1beta1::ColumnSpec.
# p response
# end
#
def list_column_specs request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ListColumnSpecsRequest
# 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
metadata = @config.rpcs.list_column_specs.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_column_specs.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_column_specs.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :list_column_specs, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @auto_ml_stub, :list_column_specs, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Updates a column spec.
#
# @overload update_column_spec(request, options = nil)
# Pass arguments to `update_column_spec` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::UpdateColumnSpecRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::UpdateColumnSpecRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload update_column_spec(column_spec: nil, update_mask: nil)
# Pass arguments to `update_column_spec` 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).
#
# @param column_spec [::Google::Cloud::AutoML::V1beta1::ColumnSpec, ::Hash]
# Required. The column spec which replaces the resource on the server.
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
# The update mask applies to the resource.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::ColumnSpec]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::ColumnSpec]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::UpdateColumnSpecRequest.new
#
# # Call the update_column_spec method.
# result = client.update_column_spec request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::ColumnSpec.
# p result
#
def update_column_spec request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::UpdateColumnSpecRequest
# 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
metadata = @config.rpcs.update_column_spec.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.column_spec&.name
header_params["column_spec.name"] = request.column_spec.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.update_column_spec.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_column_spec.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :update_column_spec, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Creates a model.
# Returns a Model in the {::Google::Longrunning::Operation#response response}
# field when it completes.
# When you create a model, several model evaluations are created for it:
# a global evaluation, and one evaluation for each annotation spec.
#
# @overload create_model(request, options = nil)
# Pass arguments to `create_model` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::CreateModelRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::CreateModelRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload create_model(parent: nil, model: nil)
# Pass arguments to `create_model` 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).
#
# @param parent [::String]
# Required. Resource name of the parent project where the model is being created.
# @param model [::Google::Cloud::AutoML::V1beta1::Model, ::Hash]
# Required. The model to create.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::CreateModelRequest.new
#
# # Call the create_model method.
# result = client.create_model request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def create_model request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::CreateModelRequest
# 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
metadata = @config.rpcs.create_model.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.create_model.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_model.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :create_model, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a model.
#
# @overload get_model(request, options = nil)
# Pass arguments to `get_model` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::GetModelRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::GetModelRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_model(name: nil)
# Pass arguments to `get_model` 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).
#
# @param name [::String]
# Required. Resource name of the model.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::Model]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::Model]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::GetModelRequest.new
#
# # Call the get_model method.
# result = client.get_model request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::Model.
# p result
#
def get_model request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::GetModelRequest
# 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
metadata = @config.rpcs.get_model.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_model.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_model.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :get_model, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Lists models.
#
# @overload list_models(request, options = nil)
# Pass arguments to `list_models` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ListModelsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ListModelsRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_models(parent: nil, filter: nil, page_size: nil, page_token: nil)
# Pass arguments to `list_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).
#
# @param parent [::String]
# Required. Resource name of the project, from which to list the models.
# @param filter [::String]
# An expression for filtering the results of the request.
#
# * `model_metadata` - for existence of the case (e.g.
# video_classification_model_metadata:*).
# * `dataset_id` - for = or !=. Some examples of using the filter are:
#
# * `image_classification_model_metadata:*` --> The model has
# image_classification_model_metadata.
# * `dataset_id=5` --> The model was created from a dataset with ID 5.
# @param page_size [::Integer]
# Requested page size.
# @param page_token [::String]
# A token identifying a page of results for the server to return
# Typically obtained via
# {::Google::Cloud::AutoML::V1beta1::ListModelsResponse#next_page_token ListModelsResponse.next_page_token} of the previous
# {::Google::Cloud::AutoML::V1beta1::AutoML::Client#list_models AutoMl.ListModels} call.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::Model>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::Model>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ListModelsRequest.new
#
# # Call the list_models method.
# result = client.list_models request
#
# # The returned object is of type Gapic::PagedEnumerable. You can
# # iterate over all elements by calling #each, and the enumerable
# # will lazily make API calls to fetch subsequent pages. Other
# # methods are also available for managing paging directly.
# result.each do |response|
# # Each element is of type ::Google::Cloud::AutoML::V1beta1::Model.
# p response
# end
#
def list_models request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ListModelsRequest
# 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
metadata = @config.rpcs.list_models.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_models.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_models.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :list_models, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @auto_ml_stub, :list_models, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Deletes a model.
# Returns `google.protobuf.Empty` in the
# {::Google::Longrunning::Operation#response response} field when it completes,
# and `delete_details` in the
# {::Google::Longrunning::Operation#metadata metadata} field.
#
# @overload delete_model(request, options = nil)
# Pass arguments to `delete_model` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::DeleteModelRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::DeleteModelRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload delete_model(name: nil)
# Pass arguments to `delete_model` 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).
#
# @param name [::String]
# Required. Resource name of the model being deleted.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::DeleteModelRequest.new
#
# # Call the delete_model method.
# result = client.delete_model request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def delete_model request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::DeleteModelRequest
# 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
metadata = @config.rpcs.delete_model.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.delete_model.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_model.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :delete_model, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Deploys a model. If a model is already deployed, deploying it with the
# same parameters has no effect. Deploying with different parametrs
# (as e.g. changing
#
# [node_number][google.cloud.automl.v1beta1.ImageObjectDetectionModelDeploymentMetadata.node_number])
# will reset the deployment state without pausing the model's availability.
#
# Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage
# deployment automatically.
#
# Returns an empty response in the
# {::Google::Longrunning::Operation#response response} field when it completes.
#
# @overload deploy_model(request, options = nil)
# Pass arguments to `deploy_model` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::DeployModelRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::DeployModelRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload deploy_model(image_object_detection_model_deployment_metadata: nil, image_classification_model_deployment_metadata: nil, name: nil)
# Pass arguments to `deploy_model` 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).
#
# @param image_object_detection_model_deployment_metadata [::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelDeploymentMetadata, ::Hash]
# Model deployment metadata specific to Image Object Detection.
# @param image_classification_model_deployment_metadata [::Google::Cloud::AutoML::V1beta1::ImageClassificationModelDeploymentMetadata, ::Hash]
# Model deployment metadata specific to Image Classification.
# @param name [::String]
# Required. Resource name of the model to deploy.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::DeployModelRequest.new
#
# # Call the deploy_model method.
# result = client.deploy_model request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def deploy_model request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::DeployModelRequest
# 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
metadata = @config.rpcs.deploy_model.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.deploy_model.timeout,
metadata: metadata,
retry_policy: @config.rpcs.deploy_model.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :deploy_model, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Undeploys a model. If the model is not deployed this method has no effect.
#
# Only applicable for Text Classification, Image Object Detection and Tables;
# all other domains manage deployment automatically.
#
# Returns an empty response in the
# {::Google::Longrunning::Operation#response response} field when it completes.
#
# @overload undeploy_model(request, options = nil)
# Pass arguments to `undeploy_model` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::UndeployModelRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::UndeployModelRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload undeploy_model(name: nil)
# Pass arguments to `undeploy_model` 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).
#
# @param name [::String]
# Required. Resource name of the model to undeploy.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::UndeployModelRequest.new
#
# # Call the undeploy_model method.
# result = client.undeploy_model request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def undeploy_model request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::UndeployModelRequest
# 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
metadata = @config.rpcs.undeploy_model.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.undeploy_model.timeout,
metadata: metadata,
retry_policy: @config.rpcs.undeploy_model.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :undeploy_model, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Exports a trained, "export-able", model to a user specified Google Cloud
# Storage location. A model is considered export-able if and only if it has
# an export format defined for it in
#
# {::Google::Cloud::AutoML::V1beta1::ModelExportOutputConfig ModelExportOutputConfig}.
#
# Returns an empty response in the
# {::Google::Longrunning::Operation#response response} field when it completes.
#
# @overload export_model(request, options = nil)
# Pass arguments to `export_model` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ExportModelRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ExportModelRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload export_model(name: nil, output_config: nil)
# Pass arguments to `export_model` 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).
#
# @param name [::String]
# Required. The resource name of the model to export.
# @param output_config [::Google::Cloud::AutoML::V1beta1::ModelExportOutputConfig, ::Hash]
# Required. The desired output location and configuration.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ExportModelRequest.new
#
# # Call the export_model method.
# result = client.export_model request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def export_model request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ExportModelRequest
# 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
metadata = @config.rpcs.export_model.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.export_model.timeout,
metadata: metadata,
retry_policy: @config.rpcs.export_model.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :export_model, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Exports examples on which the model was evaluated (i.e. which were in the
# TEST set of the dataset the model was created from), together with their
# ground truth annotations and the annotations created (predicted) by the
# model.
# The examples, ground truth and predictions are exported in the state
# they were at the moment the model was evaluated.
#
# This export is available only for 30 days since the model evaluation is
# created.
#
# Currently only available for Tables.
#
# Returns an empty response in the
# {::Google::Longrunning::Operation#response response} field when it completes.
#
# @overload export_evaluated_examples(request, options = nil)
# Pass arguments to `export_evaluated_examples` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload export_evaluated_examples(name: nil, output_config: nil)
# Pass arguments to `export_evaluated_examples` 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).
#
# @param name [::String]
# Required. The resource name of the model whose evaluated examples are to
# be exported.
# @param output_config [::Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesOutputConfig, ::Hash]
# Required. The desired output location and configuration.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesRequest.new
#
# # Call the export_evaluated_examples method.
# result = client.export_evaluated_examples request
#
# # The returned object is of type Gapic::Operation. You can use this
# # object to check the status of an operation, cancel it, or wait
# # for results. Here is how to block until completion:
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "Error!"
# end
#
def export_evaluated_examples request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesRequest
# 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
metadata = @config.rpcs.export_evaluated_examples.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.export_evaluated_examples.timeout,
metadata: metadata,
retry_policy: @config.rpcs.export_evaluated_examples.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :export_evaluated_examples, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a model evaluation.
#
# @overload get_model_evaluation(request, options = nil)
# Pass arguments to `get_model_evaluation` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::GetModelEvaluationRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::GetModelEvaluationRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_model_evaluation(name: nil)
# Pass arguments to `get_model_evaluation` 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).
#
# @param name [::String]
# Required. Resource name for the model evaluation.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AutoML::V1beta1::ModelEvaluation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AutoML::V1beta1::ModelEvaluation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::GetModelEvaluationRequest.new
#
# # Call the get_model_evaluation method.
# result = client.get_model_evaluation request
#
# # The returned object is of type Google::Cloud::AutoML::V1beta1::ModelEvaluation.
# p result
#
def get_model_evaluation request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::GetModelEvaluationRequest
# 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
metadata = @config.rpcs.get_model_evaluation.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_model_evaluation.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_model_evaluation.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :get_model_evaluation, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Lists model evaluations.
#
# @overload list_model_evaluations(request, options = nil)
# Pass arguments to `list_model_evaluations` via a request object, either of type
# {::Google::Cloud::AutoML::V1beta1::ListModelEvaluationsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AutoML::V1beta1::ListModelEvaluationsRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_model_evaluations(parent: nil, filter: nil, page_size: nil, page_token: nil)
# Pass arguments to `list_model_evaluations` 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).
#
# @param parent [::String]
# Required. Resource name of the model to list the model evaluations for.
# If modelId is set as "-", this will list model evaluations from across all
# models of the parent location.
# @param filter [::String]
# An expression for filtering the results of the request.
#
# * `annotation_spec_id` - for =, != or existence. See example below for
# the last.
#
# Some examples of using the filter are:
#
# * `annotation_spec_id!=4` --> The model evaluation was done for
# annotation spec with ID different than 4.
# * `NOT annotation_spec_id:*` --> The model evaluation was done for
# aggregate of all annotation specs.
# @param page_size [::Integer]
# Requested page size.
# @param page_token [::String]
# A token identifying a page of results for the server to return.
# Typically obtained via
# {::Google::Cloud::AutoML::V1beta1::ListModelEvaluationsResponse#next_page_token ListModelEvaluationsResponse.next_page_token} of the previous
# {::Google::Cloud::AutoML::V1beta1::AutoML::Client#list_model_evaluations AutoMl.ListModelEvaluations} call.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::ModelEvaluation>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AutoML::V1beta1::ModelEvaluation>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/automl/v1beta1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AutoML::V1beta1::AutoML::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AutoML::V1beta1::ListModelEvaluationsRequest.new
#
# # Call the list_model_evaluations method.
# result = client.list_model_evaluations request
#
# # The returned object is of type Gapic::PagedEnumerable. You can
# # iterate over all elements by calling #each, and the enumerable
# # will lazily make API calls to fetch subsequent pages. Other
# # methods are also available for managing paging directly.
# result.each do |response|
# # Each element is of type ::Google::Cloud::AutoML::V1beta1::ModelEvaluation.
# p response
# end
#
def list_model_evaluations request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1beta1::ListModelEvaluationsRequest
# 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
metadata = @config.rpcs.list_model_evaluations.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AutoML::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_model_evaluations.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_model_evaluations.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@auto_ml_stub.call_rpc :list_model_evaluations, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @auto_ml_stub, :list_model_evaluations, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Configuration class for the AutoMl API.
#
# This class represents the configuration for AutoMl,
# providing control over timeouts, retry behavior, logging, transport
# parameters, and other low-level controls. Certain parameters can also be
# applied individually to specific RPCs. See
# {::Google::Cloud::AutoML::V1beta1::AutoML::Client::Configuration::Rpcs}
# for a list of RPCs that can be configured independently.
#
# Configuration can be applied globally to all clients, or to a single client
# on construction.
#
# @example
#
# # Modify the global config, setting the timeout for
# # create_dataset to 20 seconds,
# # and all remaining timeouts to 10 seconds.
# ::Google::Cloud::AutoML::V1beta1::AutoML::Client.configure do |config|
# config.timeout = 10.0
# config.rpcs.create_dataset.timeout = 20.0
# end
#
# # Apply the above configuration only to a new client.
# client = ::Google::Cloud::AutoML::V1beta1::AutoML::Client.new do |config|
# config.timeout = 10.0
# config.rpcs.create_dataset.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"automl.googleapis.com"`.
# @return [::String]
# @!attribute [rw] credentials
# Credentials to send with calls. You may provide any of the following types:
# * (`String`) The path to a service account key file in JSON format
# * (`Hash`) A service account key as a Hash
# * (`Google::Auth::Credentials`) A googleauth credentials object
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
# * (`nil`) indicating no credentials
# @return [::Object]
# @!attribute [rw] scope
# The OAuth scopes
# @return [::Array<::String>]
# @!attribute [rw] lib_name
# The library name as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] lib_version
# The library version as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] channel_args
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
# `GRPC::Core::Channel` object is provided as the credential.
# @return [::Hash]
# @!attribute [rw] interceptors
# An array of interceptors that are run before calls are executed.
# @return [::Array<::GRPC::ClientInterceptor>]
# @!attribute [rw] timeout
# The call timeout in seconds.
# @return [::Numeric]
# @!attribute [rw] metadata
# Additional gRPC headers to be sent with the call.
# @return [::Hash{::Symbol=>::String}]
# @!attribute [rw] retry_policy
# The retry policy. The value is a hash with the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
# @return [::Hash]
# @!attribute [rw] quota_project
# A separate project against which to charge quota.
# @return [::String]
#
class Configuration
extend ::Gapic::Config
config_attr :endpoint, "automl.googleapis.com", ::String
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
allowed.any? { |klass| klass === value }
end
config_attr :scope, nil, ::String, ::Array, nil
config_attr :lib_name, nil, ::String, nil
config_attr :lib_version, nil, ::String, nil
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
config_attr :interceptors, nil, ::Array, nil
config_attr :timeout, nil, ::Numeric, nil
config_attr :metadata, nil, ::Hash, nil
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
config_attr :quota_project, nil, ::String, nil
# @private
def initialize parent_config = nil
@parent_config = parent_config unless parent_config.nil?
yield self if block_given?
end
##
# Configurations for individual RPCs
# @return [Rpcs]
#
def rpcs
@rpcs ||= begin
parent_rpcs = nil
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
Rpcs.new parent_rpcs
end
end
##
# Configuration RPC class for the AutoMl API.
#
# Includes fields providing the configuration for each RPC in this service.
# Each configuration object is of type `Gapic::Config::Method` and includes
# the following configuration fields:
#
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
# include the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
#
class Rpcs
##
# RPC-specific configuration for `create_dataset`
# @return [::Gapic::Config::Method]
#
attr_reader :create_dataset
##
# RPC-specific configuration for `get_dataset`
# @return [::Gapic::Config::Method]
#
attr_reader :get_dataset
##
# RPC-specific configuration for `list_datasets`
# @return [::Gapic::Config::Method]
#
attr_reader :list_datasets
##
# RPC-specific configuration for `update_dataset`
# @return [::Gapic::Config::Method]
#
attr_reader :update_dataset
##
# RPC-specific configuration for `delete_dataset`
# @return [::Gapic::Config::Method]
#
attr_reader :delete_dataset
##
# RPC-specific configuration for `import_data`
# @return [::Gapic::Config::Method]
#
attr_reader :import_data
##
# RPC-specific configuration for `export_data`
# @return [::Gapic::Config::Method]
#
attr_reader :export_data
##
# RPC-specific configuration for `get_annotation_spec`
# @return [::Gapic::Config::Method]
#
attr_reader :get_annotation_spec
##
# RPC-specific configuration for `get_table_spec`
# @return [::Gapic::Config::Method]
#
attr_reader :get_table_spec
##
# RPC-specific configuration for `list_table_specs`
# @return [::Gapic::Config::Method]
#
attr_reader :list_table_specs
##
# RPC-specific configuration for `update_table_spec`
# @return [::Gapic::Config::Method]
#
attr_reader :update_table_spec
##
# RPC-specific configuration for `get_column_spec`
# @return [::Gapic::Config::Method]
#
attr_reader :get_column_spec
##
# RPC-specific configuration for `list_column_specs`
# @return [::Gapic::Config::Method]
#
attr_reader :list_column_specs
##
# RPC-specific configuration for `update_column_spec`
# @return [::Gapic::Config::Method]
#
attr_reader :update_column_spec
##
# RPC-specific configuration for `create_model`
# @return [::Gapic::Config::Method]
#
attr_reader :create_model
##
# RPC-specific configuration for `get_model`
# @return [::Gapic::Config::Method]
#
attr_reader :get_model
##
# RPC-specific configuration for `list_models`
# @return [::Gapic::Config::Method]
#
attr_reader :list_models
##
# RPC-specific configuration for `delete_model`
# @return [::Gapic::Config::Method]
#
attr_reader :delete_model
##
# RPC-specific configuration for `deploy_model`
# @return [::Gapic::Config::Method]
#
attr_reader :deploy_model
##
# RPC-specific configuration for `undeploy_model`
# @return [::Gapic::Config::Method]
#
attr_reader :undeploy_model
##
# RPC-specific configuration for `export_model`
# @return [::Gapic::Config::Method]
#
attr_reader :export_model
##
# RPC-specific configuration for `export_evaluated_examples`
# @return [::Gapic::Config::Method]
#
attr_reader :export_evaluated_examples
##
# RPC-specific configuration for `get_model_evaluation`
# @return [::Gapic::Config::Method]
#
attr_reader :get_model_evaluation
##
# RPC-specific configuration for `list_model_evaluations`
# @return [::Gapic::Config::Method]
#
attr_reader :list_model_evaluations
# @private
def initialize parent_rpcs = nil
create_dataset_config = parent_rpcs.create_dataset if parent_rpcs.respond_to? :create_dataset
@create_dataset = ::Gapic::Config::Method.new create_dataset_config
get_dataset_config = parent_rpcs.get_dataset if parent_rpcs.respond_to? :get_dataset
@get_dataset = ::Gapic::Config::Method.new get_dataset_config
list_datasets_config = parent_rpcs.list_datasets if parent_rpcs.respond_to? :list_datasets
@list_datasets = ::Gapic::Config::Method.new list_datasets_config
update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
@update_dataset = ::Gapic::Config::Method.new update_dataset_config
delete_dataset_config = parent_rpcs.delete_dataset if parent_rpcs.respond_to? :delete_dataset
@delete_dataset = ::Gapic::Config::Method.new delete_dataset_config
import_data_config = parent_rpcs.import_data if parent_rpcs.respond_to? :import_data
@import_data = ::Gapic::Config::Method.new import_data_config
export_data_config = parent_rpcs.export_data if parent_rpcs.respond_to? :export_data
@export_data = ::Gapic::Config::Method.new export_data_config
get_annotation_spec_config = parent_rpcs.get_annotation_spec if parent_rpcs.respond_to? :get_annotation_spec
@get_annotation_spec = ::Gapic::Config::Method.new get_annotation_spec_config
get_table_spec_config = parent_rpcs.get_table_spec if parent_rpcs.respond_to? :get_table_spec
@get_table_spec = ::Gapic::Config::Method.new get_table_spec_config
list_table_specs_config = parent_rpcs.list_table_specs if parent_rpcs.respond_to? :list_table_specs
@list_table_specs = ::Gapic::Config::Method.new list_table_specs_config
update_table_spec_config = parent_rpcs.update_table_spec if parent_rpcs.respond_to? :update_table_spec
@update_table_spec = ::Gapic::Config::Method.new update_table_spec_config
get_column_spec_config = parent_rpcs.get_column_spec if parent_rpcs.respond_to? :get_column_spec
@get_column_spec = ::Gapic::Config::Method.new get_column_spec_config
list_column_specs_config = parent_rpcs.list_column_specs if parent_rpcs.respond_to? :list_column_specs
@list_column_specs = ::Gapic::Config::Method.new list_column_specs_config
update_column_spec_config = parent_rpcs.update_column_spec if parent_rpcs.respond_to? :update_column_spec
@update_column_spec = ::Gapic::Config::Method.new update_column_spec_config
create_model_config = parent_rpcs.create_model if parent_rpcs.respond_to? :create_model
@create_model = ::Gapic::Config::Method.new create_model_config
get_model_config = parent_rpcs.get_model if parent_rpcs.respond_to? :get_model
@get_model = ::Gapic::Config::Method.new get_model_config
list_models_config = parent_rpcs.list_models if parent_rpcs.respond_to? :list_models
@list_models = ::Gapic::Config::Method.new list_models_config
delete_model_config = parent_rpcs.delete_model if parent_rpcs.respond_to? :delete_model
@delete_model = ::Gapic::Config::Method.new delete_model_config
deploy_model_config = parent_rpcs.deploy_model if parent_rpcs.respond_to? :deploy_model
@deploy_model = ::Gapic::Config::Method.new deploy_model_config
undeploy_model_config = parent_rpcs.undeploy_model if parent_rpcs.respond_to? :undeploy_model
@undeploy_model = ::Gapic::Config::Method.new undeploy_model_config
export_model_config = parent_rpcs.export_model if parent_rpcs.respond_to? :export_model
@export_model = ::Gapic::Config::Method.new export_model_config
export_evaluated_examples_config = parent_rpcs.export_evaluated_examples if parent_rpcs.respond_to? :export_evaluated_examples
@export_evaluated_examples = ::Gapic::Config::Method.new export_evaluated_examples_config
get_model_evaluation_config = parent_rpcs.get_model_evaluation if parent_rpcs.respond_to? :get_model_evaluation
@get_model_evaluation = ::Gapic::Config::Method.new get_model_evaluation_config
list_model_evaluations_config = parent_rpcs.list_model_evaluations if parent_rpcs.respond_to? :list_model_evaluations
@list_model_evaluations = ::Gapic::Config::Method.new list_model_evaluations_config
yield self if block_given?
end
end
end
end
end
end
end
end
end