Class: Google::Apis::MlV1::CloudMachineLearningEngineService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/ml_v1/service.rb

Overview

AI Platform Training & Prediction API

An API to enable creating and using machine learning models.

Examples:

require 'google/apis/ml_v1'

Ml = Google::Apis::MlV1 # Alias the module
service = Ml::CloudMachineLearningEngineService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeCloudMachineLearningEngineService

Returns a new instance of CloudMachineLearningEngineService.


45
46
47
48
# File 'generated/google/apis/ml_v1/service.rb', line 45

def initialize
  super('https://ml.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns 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.

Returns:

  • (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.


38
39
40
# File 'generated/google/apis/ml_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns 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.

Returns:

  • (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.


43
44
45
# File 'generated/google/apis/ml_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#add_project_location_study_trial_measurement(name, google_cloud_ml_v1__add_trial_measurement_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Trial

Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.

Parameters:

  • name (String)

    Required. The trial name.

  • google_cloud_ml_v1__add_trial_measurement_request_object (Google::Apis::MlV1::GoogleCloudMlV1AddTrialMeasurementRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


749
750
751
752
753
754
755
756
757
758
759
# File 'generated/google/apis/ml_v1/service.rb', line 749

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

#cancel_project_job(name, google_cloud_ml_v1__cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleProtobufEmpty

Cancels a running job.

Parameters:

  • name (String)

    Required. The name of the job to cancel.

  • google_cloud_ml_v1__cancel_job_request_object (Google::Apis::MlV1::GoogleCloudMlV1CancelJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


174
175
176
177
178
179
180
181
182
183
184
# File 'generated/google/apis/ml_v1/service.rb', line 174

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

#cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleProtobufEmpty

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.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


557
558
559
560
561
562
563
564
565
# File 'generated/google/apis/ml_v1/service.rb', line 557

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

#cancel_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleProtobufEmpty

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.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1585
1586
1587
1588
1589
1590
1591
1592
1593
# File 'generated/google/apis/ml_v1/service.rb', line 1585

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

#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) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

Checks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.

Parameters:

  • name (String)

    Required. The trial name.

  • google_cloud_ml_v1__check_trial_early_stopping_state_request_object (Google::Apis::MlV1::GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


784
785
786
787
788
789
790
791
792
793
794
# File 'generated/google/apis/ml_v1/service.rb', line 784

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

#complete_project_location_study_trial(name, google_cloud_ml_v1__complete_trial_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Trial

Marks a trial as complete.

Parameters:

  • name (String)

    Required. The trial name.metat

  • google_cloud_ml_v1__complete_trial_request_object (Google::Apis::MlV1::GoogleCloudMlV1CompleteTrialRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


817
818
819
820
821
822
823
824
825
826
827
# File 'generated/google/apis/ml_v1/service.rb', line 817

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

#create_project_job(parent, google_cloud_ml_v1__job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Job

Creates a training or a batch prediction job.

Parameters:

  • parent (String)

    Required. The project name.

  • google_cloud_ml_v1__job_object (Google::Apis::MlV1::GoogleCloudMlV1Job) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


207
208
209
210
211
212
213
214
215
216
217
# File 'generated/google/apis/ml_v1/service.rb', line 207

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

#create_project_location_study(parent, google_cloud_ml_v1__study_object = nil, study_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Study

Creates a study.

Parameters:

  • parent (String)

    Required. The project and location that the study belongs to. Format: projects/ project/locations/location

  • google_cloud_ml_v1__study_object (Google::Apis::MlV1::GoogleCloudMlV1Study) (defaults to: nil)
  • study_id (String) (defaults to: nil)

    Required. The ID to use for the study, which will become the final component of the study's resource name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


623
624
625
626
627
628
629
630
631
632
633
634
# File 'generated/google/apis/ml_v1/service.rb', line 623

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

#create_project_location_study_trial(parent, google_cloud_ml_v1__trial_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Trial

Adds a user provided trial to a study.

Parameters:

  • parent (String)

    Required. The name of the study that the trial belongs to.

  • google_cloud_ml_v1__trial_object (Google::Apis::MlV1::GoogleCloudMlV1Trial) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


850
851
852
853
854
855
856
857
858
859
860
# File 'generated/google/apis/ml_v1/service.rb', line 850

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

#create_project_model(parent, google_cloud_ml_v1__model_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Model

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.

Parameters:

  • parent (String)

    Required. The project name.

  • google_cloud_ml_v1__model_object (Google::Apis::MlV1::GoogleCloudMlV1Model) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'generated/google/apis/ml_v1/service.rb', line 1044

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

#create_project_model_version(parent, google_cloud_ml_v1__version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

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.

Parameters:

  • parent (String)

    Required. The name of the model.

  • google_cloud_ml_v1__version_object (Google::Apis::MlV1::GoogleCloudMlV1Version) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
# File 'generated/google/apis/ml_v1/service.rb', line 1348

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

#delete_project_location_study(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleProtobufEmpty

Deletes a study.

Parameters:

  • name (String)

    Required. The study name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


656
657
658
659
660
661
662
663
664
# File 'generated/google/apis/ml_v1/service.rb', line 656

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

#delete_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleProtobufEmpty

Deletes a trial.

Parameters:

  • name (String)

    Required. The trial name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


882
883
884
885
886
887
888
889
890
# File 'generated/google/apis/ml_v1/service.rb', line 882

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

#delete_project_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

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.

Parameters:

  • name (String)

    Required. The name of the model.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'generated/google/apis/ml_v1/service.rb', line 1077

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

#delete_project_model_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

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.

Parameters:

  • name (String)

    Required. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1384
1385
1386
1387
1388
1389
1390
1391
1392
# File 'generated/google/apis/ml_v1/service.rb', line 1384

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

#explain_project(name, google_cloud_ml_v1__explain_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleApiHttpBody

Performs explanation on the data in the request. % dynamic include "/ai- platform/includes/___explain-request" %

Parameters:

  • name (String)

    Required. The resource name of a model or a version. Authorization: requires the predict permission on the specified resource.

  • google_cloud_ml_v1__explain_request_object (Google::Apis::MlV1::GoogleCloudMlV1ExplainRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


73
74
75
76
77
78
79
80
81
82
83
# File 'generated/google/apis/ml_v1/service.rb', line 73

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_project_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1GetConfigResponse

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.

Parameters:

  • name (String)

    Required. The project name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


108
109
110
111
112
113
114
115
116
# File 'generated/google/apis/ml_v1/service.rb', line 108

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

#get_project_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Job

Describes a job.

Parameters:

  • name (String)

    Required. The name of the job to get the description of.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


239
240
241
242
243
244
245
246
247
# File 'generated/google/apis/ml_v1/service.rb', line 239

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

#get_project_job_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The policy format version to be returned. Valid values are 0, 1, and

    1. 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.
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


279
280
281
282
283
284
285
286
287
288
# File 'generated/google/apis/ml_v1/service.rb', line 279

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_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Location

Get the complete list of CMLE capabilities in a location, along with their location-specific properties.

Parameters:

  • name (String)

    Required. The name of the location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


479
480
481
482
483
484
485
486
487
# File 'generated/google/apis/ml_v1/service.rb', line 479

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

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

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.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


588
589
590
591
592
593
594
595
596
# File 'generated/google/apis/ml_v1/service.rb', line 588

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

#get_project_location_study(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Study

Gets a study.

Parameters:

  • name (String)

    Required. The study name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


686
687
688
689
690
691
692
693
694
# File 'generated/google/apis/ml_v1/service.rb', line 686

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

#get_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Trial

Gets a trial.

Parameters:

  • name (String)

    Required. The trial name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


912
913
914
915
916
917
918
919
920
# File 'generated/google/apis/ml_v1/service.rb', line 912

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

#get_project_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Model

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

Parameters:

  • name (String)

    Required. The name of the model.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1109
1110
1111
1112
1113
1114
1115
1116
1117
# File 'generated/google/apis/ml_v1/service.rb', line 1109

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

#get_project_model_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The policy format version to be returned. Valid values are 0, 1, and

    1. 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.
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
# File 'generated/google/apis/ml_v1/service.rb', line 1149

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

#get_project_model_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Version

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.

Parameters:

  • name (String)

    Required. The name of the version.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1416
1417
1418
1419
1420
1421
1422
1423
1424
# File 'generated/google/apis/ml_v1/service.rb', line 1416

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

#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

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.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1616
1617
1618
1619
1620
1621
1622
1623
1624
# File 'generated/google/apis/ml_v1/service.rb', line 1616

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

#list_project_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1ListJobsResponse

Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: ``.

Parameters:

  • parent (String)

    Required. The name of the project for which to list jobs.

  • filter (String) (defaults to: nil)

    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.

  • page_size (Fixnum) (defaults to: nil)

    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.

  • page_token (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


326
327
328
329
330
331
332
333
334
335
336
337
# File 'generated/google/apis/ml_v1/service.rb', line 326

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

#list_project_location_studies(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1ListStudiesResponse

Lists all the studies in a region for an associated project.

Parameters:

  • parent (String)

    Required. The project and location that the study belongs to. Format: projects/ project/locations/location

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


717
718
719
720
721
722
723
724
725
# File 'generated/google/apis/ml_v1/service.rb', line 717

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

#list_project_location_study_trials(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1ListTrialsResponse

Lists the trials associated with a study.

Parameters:

  • parent (String)

    Required. The name of the study that the trial belongs to.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


942
943
944
945
946
947
948
949
950
# File 'generated/google/apis/ml_v1/service.rb', line 942

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_project_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1ListLocationsResponse

List all locations that provides at least one type of CMLE capability.

Parameters:

  • parent (String)

    Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).

  • page_size (Fixnum) (defaults to: nil)

    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.

  • page_token (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


518
519
520
521
522
523
524
525
526
527
528
# File 'generated/google/apis/ml_v1/service.rb', line 518

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

#list_project_model_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse

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: ``.

Parameters:

  • parent (String)

    Required. The name of the model for which to list the version.

  • filter (String) (defaults to: nil)

    Optional. Specifies the subset of versions to retrieve.

  • page_size (Fixnum) (defaults to: nil)

    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.

  • page_token (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
# File 'generated/google/apis/ml_v1/service.rb', line 1460

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

#list_project_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse

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: ``.

Parameters:

  • parent (String)

    Required. The name of the project whose models are to be listed.

  • filter (String) (defaults to: nil)

    Optional. Specifies the subset of models to retrieve.

  • page_size (Fixnum) (defaults to: nil)

    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.

  • page_token (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
# File 'generated/google/apis/ml_v1/service.rb', line 1192

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

#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningListOperationsResponse

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.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
# File 'generated/google/apis/ml_v1/service.rb', line 1659

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

#patch_project_job(name, google_cloud_ml_v1__job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Job

Updates a specific job resource. Currently the only supported fields to update are labels.

Parameters:

  • name (String)

    Required. The job name.

  • google_cloud_ml_v1__job_object (Google::Apis::MlV1::GoogleCloudMlV1Job) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


371
372
373
374
375
376
377
378
379
380
381
382
# File 'generated/google/apis/ml_v1/service.rb', line 371

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

#patch_project_model(name, google_cloud_ml_v1__model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

Updates a specific model resource. Currently the only supported fields to update are description and default_version.name.

Parameters:

  • name (String)

    Required. The project name.

  • google_cloud_ml_v1__model_object (Google::Apis::MlV1::GoogleCloudMlV1Model) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
# File 'generated/google/apis/ml_v1/service.rb', line 1235

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

#patch_project_model_version(name, google_cloud_ml_v1__version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

Updates the specified Version resource. Currently the only update-able fields are description, requestLoggingConfig, autoScaling.minNodes, and manualScaling.nodes.

Parameters:

  • name (String)

    Required. The name of the model.

  • google_cloud_ml_v1__version_object (Google::Apis::MlV1::GoogleCloudMlV1Version) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
# File 'generated/google/apis/ml_v1/service.rb', line 1506

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

#predict_project(name, google_cloud_ml_v1__predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleApiHttpBody

Performs online prediction on the data in the request. % dynamic include "/ai- platform/includes/___predict-request" %

Parameters:

  • name (String)

    Required. The resource name of a model or a version. Authorization: requires the predict permission on the specified resource.

  • google_cloud_ml_v1__predict_request_object (Google::Apis::MlV1::GoogleCloudMlV1PredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


141
142
143
144
145
146
147
148
149
150
151
# File 'generated/google/apis/ml_v1/service.rb', line 141

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

#set_project_job_iam_policy(resource, google_iam_v1__set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • google_iam_v1__set_iam_policy_request_object (Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


408
409
410
411
412
413
414
415
416
417
418
# File 'generated/google/apis/ml_v1/service.rb', line 408

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

#set_project_model_iam_policy(resource, google_iam_v1__set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • google_iam_v1__set_iam_policy_request_object (Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'generated/google/apis/ml_v1/service.rb', line 1272

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

#set_project_model_version_default(name, google_cloud_ml_v1__set_default_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Version

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.

Parameters:

  • name (String)

    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.

  • google_cloud_ml_v1__set_default_version_request_object (Google::Apis::MlV1::GoogleCloudMlV1SetDefaultVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
# File 'generated/google/apis/ml_v1/service.rb', line 1546

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

#stop_project_location_study_trial(name, google_cloud_ml_v1__stop_trial_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleCloudMlV1Trial

Stops a trial.

Parameters:

  • name (String)

    Required. The trial name.

  • google_cloud_ml_v1__stop_trial_request_object (Google::Apis::MlV1::GoogleCloudMlV1StopTrialRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


973
974
975
976
977
978
979
980
981
982
983
# File 'generated/google/apis/ml_v1/service.rb', line 973

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

#suggest_project_location_study_trial(parent, google_cloud_ml_v1__suggest_trials_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleLongrunningOperation

Adds one or more trials to a study, with parameter values suggested by AI Platform Optimizer. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.

Parameters:

  • parent (String)

    Required. The name of the study that the trial belongs to.

  • google_cloud_ml_v1__suggest_trials_request_object (Google::Apis::MlV1::GoogleCloudMlV1SuggestTrialsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
# File 'generated/google/apis/ml_v1/service.rb', line 1009

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

#test_project_job_iam_permissions(resource, google_iam_v1__test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse

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.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • google_iam_v1__test_iam_permissions_request_object (Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


446
447
448
449
450
451
452
453
454
455
456
# File 'generated/google/apis/ml_v1/service.rb', line 446

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

#test_project_model_iam_permissions(resource, google_iam_v1__test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse

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.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • google_iam_v1__test_iam_permissions_request_object (Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
# File 'generated/google/apis/ml_v1/service.rb', line 1310

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