class Google::Apis::FirebasemlV1beta2::FirebaseMLService
Firebase ML API
Access custom machine learning models hosted via Firebase ML.
@example
require 'google/apis/firebaseml_v1beta2' Firebaseml = Google::Apis::FirebasemlV1beta2 # Alias the module service = Firebaseml::FirebaseMLService.new
@see firebase.google.com
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
Public Class Methods
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 45 def initialize super('https://firebaseml.googleapis.com/', '', client_name: 'google-apis-firebaseml_v1beta2', client_version: Google::Apis::FirebasemlV1beta2::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Creates a model in Firebase ML. The longrunning operation will eventually return a Model
@param [String] parent
Required. The parent project resource where the model is to be created. The parent must have the form `projects/`project_id``
@param [Google::Apis::FirebasemlV1beta2::Model] model_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::FirebasemlV1beta2::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasemlV1beta2::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 75 def create_project_model(parent, model_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+parent}/models', options) command.request_representation = Google::Apis::FirebasemlV1beta2::Model::Representation command.request_object = model_object command.response_representation = Google::Apis::FirebasemlV1beta2::Operation::Representation command.response_class = Google::Apis::FirebasemlV1beta2::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes a model @param [String] name
Required. The name of the model to delete. The name must have the form ` projects/`project_id`/models/`model_id``
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::FirebasemlV1beta2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasemlV1beta2::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 108 def delete_project_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::FirebasemlV1beta2::Empty::Representation command.response_class = Google::Apis::FirebasemlV1beta2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets Download information for a model. This is meant for downloading model resources onto devices. It gives very limited information about the model. @param [String] name
Required. The name of the model to download. The name must have the form ` projects/`project`/models/`model``
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::FirebasemlV1beta2::DownloadModelResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasemlV1beta2::DownloadModelResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 140 def download_project_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}:download', options) command.response_representation = Google::Apis::FirebasemlV1beta2::DownloadModelResponse::Representation command.response_class = Google::Apis::FirebasemlV1beta2::DownloadModelResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets a model resource. @param [String] name
Required. The name of the model to get. The name must have the form `projects/` project_id`/models/`model_id``
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::FirebasemlV1beta2::Model] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasemlV1beta2::Model]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 171 def get_project_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::FirebasemlV1beta2::Model::Representation command.response_class = Google::Apis::FirebasemlV1beta2::Model command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. @param [String] name
The name of the operation resource.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::FirebasemlV1beta2::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasemlV1beta2::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 280 def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::FirebasemlV1beta2::Operation::Representation command.response_class = Google::Apis::FirebasemlV1beta2::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists the models @param [String] parent
Required. The name of the parent to list models for. The parent must have the form `projects/`project_id`'
@param [String] filter
A filter for the list e.g. 'tags: abc' to list models which are tagged with " abc"
@param [Fixnum] page_size
The maximum number of items to return
@param [String] page_token
The next_page_token value returned from a previous List request, if any.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::FirebasemlV1beta2::ListModelsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasemlV1beta2::ListModelsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 209 def list_project_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+parent}/models', options) command.response_representation = Google::Apis::FirebasemlV1beta2::ListModelsResponse::Representation command.response_class = Google::Apis::FirebasemlV1beta2::ListModelsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Updates a model. The longrunning operation will eventually return a Model
. @param [String] name
The resource name of the Model. Model names have the form `projects/` project_id`/models/`model_id`` The name is ignored when creating a model.
@param [Google::Apis::FirebasemlV1beta2::Model] model_object @param [String] update_mask
The update mask
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::FirebasemlV1beta2::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasemlV1beta2::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 246 def patch_project_model(name, model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta2/{+name}', options) command.request_representation = Google::Apis::FirebasemlV1beta2::Model::Representation command.request_object = model_object command.response_representation = Google::Apis::FirebasemlV1beta2::Operation::Representation command.response_class = Google::Apis::FirebasemlV1beta2::Operation command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File lib/google/apis/firebaseml_v1beta2/service.rb, line 292 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end