Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::PipelineService::Rest::Client (v0.56.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::PipelineService::Rest::Client.

REST client for the PipelineService service.

A service for creating and managing Vertex AI's pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex AI Pipelines).

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the PipelineService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all PipelineService clients
::Google::Cloud::AIPlatform::V1::PipelineService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#batch_cancel_pipeline_jobs

def batch_cancel_pipeline_jobs(request, options = nil) -> ::Gapic::Operation
def batch_cancel_pipeline_jobs(parent: nil, names: nil) -> ::Gapic::Operation

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

Overloads 
def batch_cancel_pipeline_jobs(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_cancel_pipeline_jobs via a request object, either of type BatchCancelPipelineJobsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::BatchCancelPipelineJobsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_cancel_pipeline_jobs(parent: nil, names: nil) -> ::Gapic::Operation
Pass arguments to batch_cancel_pipeline_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) — Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}
  • names (::Array<::String>) — Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

# Call the batch_cancel_pipeline_jobs method.
result = client.batch_cancel_pipeline_jobs 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

#batch_delete_pipeline_jobs

def batch_delete_pipeline_jobs(request, options = nil) -> ::Gapic::Operation
def batch_delete_pipeline_jobs(parent: nil, names: nil) -> ::Gapic::Operation

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.

Overloads 
def batch_delete_pipeline_jobs(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_delete_pipeline_jobs via a request object, either of type BatchDeletePipelineJobsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::BatchDeletePipelineJobsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_delete_pipeline_jobs(parent: nil, names: nil) -> ::Gapic::Operation
Pass arguments to batch_delete_pipeline_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) — Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}
  • names (::Array<::String>) — Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

# Call the batch_delete_pipeline_jobs method.
result = client.batch_delete_pipeline_jobs 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

#cancel_pipeline_job

def cancel_pipeline_job(request, options = nil) -> ::Google::Protobuf::Empty
def cancel_pipeline_job(name: nil) -> ::Google::Protobuf::Empty

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

