Class: Google::Cloud::AIPlatform::V1::JobService::Client

Inherits:

Object

Object
Google::Cloud::AIPlatform::V1::JobService::Client

show all

Includes:: Paths

Defined in:: lib/google/cloud/ai_platform/v1/job_service/client.rb

Overview

Client for the JobService service.

A service for creating and managing Vertex AI's jobs.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client readonly
Get the associated client for mix-in of the IAMPolicy.
#location_client ⇒ Google::Cloud::Location::Locations::Client readonly
Get the associated client for mix-in of the Locations.
#operations_client ⇒ ::Google::Cloud::AIPlatform::V1::JobService::Operations readonly
Get the associated client for long-running operations.

Class Method Summary collapse

.configure {|config| ... } ⇒ Client::Configuration
Configure the JobService Client class.

Instance Method Summary collapse

#cancel_batch_prediction_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Cancels a BatchPredictionJob.
#cancel_custom_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Cancels a CustomJob.
#cancel_data_labeling_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Cancels a DataLabelingJob.
#cancel_hyperparameter_tuning_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Cancels a HyperparameterTuningJob.
#cancel_nas_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Cancels a NasJob.
#configure {|config| ... } ⇒ Client::Configuration
Configure the JobService Client instance.
#create_batch_prediction_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob
Creates a BatchPredictionJob.
#create_custom_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob
Creates a CustomJob.
#create_data_labeling_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob
Creates a DataLabelingJob.
#create_hyperparameter_tuning_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob
Creates a HyperparameterTuningJob.
#create_model_deployment_monitoring_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob
Creates a ModelDeploymentMonitoringJob.
#create_nas_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::NasJob
Creates a NasJob.
#delete_batch_prediction_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a BatchPredictionJob.
#delete_custom_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a CustomJob.
#delete_data_labeling_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a DataLabelingJob.
#delete_hyperparameter_tuning_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a HyperparameterTuningJob.
#delete_model_deployment_monitoring_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a ModelDeploymentMonitoringJob.
#delete_nas_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a NasJob.
#get_batch_prediction_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob
Gets a BatchPredictionJob.
#get_custom_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob
Gets a CustomJob.
#get_data_labeling_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob
Gets a DataLabelingJob.
#get_hyperparameter_tuning_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob
Gets a HyperparameterTuningJob.
#get_model_deployment_monitoring_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob
Gets a ModelDeploymentMonitoringJob.
#get_nas_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::NasJob
Gets a NasJob.
#get_nas_trial_detail(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::NasTrialDetail
Gets a NasTrialDetail.
#initialize {|config| ... } ⇒ Client constructor
Create a new JobService client object.
#list_batch_prediction_jobs(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>
Lists BatchPredictionJobs in a Location.
#list_custom_jobs(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>
Lists CustomJobs in a Location.
#list_data_labeling_jobs(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataLabelingJob>
Lists DataLabelingJobs in a Location.
#list_hyperparameter_tuning_jobs(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>
Lists HyperparameterTuningJobs in a Location.
#list_model_deployment_monitoring_jobs(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob>
Lists ModelDeploymentMonitoringJobs in a Location.
#list_nas_jobs(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>
Lists NasJobs in a Location.
#list_nas_trial_details(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>
List top NasTrialDetails of a NasJob.
#logger ⇒ Logger
The logger used for request/response debug logging.
#pause_model_deployment_monitoring_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Pauses a ModelDeploymentMonitoringJob.
#resume_model_deployment_monitoring_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Resumes a paused ModelDeploymentMonitoringJob.
#search_model_deployment_monitoring_stats_anomalies(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies>
Searches Model Monitoring Statistics generated within a given time window.
#universe_domain ⇒ String
The effective universe domain.
#update_model_deployment_monitoring_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates a ModelDeploymentMonitoringJob.

Methods included from Paths

#batch_prediction_job_path, #context_path, #custom_job_path, #data_labeling_job_path, #dataset_path, #endpoint_path, #hyperparameter_tuning_job_path, #location_path, #model_deployment_monitoring_job_path, #model_path, #nas_job_path, #nas_trial_detail_path, #network_attachment_path, #network_path, #notification_channel_path, #persistent_resource_path, #reservation_path, #tensorboard_path, #trial_path

Constructor Details

#initialize {|config| ... } ⇒ `Client`

Create a new JobService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::JobService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the JobService client.

Yield Parameters:

