class Google::Apis::MlV1::CloudMachineLearningEngineService
AI Platform Training & Prediction API
An API to enable creating and using machine learning models.
@example
require 'google/apis/ml_v1' Ml = Google::Apis::MlV1 # Alias the module service = Ml::CloudMachineLearningEngineService.new
@see cloud.google.com/ml/
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/ml_v1/service.rb, line 45 def initialize super('https://ml.googleapis.com/', '', client_name: 'google-apis-ml_v1', client_version: Google::Apis::MlV1::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete. @param [String] name
Required. The trial name.
@param [Google::Apis::MlV1::GoogleCloudMlV1AddTrialMeasurementRequest] google_cloud_ml_v1__add_trial_measurement_request_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::MlV1::GoogleCloudMlV1Trial] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Trial]
@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/ml_v1/service.rb, line 751 def add_project_location_study_trial_measurement(name, google_cloud_ml_v1__add_trial_measurement_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:addMeasurement', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1AddTrialMeasurementRequest::Representation command.request_object = google_cloud_ml_v1__add_trial_measurement_request_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Trial::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Trial 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
Cancels a running job. @param [String] name
Required. The name of the job to cancel.
@param [Google::Apis::MlV1::GoogleCloudMlV1CancelJobRequest] google_cloud_ml_v1__cancel_job_request_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::MlV1::GoogleProtobufEmpty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleProtobufEmpty]
@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/ml_v1/service.rb, line 176 def cancel_project_job(name, google_cloud_ml_v1__cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1CancelJobRequest::Representation command.request_object = google_cloud_ml_v1__cancel_job_request_object command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::GoogleProtobufEmpty 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
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. @param [String] name
The name of the operation resource to be cancelled.
@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::MlV1::GoogleProtobufEmpty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleProtobufEmpty]
@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/ml_v1/service.rb, line 559 def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::GoogleProtobufEmpty 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
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. @param [String] name
The name of the operation resource to be cancelled.
@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::MlV1::GoogleProtobufEmpty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleProtobufEmpty]
@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/ml_v1/service.rb, line 1622 def cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::GoogleProtobufEmpty 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
Checks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. @param [String] name
Required. The trial name.
@param [Google::Apis::MlV1::GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest] google_cloud_ml_v1__check_trial_early_stopping_state_request_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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 786 def check_project_location_study_trial_early_stopping_state(name, google_cloud_ml_v1__check_trial_early_stopping_state_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:checkEarlyStoppingState', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest::Representation command.request_object = google_cloud_ml_v1__check_trial_early_stopping_state_request_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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
Marks a trial as complete. @param [String] name
Required. The trial name.metat
@param [Google::Apis::MlV1::GoogleCloudMlV1CompleteTrialRequest] google_cloud_ml_v1__complete_trial_request_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::MlV1::GoogleCloudMlV1Trial] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Trial]
@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/ml_v1/service.rb, line 819 def complete_project_location_study_trial(name, google_cloud_ml_v1__complete_trial_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:complete', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1CompleteTrialRequest::Representation command.request_object = google_cloud_ml_v1__complete_trial_request_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Trial::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Trial 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
Creates a training or a batch prediction job. @param [String] parent
Required. The project name.
@param [Google::Apis::MlV1::GoogleCloudMlV1Job] google_cloud_ml_v1__job_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::MlV1::GoogleCloudMlV1Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Job]
@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/ml_v1/service.rb, line 209 def create_project_job(parent, google_cloud_ml_v1__job_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/jobs', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.request_object = google_cloud_ml_v1__job_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Job 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
Creates a study. @param [String] parent
Required. The project and location that the study belongs to. Format: projects/ `project`/locations/`location`
@param [Google::Apis::MlV1::GoogleCloudMlV1Study] google_cloud_ml_v1__study_object @param [String] study_id
Required. The ID to use for the study, which will become the final component of the study's resource name.
@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::MlV1::GoogleCloudMlV1Study] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Study]
@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/ml_v1/service.rb, line 625 def create_project_location_study(parent, google_cloud_ml_v1__study_object = nil, study_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/studies', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Study::Representation command.request_object = google_cloud_ml_v1__study_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Study::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Study command.params['parent'] = parent unless parent.nil? command.query['studyId'] = study_id unless study_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Adds a user provided trial to a study. @param [String] parent
Required. The name of the study that the trial belongs to.
@param [Google::Apis::MlV1::GoogleCloudMlV1Trial] google_cloud_ml_v1__trial_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::MlV1::GoogleCloudMlV1Trial] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Trial]
@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/ml_v1/service.rb, line 852 def create_project_location_study_trial(parent, google_cloud_ml_v1__trial_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/trials', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Trial::Representation command.request_object = google_cloud_ml_v1__trial_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Trial::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Trial 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
Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create. @param [String] parent
Required. The project name.
@param [Google::Apis::MlV1::GoogleCloudMlV1Model] google_cloud_ml_v1__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::MlV1::GoogleCloudMlV1Model] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Model]
@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/ml_v1/service.rb, line 1081 def create_project_model(parent, google_cloud_ml_v1__model_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/models', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation command.request_object = google_cloud_ml_v1__model_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Model 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
Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault. @param [String] parent
Required. The name of the model.
@param [Google::Apis::MlV1::GoogleCloudMlV1Version] google_cloud_ml_v1__version_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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 1385 def create_project_model_version(parent, google_cloud_ml_v1__version_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/versions', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation command.request_object = google_cloud_ml_v1__version_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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 study. @param [String] name
Required. The study name.
@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::MlV1::GoogleProtobufEmpty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleProtobufEmpty]
@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/ml_v1/service.rb, line 658 def delete_project_location_study(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::GoogleProtobufEmpty 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
Deletes a trial. @param [String] name
Required. The trial name.
@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::MlV1::GoogleProtobufEmpty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleProtobufEmpty]
@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/ml_v1/service.rb, line 884 def delete_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::GoogleProtobufEmpty 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
Deletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling projects.models.versions.delete. @param [String] name
Required. The name of the 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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 1114 def delete_project_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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
Deletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version. @param [String] name
Required. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list.
@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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 1421 def delete_project_model_version(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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
Performs explanation on the data in the request. `% dynamic include “/ai- platform/includes/___explain-request” %` @param [String] name
Required. The resource name of a model or a version. Authorization: requires the `predict` permission on the specified resource.
@param [Google::Apis::MlV1::GoogleCloudMlV1ExplainRequest] google_cloud_ml_v1__explain_request_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::MlV1::GoogleApiHttpBody] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleApiHttpBody]
@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/ml_v1/service.rb, line 75 def explain_project(name, google_cloud_ml_v1__explain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:explain', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1ExplainRequest::Representation command.request_object = google_cloud_ml_v1__explain_request_object command.response_representation = Google::Apis::MlV1::GoogleApiHttpBody::Representation command.response_class = Google::Apis::MlV1::GoogleApiHttpBody 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
Get the service account information associated with your project. You need this information in order to grant the service account permissions for the Google
Cloud Storage location where you put your model training code for training the model with Google
Cloud Machine Learning. @param [String] name
Required. The project name.
@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::MlV1::GoogleCloudMlV1GetConfigResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1GetConfigResponse]
@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/ml_v1/service.rb, line 110 def get_project_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}:getConfig', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1GetConfigResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1GetConfigResponse 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
Describes a job. @param [String] name
Required. The name of the job to get the description of.
@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::MlV1::GoogleCloudMlV1Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Job]
@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/ml_v1/service.rb, line 241 def get_project_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Job 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 access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @param [String] resource
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
@param [Fixnum] options_requested_policy_version
Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ resource-policies).
@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::MlV1::GoogleIamV1Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleIamV1Policy]
@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/ml_v1/service.rb, line 281 def get_project_job_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::GoogleIamV1Policy command.params['resource'] = resource unless resource.nil? command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Get the complete list of CMLE capabilities in a location, along with their location-specific properties. @param [String] name
Required. The name of the location.
@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::MlV1::GoogleCloudMlV1Location] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Location]
@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/ml_v1/service.rb, line 481 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Location::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Location 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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 590 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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 study. @param [String] name
Required. The study name.
@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::MlV1::GoogleCloudMlV1Study] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Study]
@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/ml_v1/service.rb, line 688 def get_project_location_study(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Study::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Study 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 trial. @param [String] name
Required. The trial name.
@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::MlV1::GoogleCloudMlV1Trial] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Trial]
@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/ml_v1/service.rb, line 914 def get_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Trial::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Trial 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 information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed). @param [String] name
Required. The name of the 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::MlV1::GoogleCloudMlV1Model] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Model]
@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/ml_v1/service.rb, line 1146 def get_project_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Model 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 access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @param [String] resource
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
@param [Fixnum] options_requested_policy_version
Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ resource-policies).
@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::MlV1::GoogleIamV1Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleIamV1Policy]
@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/ml_v1/service.rb, line 1186 def get_project_model_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::GoogleIamV1Policy command.params['resource'] = resource unless resource.nil? command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.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 information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model. @param [String] name
Required. The name of the version.
@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::MlV1::GoogleCloudMlV1Version] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Version]
@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/ml_v1/service.rb, line 1453 def get_project_model_version(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Version 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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 1653 def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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 jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: “. @param [String] parent
Required. The name of the project for which to list jobs.
@param [String] filter
Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list - -filter='jobId:census*' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED' For more examples, see the guide to monitoring jobs.
@param [Fixnum] page_size
Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
@param [String] page_token
Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
@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::MlV1::GoogleCloudMlV1ListJobsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1ListJobsResponse]
@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/ml_v1/service.rb, line 328 def list_project_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/jobs', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListJobsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListJobsResponse 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
Lists all the studies in a region for an associated project. @param [String] parent
Required. The project and location that the study belongs to. Format: projects/ `project`/locations/`location`
@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::MlV1::GoogleCloudMlV1ListStudiesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1ListStudiesResponse]
@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/ml_v1/service.rb, line 719 def list_project_location_studies(parent, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/studies', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListStudiesResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListStudiesResponse 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
Lists the pareto-optimal trials for multi-objective study or the optimal trials for single-objective study. The definition of pareto-optimal can be checked in wiki page. en.wikipedia.org/wiki/Pareto_efficiency @param [String] parent
Required. The name of the study that the pareto-optimal trial belongs to.
@param [Google::Apis::MlV1::GoogleCloudMlV1ListOptimalTrialsRequest] google_cloud_ml_v1__list_optimal_trials_request_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::MlV1::GoogleCloudMlV1ListOptimalTrialsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1ListOptimalTrialsResponse]
@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/ml_v1/service.rb, line 977 def list_project_location_study_trial_optimal_trials(parent, google_cloud_ml_v1__list_optimal_trials_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/trials:listOptimalTrials', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1ListOptimalTrialsRequest::Representation command.request_object = google_cloud_ml_v1__list_optimal_trials_request_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListOptimalTrialsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListOptimalTrialsResponse 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
Lists the trials associated with a study. @param [String] parent
Required. The name of the study that the trial belongs to.
@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::MlV1::GoogleCloudMlV1ListTrialsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1ListTrialsResponse]
@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/ml_v1/service.rb, line 944 def list_project_location_study_trials(parent, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/trials', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListTrialsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListTrialsResponse 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
List all locations that provides at least one type of CMLE capability. @param [String] parent
Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).
@param [Fixnum] page_size
Optional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
@param [String] page_token
Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
@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::MlV1::GoogleCloudMlV1ListLocationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1ListLocationsResponse]
@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/ml_v1/service.rb, line 520 def list_project_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/locations', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListLocationsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListLocationsResponse command.params['parent'] = parent unless parent.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
Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches ( called pages). If there are no versions that match the request parameters, the list request returns an empty response body: “. @param [String] parent
Required. The name of the model for which to list the version.
@param [String] filter
Optional. Specifies the subset of versions to retrieve.
@param [Fixnum] page_size
Optional. The number of versions to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
@param [String] page_token
Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
@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::MlV1::GoogleCloudMlV1ListVersionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse]
@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/ml_v1/service.rb, line 1497 def list_project_model_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/versions', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse 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
Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: “. @param [String] parent
Required. The name of the project whose models are to be listed.
@param [String] filter
Optional. Specifies the subset of models to retrieve.
@param [Fixnum] page_size
Optional. The number of models to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.
@param [String] page_token
Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.
@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::MlV1::GoogleCloudMlV1ListModelsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse]
@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/ml_v1/service.rb, line 1229 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, 'v1/{+parent}/models', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse 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
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `“/v1/`name=users/*`/operations”` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. @param [String] name
The name of the operation's parent resource.
@param [String] filter
The standard list filter.
@param [Fixnum] page_size
The standard list page size.
@param [String] page_token
The standard list page token.
@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::MlV1::GoogleLongrunningListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningListOperationsResponse]
@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/ml_v1/service.rb, line 1696 def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/operations', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningListOperationsResponse command.params['name'] = name unless name.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 specific job resource. Currently the only supported fields to update are `labels`. @param [String] name
Required. The job name.
@param [Google::Apis::MlV1::GoogleCloudMlV1Job] google_cloud_ml_v1__job_object @param [String] update_mask
Required. Specifies the path, relative to `Job`, of the field to update. To adopt etag mechanism, include `etag` field in the mask, and include the `etag` value in your job resource. For example, to change the labels of a job, the ` update_mask` parameter would be specified as `labels`, `etag`, and the `PATCH` request body would specify the new value, as follows: ` "labels": ` "owner": " Google", "color": "Blue" ` "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" ` If `etag` matches the one on the server, the labels of the job will be replaced with the given ones, and the server end `etag` will be recalculated. Currently the only supported update masks are `labels` and `etag`.
@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::MlV1::GoogleCloudMlV1Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Job]
@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/ml_v1/service.rb, line 373 def patch_project_job(name, google_cloud_ml_v1__job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.request_object = google_cloud_ml_v1__job_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Job 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
Updates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`. @param [String] name
Required. The project name.
@param [Google::Apis::MlV1::GoogleCloudMlV1Model] google_cloud_ml_v1__model_object @param [String] update_mask
Required. Specifies the path, relative to `Model`, of the field to update. For example, to change the description of a model to "foo" and set its default version to "version_1", the `update_mask` parameter would be specified as ` description`, `default_version.name`, and the `PATCH` request body would specify the new value, as follows: ` "description": "foo", "defaultVersion": ` "name":"version_1" ` ` Currently the supported update masks are `description` and `default_version.name`.
@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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 1272 def patch_project_model(name, google_cloud_ml_v1__model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation command.request_object = google_cloud_ml_v1__model_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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
Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and ` manualScaling.nodes`. @param [String] name
Required. The name of the model.
@param [Google::Apis::MlV1::GoogleCloudMlV1Version] google_cloud_ml_v1__version_object @param [String] update_mask
Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as ` description`, and the `PATCH` request body would specify the new value, as follows: ``` ` "description": "foo" ` ``` Currently the only supported update mask fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/ machine-types-online-prediction).
@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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 1543 def patch_project_model_version(name, google_cloud_ml_v1__version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation command.request_object = google_cloud_ml_v1__version_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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
Performs online prediction on the data in the request. `% dynamic include “/ai- platform/includes/___predict-request” %` @param [String] name
Required. The resource name of a model or a version. Authorization: requires the `predict` permission on the specified resource.
@param [Google::Apis::MlV1::GoogleCloudMlV1PredictRequest] google_cloud_ml_v1__predict_request_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::MlV1::GoogleApiHttpBody] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleApiHttpBody]
@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/ml_v1/service.rb, line 143 def predict_project(name, google_cloud_ml_v1__predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:predict', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1PredictRequest::Representation command.request_object = google_cloud_ml_v1__predict_request_object command.response_representation = Google::Apis::MlV1::GoogleApiHttpBody::Representation command.response_class = Google::Apis::MlV1::GoogleApiHttpBody 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
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1__set_iam_policy_request_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::MlV1::GoogleIamV1Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleIamV1Policy]
@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/ml_v1/service.rb, line 410 def set_project_job_iam_policy(resource, google_iam_v1__set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest::Representation command.request_object = google_iam_v1__set_iam_policy_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::GoogleIamV1Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1__set_iam_policy_request_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::MlV1::GoogleIamV1Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleIamV1Policy]
@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/ml_v1/service.rb, line 1309 def set_project_model_iam_policy(resource, google_iam_v1__set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest::Representation command.request_object = google_iam_v1__set_iam_policy_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::GoogleIamV1Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Designates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method. @param [String] name
Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling projects.models. versions.list.
@param [Google::Apis::MlV1::GoogleCloudMlV1SetDefaultVersionRequest] google_cloud_ml_v1__set_default_version_request_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::MlV1::GoogleCloudMlV1Version] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Version]
@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/ml_v1/service.rb, line 1583 def set_project_model_version_default(name, google_cloud_ml_v1__set_default_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:setDefault', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1SetDefaultVersionRequest::Representation command.request_object = google_cloud_ml_v1__set_default_version_request_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Version 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
Stops a trial. @param [String] name
Required. The trial name.
@param [Google::Apis::MlV1::GoogleCloudMlV1StopTrialRequest] google_cloud_ml_v1__stop_trial_request_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::MlV1::GoogleCloudMlV1Trial] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleCloudMlV1Trial]
@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/ml_v1/service.rb, line 1010 def stop_project_location_study_trial(name, google_cloud_ml_v1__stop_trial_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:stop', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1StopTrialRequest::Representation command.request_object = google_cloud_ml_v1__stop_trial_request_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Trial::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Trial 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
Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. @param [String] parent
Required. The name of the study that the trial belongs to.
@param [Google::Apis::MlV1::GoogleCloudMlV1SuggestTrialsRequest] google_cloud_ml_v1__suggest_trials_request_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::MlV1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleLongrunningOperation]
@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/ml_v1/service.rb, line 1046 def suggest_project_location_study_trial(parent, google_cloud_ml_v1__suggest_trials_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/trials:suggest', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1SuggestTrialsRequest::Representation command.request_object = google_cloud_ml_v1__suggest_trials_request_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a ` NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning. @param [String] resource
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1__test_iam_permissions_request_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::MlV1::GoogleIamV1TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse]
@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/ml_v1/service.rb, line 448 def test_project_job_iam_permissions(resource, google_iam_v1__test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest::Representation command.request_object = google_iam_v1__test_iam_permissions_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a ` NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning. @param [String] resource
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1__test_iam_permissions_request_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::MlV1::GoogleIamV1TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse]
@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/ml_v1/service.rb, line 1347 def test_project_model_iam_permissions(resource, google_iam_v1__test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest::Representation command.request_object = google_iam_v1__test_iam_permissions_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse command.params['resource'] = resource unless resource.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/ml_v1/service.rb, line 1711 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end