Overloads 
def cancel_pipeline_job(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_pipeline_job via a request object, either of type CancelPipelineJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CancelPipelineJobRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def cancel_pipeline_job(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_pipeline_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).
Parameter
  • name (::String) — Required. The name of the PipelineJob to cancel. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

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

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

#cancel_training_pipeline

def cancel_training_pipeline(request, options = nil) -> ::Google::Protobuf::Empty
def cancel_training_pipeline(name: nil) -> ::Google::Protobuf::Empty

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

Overloads 
def cancel_training_pipeline(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_training_pipeline via a request object, either of type CancelTrainingPipelineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CancelTrainingPipelineRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def cancel_training_pipeline(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_training_pipeline 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).
Parameter
  • name (::String) — Required. The name of the TrainingPipeline to cancel. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

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

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

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the PipelineService 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_pipeline_job

def create_pipeline_job(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
def create_pipeline_job(parent: nil, pipeline_job: nil, pipeline_job_id: nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob

Creates a PipelineJob. A PipelineJob will run immediately when created.

Overloads 
def create_pipeline_job(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
Pass arguments to create_pipeline_job via a request object, either of type CreatePipelineJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_pipeline_job(parent: nil, pipeline_job: nil, pipeline_job_id: nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
Pass arguments to create_pipeline_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) — Required. The resource name of the Location to create the PipelineJob in. Format: projects/{project}/locations/{location}
  • pipeline_job (::Google::Cloud::AIPlatform::V1::PipelineJob, ::Hash) — Required. The PipelineJob to create.
  • pipeline_job_id (::String) — The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.

    This value should be less than 128 characters, and valid characters are /[a-z][0-9]-/.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

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

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

#create_training_pipeline

def create_training_pipeline(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
def create_training_pipeline(parent: nil, training_pipeline: nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline

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

Overloads 
def create_training_pipeline(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
Pass arguments to create_training_pipeline via a request object, either of type CreateTrainingPipelineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CreateTrainingPipelineRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_training_pipeline(parent: nil, training_pipeline: nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
Pass arguments to create_training_pipeline 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) — Required. The resource name of the Location to create the TrainingPipeline in. Format: projects/{project}/locations/{location}
  • training_pipeline (::Google::Cloud::AIPlatform::V1::TrainingPipeline, ::Hash) — Required. The TrainingPipeline to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

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

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

#delete_pipeline_job

def delete_pipeline_job(request, options = nil) -> ::Gapic::Operation
def delete_pipeline_job(name: nil) -> ::Gapic::Operation

Deletes a PipelineJob.

Overloads 
def delete_pipeline_job(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_pipeline_job via a request object, either of type DeletePipelineJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::DeletePipelineJobRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_pipeline_job(name: nil) -> ::Gapic::Operation
Pass arguments to delete_pipeline_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).
Parameter
  • name (::String) — Required. The name of the PipelineJob resource to be deleted. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

# Call the delete_pipeline_job method.
result = client.delete_pipeline_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

#delete_training_pipeline

def delete_training_pipeline(request, options = nil) -> ::Gapic::Operation
def delete_training_pipeline(name: nil) -> ::Gapic::Operation

Deletes a TrainingPipeline.

Overloads 
def delete_training_pipeline(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_training_pipeline via a request object, either of type DeleteTrainingPipelineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::DeleteTrainingPipelineRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_training_pipeline(name: nil) -> ::Gapic::Operation
Pass arguments to delete_training_pipeline 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).
Parameter
  • name (::String) — Required. The name of the TrainingPipeline resource to be deleted. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

# Call the delete_training_pipeline method.
result = client.delete_training_pipeline 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

#get_pipeline_job

def get_pipeline_job(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
def get_pipeline_job(name: nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob

Gets a PipelineJob.

Overloads 
def get_pipeline_job(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
Pass arguments to get_pipeline_job via a request object, either of type GetPipelineJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GetPipelineJobRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_pipeline_job(name: nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
Pass arguments to get_pipeline_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).
Parameter
  • name (::String) — Required. The name of the PipelineJob resource. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

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

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

#get_training_pipeline

def get_training_pipeline(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
def get_training_pipeline(name: nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline

Gets a TrainingPipeline.

Overloads 
def get_training_pipeline(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
Pass arguments to get_training_pipeline via a request object, either of type GetTrainingPipelineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GetTrainingPipelineRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_training_pipeline(name: nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
Pass arguments to get_training_pipeline 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).
Parameter
  • name (::String) — Required. The name of the TrainingPipeline resource. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

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

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

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

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

Returns
  • (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new PipelineService REST client object.

Yields
  • (config) — Configure the PipelineService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::PipelineService::Rest::Client.new

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

#list_pipeline_jobs

def list_pipeline_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>
def list_pipeline_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>

Lists PipelineJobs in a Location.

Overloads 
def list_pipeline_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>
Pass arguments to list_pipeline_jobs via a request object, either of type ListPipelineJobsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::ListPipelineJobsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_pipeline_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>
Pass arguments to list_pipeline_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) — Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}
  • filter (::String) —

    Lists the PipelineJobs that match the filter expression. The following fields are supported:

    • pipeline_name: Supports = and != comparisons.
    • display_name: Supports =, != comparisons, and : wildcard.
    • pipeline_job_user_id: Supports =, != comparisons, and : wildcard. for example, can check if pipeline's display_name contains step by doing display_name:\"step\"
    • state: Supports = and != comparisons.
    • create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
    • update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
    • end_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
    • labels: Supports key-value equality and key presence.
    • template_uri: Supports =, != comparisons, and : wildcard.
    • template_metadata.version: Supports =, != comparisons, and : wildcard.

    Filter expressions can be combined together using logical operators (AND & OR). For example: pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z".

    The syntax to define filter expression is based on https://google.aip.dev/160.

    Examples:

    • create_time>"2021-05-18T00:00:00Z" OR update_time>"2020-05-18T00:00:00Z" PipelineJobs created or updated after 2020-05-18 00:00:00 UTC.
    • labels.env = "prod" PipelineJobs with label "env" set to "prod".
  • page_size (::Integer) — The standard list page size.
  • page_token (::String) — The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
  • order_by (::String) —

    A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields:

    • create_time
    • update_time
    • end_time
    • start_time
  • read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

# Call the list_pipeline_jobs method.
result = client.list_pipeline_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::PipelineJob.
  p item
end

#list_training_pipelines

def list_training_pipelines(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>
def list_training_pipelines(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>

Lists TrainingPipelines in a Location.

Overloads 
def list_training_pipelines(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>
Pass arguments to list_training_pipelines via a request object, either of type ListTrainingPipelinesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::ListTrainingPipelinesRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_training_pipelines(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>
Pass arguments to list_training_pipelines 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) — Required. The resource name of the Location to list the TrainingPipelines from. Format: projects/{project}/locations/{location}
  • filter (::String) —

    The standard list filter.

    Supported fields:

    • display_name supports =, != comparisons, and : wildcard.
    • state supports =, != comparisons.
    • training_task_definition =, != comparisons, and : wildcard.
    • 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="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"
    • state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"
    • NOT display_name="my_pipeline"
    • create_time>"2021-05-18T00:00:00Z"
    • training_task_definition:"*automl_text_classification*"
  • page_size (::Integer) — The standard list page size.
  • page_token (::String) — The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.
  • read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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::PipelineService::Rest::Client.new

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

# Call the list_training_pipelines method.
result = client.list_training_pipelines 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::TrainingPipeline.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

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

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#operations_client

def operations_client() -> ::Google::Cloud::AIPlatform::V1::PipelineService::Rest::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)