config (Client::Configuration)

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 126

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/aiplatform/v1/job_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @job_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::AIPlatform::V1::JobService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @job_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @job_service_stub.endpoint
    config.universe_domain = @job_service_stub.universe_domain
    config.logger = @job_service_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @job_service_stub.endpoint
    config.universe_domain = @job_service_stub.universe_domain
    config.logger = @job_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ `Google::Iam::V1::IAMPolicy::Client` (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

(Google::Iam::V1::IAMPolicy::Client)



219
220
221

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 219

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ `Google::Cloud::Location::Locations::Client` (readonly)

Get the associated client for mix-in of the Locations.

Returns:

(Google::Cloud::Location::Locations::Client)



212
213
214

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 212

def location_client
  @location_client
end

#operations_client ⇒ `::Google::Cloud::AIPlatform::V1::JobService::Operations` (readonly)

Get the associated client for long-running operations.

Returns:

(::Google::Cloud::AIPlatform::V1::JobService::Operations)



205
206
207

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 205

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ `Client::Configuration`

Configure the JobService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all JobService clients
::Google::Cloud::AIPlatform::V1::JobService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "AIPlatform", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#cancel_batch_prediction_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_batch_prediction_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Cancels a BatchPredictionJob.

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CancelBatchPredictionJobRequest.new

# Call the cancel_batch_prediction_job method.
result = client.cancel_batch_prediction_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#cancel_batch_prediction_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_batch_prediction_job via a request object, either of type CancelBatchPredictionJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CancelBatchPredictionJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#cancel_batch_prediction_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_batch_prediction_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the BatchPredictionJob to cancel. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2846

def cancel_batch_prediction_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CancelBatchPredictionJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_batch_prediction_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_batch_prediction_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_batch_prediction_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :cancel_batch_prediction_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_custom_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_custom_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CancelCustomJobRequest.new

# Call the cancel_custom_job method.
result = client.cancel_custom_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#cancel_custom_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_custom_job via a request object, either of type CancelCustomJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CancelCustomJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#cancel_custom_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_custom_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 686

def cancel_custom_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CancelCustomJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_custom_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_custom_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_custom_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :cancel_custom_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_data_labeling_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_data_labeling_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CancelDataLabelingJobRequest.new

# Call the cancel_data_labeling_job method.
result = client.cancel_data_labeling_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#cancel_data_labeling_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_data_labeling_job via a request object, either of type CancelDataLabelingJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CancelDataLabelingJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#cancel_data_labeling_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_data_labeling_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1170

def cancel_data_labeling_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CancelDataLabelingJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_data_labeling_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_data_labeling_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_data_labeling_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :cancel_data_labeling_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_hyperparameter_tuning_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_hyperparameter_tuning_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CancelHyperparameterTuningJobRequest.new

# Call the cancel_hyperparameter_tuning_job method.
result = client.cancel_hyperparameter_tuning_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#cancel_hyperparameter_tuning_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_hyperparameter_tuning_job via a request object, either of type CancelHyperparameterTuningJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CancelHyperparameterTuningJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#cancel_hyperparameter_tuning_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_hyperparameter_tuning_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1667

def cancel_hyperparameter_tuning_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CancelHyperparameterTuningJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_hyperparameter_tuning_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_hyperparameter_tuning_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_hyperparameter_tuning_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :cancel_hyperparameter_tuning_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_nas_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_nas_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CancelNasJobRequest.new

# Call the cancel_nas_job method.
result = client.cancel_nas_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#cancel_nas_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_nas_job via a request object, either of type CancelNasJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CancelNasJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#cancel_nas_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_nas_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the NasJob to cancel. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2161

def cancel_nas_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CancelNasJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_nas_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_nas_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_nas_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :cancel_nas_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ `Client::Configuration`

Configure the JobService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_batch_prediction_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob` #create_batch_prediction_job(parent: nil, batch_prediction_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob`

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateBatchPredictionJobRequest.new

# Call the create_batch_prediction_job method.
result = client.create_batch_prediction_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::BatchPredictionJob.
p result

Overloads:

#create_batch_prediction_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob

Pass arguments to create_batch_prediction_job via a request object, either of type CreateBatchPredictionJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CreateBatchPredictionJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_batch_prediction_job(parent: nil, batch_prediction_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob

Pass arguments to create_batch_prediction_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to create the BatchPredictionJob in. Format: projects/{project}/locations/{location}
- batch_prediction_job (::Google::Cloud::AIPlatform::V1::BatchPredictionJob, ::Hash) (defaults to: nil) —
  Required. The BatchPredictionJob to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::BatchPredictionJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::BatchPredictionJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2439

def create_batch_prediction_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateBatchPredictionJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_batch_prediction_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_batch_prediction_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_batch_prediction_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :create_batch_prediction_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_custom_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob` #create_custom_job(parent: nil, custom_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob`

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateCustomJobRequest.new

# Call the create_custom_job method.
result = client.create_custom_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::CustomJob.
p result

Overloads:

#create_custom_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob

Pass arguments to create_custom_job via a request object, either of type CreateCustomJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CreateCustomJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_custom_job(parent: nil, custom_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob

Pass arguments to create_custom_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
- custom_job (::Google::Cloud::AIPlatform::V1::CustomJob, ::Hash) (defaults to: nil) —
  Required. The CustomJob to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::CustomJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::CustomJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 280

def create_custom_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateCustomJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_custom_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_custom_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_custom_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :create_custom_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_data_labeling_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob` #create_data_labeling_job(parent: nil, data_labeling_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob`

Creates a DataLabelingJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateDataLabelingJobRequest.new

# Call the create_data_labeling_job method.
result = client.create_data_labeling_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::DataLabelingJob.
p result

Overloads:

#create_data_labeling_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob

Pass arguments to create_data_labeling_job via a request object, either of type CreateDataLabelingJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CreateDataLabelingJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_data_labeling_job(parent: nil, data_labeling_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob

Pass arguments to create_data_labeling_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}
- data_labeling_job (::Google::Cloud::AIPlatform::V1::DataLabelingJob, ::Hash) (defaults to: nil) —
  Required. The DataLabelingJob to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::DataLabelingJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::DataLabelingJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 774

def create_data_labeling_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateDataLabelingJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_data_labeling_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_data_labeling_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_data_labeling_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :create_data_labeling_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_hyperparameter_tuning_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob` #create_hyperparameter_tuning_job(parent: nil, hyperparameter_tuning_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob`

Creates a HyperparameterTuningJob

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateHyperparameterTuningJobRequest.new

# Call the create_hyperparameter_tuning_job method.
result = client.create_hyperparameter_tuning_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::HyperparameterTuningJob.
p result

Overloads:

#create_hyperparameter_tuning_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob

Pass arguments to create_hyperparameter_tuning_job via a request object, either of type CreateHyperparameterTuningJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CreateHyperparameterTuningJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_hyperparameter_tuning_job(parent: nil, hyperparameter_tuning_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob

Pass arguments to create_hyperparameter_tuning_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/{project}/locations/{location}
- hyperparameter_tuning_job (::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob, ::Hash) (defaults to: nil) —
  Required. The HyperparameterTuningJob to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1259

def create_hyperparameter_tuning_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateHyperparameterTuningJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_hyperparameter_tuning_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_hyperparameter_tuning_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_hyperparameter_tuning_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :create_hyperparameter_tuning_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob` #create_model_deployment_monitoring_job(parent: nil, model_deployment_monitoring_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob`

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateModelDeploymentMonitoringJobRequest.new

# Call the create_model_deployment_monitoring_job method.
result = client.create_model_deployment_monitoring_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob.
p result

Overloads:

#create_model_deployment_monitoring_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob

Pass arguments to create_model_deployment_monitoring_job via a request object, either of type CreateModelDeploymentMonitoringJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CreateModelDeploymentMonitoringJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_model_deployment_monitoring_job(parent: nil, model_deployment_monitoring_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob

Pass arguments to create_model_deployment_monitoring_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}
- model_deployment_monitoring_job (::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob, ::Hash) (defaults to: nil) —
  Required. The ModelDeploymentMonitoringJob to create

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2935

def create_model_deployment_monitoring_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateModelDeploymentMonitoringJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_model_deployment_monitoring_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_model_deployment_monitoring_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_model_deployment_monitoring_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :create_model_deployment_monitoring_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_nas_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob` #create_nas_job(parent: nil, nas_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob`

Creates a NasJob

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateNasJobRequest.new

# Call the create_nas_job method.
result = client.create_nas_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::NasJob.
p result

Overloads:

#create_nas_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasJob

Pass arguments to create_nas_job via a request object, either of type CreateNasJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::CreateNasJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_nas_job(parent: nil, nas_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasJob

Pass arguments to create_nas_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to create the NasJob in. Format: projects/{project}/locations/{location}
- nas_job (::Google::Cloud::AIPlatform::V1::NasJob, ::Hash) (defaults to: nil) —
  Required. The NasJob to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::NasJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::NasJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1755

def create_nas_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateNasJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_nas_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_nas_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_nas_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :create_nas_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_batch_prediction_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_batch_prediction_job(name: nil) ⇒ `::Gapic::Operation`

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteBatchPredictionJobRequest.new

# Call the delete_batch_prediction_job method.
result = client.delete_batch_prediction_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_batch_prediction_job(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_batch_prediction_job via a request object, either of type DeleteBatchPredictionJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::DeleteBatchPredictionJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_batch_prediction_job(name: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_batch_prediction_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the BatchPredictionJob resource to be deleted. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2746

def delete_batch_prediction_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteBatchPredictionJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_batch_prediction_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_batch_prediction_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_batch_prediction_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :delete_batch_prediction_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_custom_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_custom_job(name: nil) ⇒ `::Gapic::Operation`

Deletes a CustomJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteCustomJobRequest.new

# Call the delete_custom_job method.
result = client.delete_custom_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_custom_job(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_custom_job via a request object, either of type DeleteCustomJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::DeleteCustomJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_custom_job(name: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_custom_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomJob resource to be deleted. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 585

def delete_custom_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteCustomJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_custom_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_custom_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_custom_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :delete_custom_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_data_labeling_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_data_labeling_job(name: nil) ⇒ `::Gapic::Operation`

Deletes a DataLabelingJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteDataLabelingJobRequest.new

# Call the delete_data_labeling_job method.
result = client.delete_data_labeling_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_data_labeling_job(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_data_labeling_job via a request object, either of type DeleteDataLabelingJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::DeleteDataLabelingJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_data_labeling_job(name: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_data_labeling_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DataLabelingJob to be deleted. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1081

def delete_data_labeling_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteDataLabelingJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_data_labeling_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_data_labeling_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_data_labeling_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :delete_data_labeling_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_hyperparameter_tuning_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_hyperparameter_tuning_job(name: nil) ⇒ `::Gapic::Operation`

Deletes a HyperparameterTuningJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteHyperparameterTuningJobRequest.new

# Call the delete_hyperparameter_tuning_job method.
result = client.delete_hyperparameter_tuning_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_hyperparameter_tuning_job(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_hyperparameter_tuning_job via a request object, either of type DeleteHyperparameterTuningJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::DeleteHyperparameterTuningJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_hyperparameter_tuning_job(name: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_hyperparameter_tuning_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the HyperparameterTuningJob resource to be deleted. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1565

def delete_hyperparameter_tuning_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteHyperparameterTuningJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_hyperparameter_tuning_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_hyperparameter_tuning_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_hyperparameter_tuning_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :delete_hyperparameter_tuning_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_model_deployment_monitoring_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_model_deployment_monitoring_job(name: nil) ⇒ `::Gapic::Operation`

Deletes a ModelDeploymentMonitoringJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteModelDeploymentMonitoringJobRequest.new

# Call the delete_model_deployment_monitoring_job method.
result = client.delete_model_deployment_monitoring_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_model_deployment_monitoring_job(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_model_deployment_monitoring_job via a request object, either of type DeleteModelDeploymentMonitoringJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::DeleteModelDeploymentMonitoringJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_model_deployment_monitoring_job(name: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_model_deployment_monitoring_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The resource name of the model monitoring job to delete. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 3472

def delete_model_deployment_monitoring_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteModelDeploymentMonitoringJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_model_deployment_monitoring_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_model_deployment_monitoring_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_model_deployment_monitoring_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :delete_model_deployment_monitoring_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_nas_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_nas_job(name: nil) ⇒ `::Gapic::Operation`

Deletes a NasJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteNasJobRequest.new

# Call the delete_nas_job method.
result = client.delete_nas_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_nas_job(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_nas_job via a request object, either of type DeleteNasJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::DeleteNasJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_nas_job(name: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_nas_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the NasJob resource to be deleted. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2060

def delete_nas_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteNasJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_nas_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_nas_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_nas_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :delete_nas_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_batch_prediction_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob` #get_batch_prediction_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob`

Gets a BatchPredictionJob

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetBatchPredictionJobRequest.new

# Call the get_batch_prediction_job method.
result = client.get_batch_prediction_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::BatchPredictionJob.
p result

Overloads:

#get_batch_prediction_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob

Pass arguments to get_batch_prediction_job via a request object, either of type GetBatchPredictionJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::GetBatchPredictionJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_batch_prediction_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob

Pass arguments to get_batch_prediction_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the BatchPredictionJob resource. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::BatchPredictionJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::BatchPredictionJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2526

def get_batch_prediction_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetBatchPredictionJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_batch_prediction_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_batch_prediction_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_batch_prediction_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :get_batch_prediction_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_custom_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob` #get_custom_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob`

Gets a CustomJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetCustomJobRequest.new

# Call the get_custom_job method.
result = client.get_custom_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::CustomJob.
p result

Overloads:

#get_custom_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob

Pass arguments to get_custom_job via a request object, either of type GetCustomJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::GetCustomJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_custom_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob

Pass arguments to get_custom_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomJob resource. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::CustomJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::CustomJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 367

def get_custom_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetCustomJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_custom_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_custom_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_custom_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :get_custom_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_data_labeling_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob` #get_data_labeling_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob`

Gets a DataLabelingJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetDataLabelingJobRequest.new

# Call the get_data_labeling_job method.
result = client.get_data_labeling_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::DataLabelingJob.
p result

Overloads:

#get_data_labeling_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob

Pass arguments to get_data_labeling_job via a request object, either of type GetDataLabelingJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::GetDataLabelingJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_data_labeling_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob

Pass arguments to get_data_labeling_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::DataLabelingJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::DataLabelingJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 861

def get_data_labeling_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetDataLabelingJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_data_labeling_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_data_labeling_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_data_labeling_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :get_data_labeling_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_hyperparameter_tuning_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob` #get_hyperparameter_tuning_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob`

Gets a HyperparameterTuningJob

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetHyperparameterTuningJobRequest.new

# Call the get_hyperparameter_tuning_job method.
result = client.get_hyperparameter_tuning_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::HyperparameterTuningJob.
p result

Overloads:

#get_hyperparameter_tuning_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob

Pass arguments to get_hyperparameter_tuning_job via a request object, either of type GetHyperparameterTuningJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::GetHyperparameterTuningJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_hyperparameter_tuning_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob

Pass arguments to get_hyperparameter_tuning_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the HyperparameterTuningJob resource. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1346

def get_hyperparameter_tuning_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetHyperparameterTuningJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_hyperparameter_tuning_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_hyperparameter_tuning_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_hyperparameter_tuning_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :get_hyperparameter_tuning_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob` #get_model_deployment_monitoring_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob`

Gets a ModelDeploymentMonitoringJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetModelDeploymentMonitoringJobRequest.new

# Call the get_model_deployment_monitoring_job method.
result = client.get_model_deployment_monitoring_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob.
p result

Overloads:

#get_model_deployment_monitoring_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob

Pass arguments to get_model_deployment_monitoring_job via a request object, either of type GetModelDeploymentMonitoringJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::GetModelDeploymentMonitoringJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_model_deployment_monitoring_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob

Pass arguments to get_model_deployment_monitoring_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The resource name of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 3137

def get_model_deployment_monitoring_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetModelDeploymentMonitoringJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_model_deployment_monitoring_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_model_deployment_monitoring_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_model_deployment_monitoring_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :get_model_deployment_monitoring_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_nas_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob` #get_nas_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob`

Gets a NasJob

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetNasJobRequest.new

# Call the get_nas_job method.
result = client.get_nas_job request

# The returned object is of type Google::Cloud::AIPlatform::V1::NasJob.
p result

Overloads:

#get_nas_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasJob

Pass arguments to get_nas_job via a request object, either of type GetNasJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::GetNasJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_nas_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasJob

Pass arguments to get_nas_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::NasJob)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::NasJob)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1842

def get_nas_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetNasJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_nas_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_nas_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_nas_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :get_nas_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_nas_trial_detail(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasTrialDetail` #get_nas_trial_detail(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasTrialDetail`

Gets a NasTrialDetail.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetNasTrialDetailRequest.new

# Call the get_nas_trial_detail method.
result = client.get_nas_trial_detail request

# The returned object is of type Google::Cloud::AIPlatform::V1::NasTrialDetail.
p result

Overloads:

#get_nas_trial_detail(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasTrialDetail

Pass arguments to get_nas_trial_detail via a request object, either of type GetNasTrialDetailRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::GetNasTrialDetailRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_nas_trial_detail(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasTrialDetail

Pass arguments to get_nas_trial_detail via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the NasTrialDetail resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::AIPlatform::V1::NasTrialDetail)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::AIPlatform::V1::NasTrialDetail)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2248

def get_nas_trial_detail request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetNasTrialDetailRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_nas_trial_detail.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_nas_trial_detail.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_nas_trial_detail.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :get_nas_trial_detail, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_batch_prediction_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>` #list_batch_prediction_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>`

Lists BatchPredictionJobs in a Location.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsRequest.new

# Call the list_batch_prediction_jobs method.
result = client.list_batch_prediction_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::BatchPredictionJob.
  p item
end

Overloads:

#list_batch_prediction_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>

Pass arguments to list_batch_prediction_jobs via a request object, either of type ListBatchPredictionJobsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_batch_prediction_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>

Pass arguments to list_batch_prediction_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}
- filter (::String) (defaults to: nil) —
  The standard list filter.
  
  Supported fields:
  - display_name supports =, != comparisons, and : wildcard.
  - model_display_name supports =, != comparisons.
  - state supports =, != comparisons.
  - create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
  - labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence
  Some examples of using the filter are:
  - state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
  - state!="JOB_STATE_FAILED" OR display_name="my_job"
  - NOT display_name="my_job"
  - create_time>"2021-05-18T00:00:00Z"
  - labels.keyA=valueA
  - labels.keyB:*
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask specifying which fields to read.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2649

def list_batch_prediction_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_batch_prediction_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_batch_prediction_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_batch_prediction_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :list_batch_prediction_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_batch_prediction_jobs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_custom_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>` #list_custom_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>`

Lists CustomJobs in a Location.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListCustomJobsRequest.new

# Call the list_custom_jobs method.
result = client.list_custom_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::CustomJob.
  p item
end

Overloads:

#list_custom_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>

Pass arguments to list_custom_jobs via a request object, either of type ListCustomJobsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ListCustomJobsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_custom_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>

Pass arguments to list_custom_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location}
- filter (::String) (defaults to: nil) —
  The standard list filter.
  
  Supported fields:
  - display_name supports =, != comparisons, and : wildcard.
  - state supports =, != comparisons.
  - create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
  - labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence
  Some examples of using the filter are:
  - state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
  - state!="JOB_STATE_FAILED" OR display_name="my_job"
  - NOT display_name="my_job"
  - create_time>"2021-05-18T00:00:00Z"
  - labels.keyA=valueA
  - labels.keyB:*
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask specifying which fields to read.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 489

def list_custom_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListCustomJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_custom_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_custom_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_custom_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :list_custom_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_custom_jobs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_data_labeling_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataLabelingJob>` #list_data_labeling_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataLabelingJob>`

Lists DataLabelingJobs in a Location.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListDataLabelingJobsRequest.new

# Call the list_data_labeling_jobs method.
result = client.list_data_labeling_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::DataLabelingJob.
  p item
end

Overloads:

#list_data_labeling_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataLabelingJob>

Pass arguments to list_data_labeling_jobs via a request object, either of type ListDataLabelingJobsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ListDataLabelingJobsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_data_labeling_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataLabelingJob>

Pass arguments to list_data_labeling_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}
- filter (::String) (defaults to: nil) —
  The standard list filter.
  
  Supported fields:
  - display_name supports =, != comparisons, and : wildcard.
  - state supports =, != comparisons.
  - create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
  - labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence
  Some examples of using the filter are:
  - state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
  - state!="JOB_STATE_FAILED" OR display_name="my_job"
  - NOT display_name="my_job"
  - create_time>"2021-05-18T00:00:00Z"
  - labels.keyA=valueA
  - labels.keyB:*
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.
- order_by (::String) (defaults to: nil) —
  A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataLabelingJob>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataLabelingJob>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 985

def list_data_labeling_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListDataLabelingJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_data_labeling_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_data_labeling_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_data_labeling_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :list_data_labeling_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_data_labeling_jobs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_hyperparameter_tuning_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>` #list_hyperparameter_tuning_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>`

Lists HyperparameterTuningJobs in a Location.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsRequest.new

# Call the list_hyperparameter_tuning_jobs method.
result = client.list_hyperparameter_tuning_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob.
  p item
end

Overloads:

#list_hyperparameter_tuning_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>

Pass arguments to list_hyperparameter_tuning_jobs via a request object, either of type ListHyperparameterTuningJobsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_hyperparameter_tuning_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>

Pass arguments to list_hyperparameter_tuning_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}
- filter (::String) (defaults to: nil) —
  The standard list filter.
  
  Supported fields:
  - display_name supports =, != comparisons, and : wildcard.
  - state supports =, != comparisons.
  - create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
  - labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence
  Some examples of using the filter are:
  - state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
  - state!="JOB_STATE_FAILED" OR display_name="my_job"
  - NOT display_name="my_job"
  - create_time>"2021-05-18T00:00:00Z"
  - labels.keyA=valueA
  - labels.keyB:*
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask specifying which fields to read.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1469

def list_hyperparameter_tuning_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_hyperparameter_tuning_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_hyperparameter_tuning_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_hyperparameter_tuning_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :list_hyperparameter_tuning_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_hyperparameter_tuning_jobs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_model_deployment_monitoring_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob>` #list_model_deployment_monitoring_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob>`

Lists ModelDeploymentMonitoringJobs in a Location.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListModelDeploymentMonitoringJobsRequest.new

# Call the list_model_deployment_monitoring_jobs method.
result = client.list_model_deployment_monitoring_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob.
  p item
end

Overloads:

#list_model_deployment_monitoring_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob>

Pass arguments to list_model_deployment_monitoring_jobs via a request object, either of type ListModelDeploymentMonitoringJobsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ListModelDeploymentMonitoringJobsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_model_deployment_monitoring_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob>

Pass arguments to list_model_deployment_monitoring_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}
- filter (::String) (defaults to: nil) —
  The standard list filter.
  
  Supported fields:
  - display_name supports =, != comparisons, and : wildcard.
  - state supports =, != comparisons.
  - create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
  - labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence
  Some examples of using the filter are:
  - state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
  - state!="JOB_STATE_FAILED" OR display_name="my_job"
  - NOT display_name="my_job"
  - create_time>"2021-05-18T00:00:00Z"
  - labels.keyA=valueA
  - labels.keyB:*
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask specifying which fields to read

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 3254

def list_model_deployment_monitoring_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListModelDeploymentMonitoringJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_model_deployment_monitoring_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_model_deployment_monitoring_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_model_deployment_monitoring_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :list_model_deployment_monitoring_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_model_deployment_monitoring_jobs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_nas_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>` #list_nas_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>`

Lists NasJobs in a Location.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListNasJobsRequest.new

# Call the list_nas_jobs method.
result = client.list_nas_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::NasJob.
  p item
end

Overloads:

#list_nas_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>

Pass arguments to list_nas_jobs via a request object, either of type ListNasJobsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ListNasJobsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_nas_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>

Pass arguments to list_nas_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the Location to list the NasJobs from. Format: projects/{project}/locations/{location}
- filter (::String) (defaults to: nil) —
  The standard list filter.
  
  Supported fields:
  - display_name supports =, != comparisons, and : wildcard.
  - state supports =, != comparisons.
  - create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
  - labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence
  Some examples of using the filter are:
  - state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
  - state!="JOB_STATE_FAILED" OR display_name="my_job"
  - NOT display_name="my_job"
  - create_time>"2021-05-18T00:00:00Z"
  - labels.keyA=valueA
  - labels.keyB:*
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask specifying which fields to read.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 1964

def list_nas_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListNasJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_nas_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_nas_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_nas_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :list_nas_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_nas_jobs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_nas_trial_details(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>` #list_nas_trial_details(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>`

List top NasTrialDetails of a NasJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest.new

# Call the list_nas_trial_details method.
result = client.list_nas_trial_details request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::NasTrialDetail.
  p item
end

Overloads:

#list_nas_trial_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>

Pass arguments to list_nas_trial_details via a request object, either of type ListNasTrialDetailsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_nas_trial_details(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>

Pass arguments to list_nas_trial_details via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 2348

def list_nas_trial_details request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_nas_trial_details.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_nas_trial_details.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_nas_trial_details.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :list_nas_trial_details, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_nas_trial_details, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ `Logger`

The logger used for request/response debug logging.

Returns:

(Logger)



226
227
228

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 226

def logger
  @job_service_stub.logger
end

#pause_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #pause_model_deployment_monitoring_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::PauseModelDeploymentMonitoringJobRequest.new

# Call the pause_model_deployment_monitoring_job method.
result = client.pause_model_deployment_monitoring_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#pause_model_deployment_monitoring_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to pause_model_deployment_monitoring_job via a request object, either of type PauseModelDeploymentMonitoringJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::PauseModelDeploymentMonitoringJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#pause_model_deployment_monitoring_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to pause_model_deployment_monitoring_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 3564

def pause_model_deployment_monitoring_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::PauseModelDeploymentMonitoringJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.pause_model_deployment_monitoring_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.pause_model_deployment_monitoring_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.pause_model_deployment_monitoring_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :pause_model_deployment_monitoring_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#resume_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #resume_model_deployment_monitoring_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ResumeModelDeploymentMonitoringJobRequest.new

# Call the resume_model_deployment_monitoring_job method.
result = client.resume_model_deployment_monitoring_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#resume_model_deployment_monitoring_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to resume_model_deployment_monitoring_job via a request object, either of type ResumeModelDeploymentMonitoringJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::ResumeModelDeploymentMonitoringJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#resume_model_deployment_monitoring_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to resume_model_deployment_monitoring_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 3653

def resume_model_deployment_monitoring_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ResumeModelDeploymentMonitoringJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.resume_model_deployment_monitoring_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.resume_model_deployment_monitoring_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.resume_model_deployment_monitoring_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :resume_model_deployment_monitoring_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_model_deployment_monitoring_stats_anomalies(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies>` #search_model_deployment_monitoring_stats_anomalies(model_deployment_monitoring_job: nil, deployed_model_id: nil, feature_display_name: nil, objectives: nil, page_size: nil, page_token: nil, start_time: nil, end_time: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies>`

Searches Model Monitoring Statistics generated within a given time window.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest.new

# Call the search_model_deployment_monitoring_stats_anomalies method.
result = client.search_model_deployment_monitoring_stats_anomalies request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies.
  p item
end

Overloads:

#search_model_deployment_monitoring_stats_anomalies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies>

Pass arguments to search_model_deployment_monitoring_stats_anomalies via a request object, either of type SearchModelDeploymentMonitoringStatsAnomaliesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#search_model_deployment_monitoring_stats_anomalies(model_deployment_monitoring_job: nil, deployed_model_id: nil, feature_display_name: nil, objectives: nil, page_size: nil, page_token: nil, start_time: nil, end_time: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies>

Pass arguments to search_model_deployment_monitoring_stats_anomalies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- model_deployment_monitoring_job (::String) (defaults to: nil) —
  Required. ModelDeploymentMonitoring Job resource name. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}
- deployed_model_id (::String) (defaults to: nil) —
  Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].
- feature_display_name (::String) (defaults to: nil) —
  The feature display name. If specified, only return the stats belonging to this feature. Format: ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, example: "user_destination".
- objectives (::Array<::Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest::StatsAnomaliesObjective, ::Hash>) (defaults to: nil) —
  Required. Objectives of the stats to retrieve.
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  A page token received from a previous JobService.SearchModelDeploymentMonitoringStatsAnomalies call.
- start_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —
  The earliest timestamp of stats being generated. If not set, indicates fetching stats till the earliest possible one.
- end_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —
  The latest timestamp of stats being generated. If not set, indicates feching stats till the latest possible one.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::ModelMonitoringStatsAnomalies>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 3048

def search_model_deployment_monitoring_stats_anomalies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_model_deployment_monitoring_stats_anomalies.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.model_deployment_monitoring_job
    header_params["model_deployment_monitoring_job"] = request.model_deployment_monitoring_job
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search_model_deployment_monitoring_stats_anomalies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_model_deployment_monitoring_stats_anomalies.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :search_model_deployment_monitoring_stats_anomalies, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :search_model_deployment_monitoring_stats_anomalies, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ `String`

The effective universe domain

Returns:

(String)



106
107
108

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 106

def universe_domain
  @job_service_stub.universe_domain
end

#update_model_deployment_monitoring_job(request, options = nil) ⇒ `::Gapic::Operation` #update_model_deployment_monitoring_job(model_deployment_monitoring_job: nil, update_mask: nil) ⇒ `::Gapic::Operation`

Updates a ModelDeploymentMonitoringJob.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::JobService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::UpdateModelDeploymentMonitoringJobRequest.new

# Call the update_model_deployment_monitoring_job method.
result = client.update_model_deployment_monitoring_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#update_model_deployment_monitoring_job(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to update_model_deployment_monitoring_job via a request object, either of type UpdateModelDeploymentMonitoringJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::AIPlatform::V1::UpdateModelDeploymentMonitoringJobRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_model_deployment_monitoring_job(model_deployment_monitoring_job: nil, update_mask: nil) ⇒ ::Gapic::Operation

Pass arguments to update_model_deployment_monitoring_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- model_deployment_monitoring_job (::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob, ::Hash) (defaults to: nil) —
  Required. The model monitoring configuration which replaces the resource on the server.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset.
  
  Updatable fields:
  - display_name
  - model_deployment_monitoring_schedule_config
  - model_monitoring_alert_config
  - logging_sampling_strategy
  - labels
  - log_ttl
  - enable_monitoring_pipeline_logs . and
  - model_deployment_monitoring_objective_configs . or
  - model_deployment_monitoring_objective_configs.objective_config.training_dataset
  - model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config
  - model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/ai_platform/v1/job_service/client.rb', line 3376

def update_model_deployment_monitoring_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateModelDeploymentMonitoringJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_model_deployment_monitoring_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.model_deployment_monitoring_job&.name
    header_params["model_deployment_monitoring_job.name"] = request.model_deployment_monitoring_job.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_model_deployment_monitoring_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_model_deployment_monitoring_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @job_service_stub.call_rpc :update_model_deployment_monitoring_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

Class: Google::Cloud::AIPlatform::V1::JobService::Client

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

Constructor Details

#initialize {|config| ... } ⇒ Client

Examples:

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

#operations_client ⇒ ::Google::Cloud::AIPlatform::V1::JobService::Operations (readonly)

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Examples:

Instance Method Details

#cancel_batch_prediction_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_batch_prediction_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#cancel_custom_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_custom_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#cancel_data_labeling_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_data_labeling_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#cancel_hyperparameter_tuning_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_hyperparameter_tuning_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#cancel_nas_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_nas_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#configure {|config| ... } ⇒ Client::Configuration

#create_batch_prediction_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob #create_batch_prediction_job(parent: nil, batch_prediction_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob

Examples:

Basic example

#create_custom_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob #create_custom_job(parent: nil, custom_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob

Examples:

Basic example

#create_data_labeling_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob #create_data_labeling_job(parent: nil, data_labeling_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob

Examples:

Basic example

#create_hyperparameter_tuning_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob #create_hyperparameter_tuning_job(parent: nil, hyperparameter_tuning_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob

Examples:

Basic example

#create_model_deployment_monitoring_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob #create_model_deployment_monitoring_job(parent: nil, model_deployment_monitoring_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob

Examples:

Basic example

#create_nas_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasJob #create_nas_job(parent: nil, nas_job: nil) ⇒ ::Google::Cloud::AIPlatform::V1::NasJob

Examples:

Basic example

#delete_batch_prediction_job(request, options = nil) ⇒ ::Gapic::Operation #delete_batch_prediction_job(name: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_custom_job(request, options = nil) ⇒ ::Gapic::Operation #delete_custom_job(name: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_data_labeling_job(request, options = nil) ⇒ ::Gapic::Operation #delete_data_labeling_job(name: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_hyperparameter_tuning_job(request, options = nil) ⇒ ::Gapic::Operation #delete_hyperparameter_tuning_job(name: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_model_deployment_monitoring_job(request, options = nil) ⇒ ::Gapic::Operation #delete_model_deployment_monitoring_job(name: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_nas_job(request, options = nil) ⇒ ::Gapic::Operation #delete_nas_job(name: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#get_batch_prediction_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob #get_batch_prediction_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::BatchPredictionJob

Examples:

Basic example

#get_custom_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob #get_custom_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::CustomJob

Examples:

Basic example

#get_data_labeling_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob #get_data_labeling_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::DataLabelingJob

Examples:

Basic example

#get_hyperparameter_tuning_job(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob #get_hyperparameter_tuning_job(name: nil) ⇒ ::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob

#initialize {|config| ... } ⇒ `Client`

#iam_policy_client ⇒ `Google::Iam::V1::IAMPolicy::Client` (readonly)

#location_client ⇒ `Google::Cloud::Location::Locations::Client` (readonly)

#operations_client ⇒ `::Google::Cloud::AIPlatform::V1::JobService::Operations` (readonly)

.configure {|config| ... } ⇒ `Client::Configuration`

#cancel_batch_prediction_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_batch_prediction_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#cancel_custom_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_custom_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#cancel_data_labeling_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_data_labeling_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#cancel_hyperparameter_tuning_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_hyperparameter_tuning_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#cancel_nas_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_nas_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#configure {|config| ... } ⇒ `Client::Configuration`

#create_batch_prediction_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob` #create_batch_prediction_job(parent: nil, batch_prediction_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob`

#create_custom_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob` #create_custom_job(parent: nil, custom_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob`

#create_data_labeling_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob` #create_data_labeling_job(parent: nil, data_labeling_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob`

#create_hyperparameter_tuning_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob` #create_hyperparameter_tuning_job(parent: nil, hyperparameter_tuning_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob`

#create_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob` #create_model_deployment_monitoring_job(parent: nil, model_deployment_monitoring_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob`

#create_nas_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob` #create_nas_job(parent: nil, nas_job: nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob`

#delete_batch_prediction_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_batch_prediction_job(name: nil) ⇒ `::Gapic::Operation`

#delete_custom_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_custom_job(name: nil) ⇒ `::Gapic::Operation`

#delete_data_labeling_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_data_labeling_job(name: nil) ⇒ `::Gapic::Operation`

#delete_hyperparameter_tuning_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_hyperparameter_tuning_job(name: nil) ⇒ `::Gapic::Operation`

#delete_model_deployment_monitoring_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_model_deployment_monitoring_job(name: nil) ⇒ `::Gapic::Operation`

#delete_nas_job(request, options = nil) ⇒ `::Gapic::Operation` #delete_nas_job(name: nil) ⇒ `::Gapic::Operation`

#get_batch_prediction_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob` #get_batch_prediction_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::BatchPredictionJob`

#get_custom_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob` #get_custom_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::CustomJob`

#get_data_labeling_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob` #get_data_labeling_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::DataLabelingJob`

#get_hyperparameter_tuning_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob` #get_hyperparameter_tuning_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob`

#get_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob` #get_model_deployment_monitoring_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob`

#get_nas_job(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob` #get_nas_job(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasJob`

#get_nas_trial_detail(request, options = nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasTrialDetail` #get_nas_trial_detail(name: nil) ⇒ `::Google::Cloud::AIPlatform::V1::NasTrialDetail`

#list_custom_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>` #list_custom_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CustomJob>`

#list_nas_jobs(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>` #list_nas_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>`

#list_nas_trial_details(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>` #list_nas_trial_details(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>`

#logger ⇒ `Logger`

#pause_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #pause_model_deployment_monitoring_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#resume_model_deployment_monitoring_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #resume_model_deployment_monitoring_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#universe_domain ⇒ `String`

#update_model_deployment_monitoring_job(request, options = nil) ⇒ `::Gapic::Operation` #update_model_deployment_monitoring_job(model_deployment_monitoring_job: nil, update_mask: nil) ⇒ `::Gapic::Operation`