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

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

Overview

Cloud Machine Learning Engine

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

#initialize ⇒ CloudMachineLearningEngineService

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

#key ⇒ String

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_user ⇒ String

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

#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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    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 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_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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'generated/google/apis/ml_v1/service.rb', line 1034

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

#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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    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 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_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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



475
476
477
478
479
480
481
482
483
484
485
 
# File 'generated/google/apis/ml_v1/service.rb', line 475

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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_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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



511
512
513
514
515
516
517
518
519
 
# File 'generated/google/apis/ml_v1/service.rb', line 511

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



825
826
827
828
829
830
831
832
833
 
# File 'generated/google/apis/ml_v1/service.rb', line 825

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

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

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'generated/google/apis/ml_v1/service.rb', line 1067

def delete_project_operation(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

#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 persmissions 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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    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_iam_policy(resource, 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['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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



398
399
400
401
402
403
404
405
406
 
# File 'generated/google/apis/ml_v1/service.rb', line 398

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_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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



543
544
545
546
547
548
549
550
551
 
# File 'generated/google/apis/ml_v1/service.rb', line 543

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



576
577
578
579
580
581
582
583
584
 
# File 'generated/google/apis/ml_v1/service.rb', line 576

def get_project_model_iam_policy(resource, 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['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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



860
861
862
863
864
865
866
867
868
 
# File 'generated/google/apis/ml_v1/service.rb', line 860

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'generated/google/apis/ml_v1/service.rb', line 1099

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

    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 ml-engine jobs list --filter='jobId:census*'

    List all failed jobs with names that start with 'rnn':

    gcloud ml-engine jobs list --filter='jobId:rnn* AND state:FAILED'

    For more examples, see the guide to monitoring jobs.

  • page_size (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'generated/google/apis/ml_v1/service.rb', line 290

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_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) —

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

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



438
439
440
441
442
443
444
445
446
447
448
 
# File 'generated/google/apis/ml_v1/service.rb', line 438

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

    Optional. Specifies the subset of versions to retrieve.

  • page_size (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'generated/google/apis/ml_v1/service.rb', line 906

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

    Optional. Specifies the subset of models to retrieve.

  • page_size (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'generated/google/apis/ml_v1/service.rb', line 1143

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_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) —

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'generated/google/apis/ml_v1/service.rb', line 671

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 supported field to update is description.

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'generated/google/apis/ml_v1/service.rb', line 951

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 prediction on the data in the request. Cloud ML Engine implements a custom predict verb on top of an HTTP POST method.

For details of the request and response format, see the guide to the predict request format.

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    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
 
# File 'generated/google/apis/ml_v1/service.rb', line 326

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.

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



707
708
709
710
711
712
713
714
715
716
717
 
# File 'generated/google/apis/ml_v1/service.rb', line 707

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'generated/google/apis/ml_v1/service.rb', line 993

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

#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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



365
366
367
368
369
370
371
372
373
374
375
 
# File 'generated/google/apis/ml_v1/service.rb', line 365

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



746
747
748
749
750
751
752
753
754
755
756
 
# File 'generated/google/apis/ml_v1/service.rb', line 746

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