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

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

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

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
Example
# Modify the configuration for all PipelineService clients
::Google::Cloud::AIPlatform::V1::PipelineService::Client.configure do |config|
  config.timeout = 10.0
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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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
  • (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.
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::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 this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else