- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.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.
- (config) — Configure the Client client.
- config (Client::Configuration)
# 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
.
def cancel_pipeline_job(request, options = nil) -> ::Google::Protobuf::Empty
cancel_pipeline_job
via a request object, either of type
CancelPipelineJobRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the PipelineJob to cancel.
Format:
projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
.
def cancel_training_pipeline(request, options = nil) -> ::Google::Protobuf::Empty
cancel_training_pipeline
via a request object, either of type
CancelTrainingPipelineRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the TrainingPipeline to cancel.
Format:
projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#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.
def create_pipeline_job(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
create_pipeline_job
via a request object, either of type
CreatePipelineJobRequest or an equivalent Hash.
- 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
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).
-
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]-/.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::PipelineJob)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def create_training_pipeline(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
create_training_pipeline
via a request object, either of type
CreateTrainingPipelineRequest or an equivalent Hash.
- 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
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::TrainingPipeline)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def delete_pipeline_job(request, options = nil) -> ::Gapic::Operation
delete_pipeline_job
via a request object, either of type
DeletePipelineJobRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the PipelineJob resource to be deleted.
Format:
projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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 puts "Error!" end
#delete_training_pipeline
def delete_training_pipeline(request, options = nil) -> ::Gapic::Operation
def delete_training_pipeline(name: nil) -> ::Gapic::Operation
Deletes a TrainingPipeline.
def delete_training_pipeline(request, options = nil) -> ::Gapic::Operation
delete_training_pipeline
via a request object, either of type
DeleteTrainingPipelineRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the TrainingPipeline resource to be deleted.
Format:
projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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 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 puts "Error!" 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.
def get_pipeline_job(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PipelineJob
get_pipeline_job
via a request object, either of type
GetPipelineJobRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the PipelineJob resource.
Format:
projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::PipelineJob)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def get_training_pipeline(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline
get_training_pipeline
via a request object, either of type
GetTrainingPipelineRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. The name of the TrainingPipeline resource.
Format:
projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::TrainingPipeline)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#initialize
def initialize() { |config| ... } -> Client
Create a new PipelineService client object.
- (config) — Configure the PipelineService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::AIPlatform::V1::PipelineService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::AIPlatform::V1::PipelineService::Client.new do |config| config.timeout = 10.0 end
#list_pipeline_jobs
def list_pipeline_jobs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>
def list_pipeline_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>
Lists PipelineJobs in a Location.
def list_pipeline_jobs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>
list_pipeline_jobs
via a request object, either of type
ListPipelineJobsRequest or an equivalent Hash.
- 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) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>
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).
-
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_name
: 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
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PipelineJob>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::AIPlatform::V1::PipelineJob. p response end
#list_training_pipelines
def list_training_pipelines(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>
def list_training_pipelines(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>
Lists TrainingPipelines in a Location.
def list_training_pipelines(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>
list_training_pipelines
via a request object, either of type
ListTrainingPipelinesRequest or an equivalent Hash.
- 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::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>
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).
-
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 = and !=.state
supports = and !=.
Some examples of using the filter are:
state="PIPELINE_STATE_SUCCEEDED" AND display_name="my_pipeline"
state="PIPELINE_STATE_RUNNING" OR display_name="my_pipeline"
NOT display_name="my_pipeline"
state="PIPELINE_STATE_FAILED"
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TrainingPipeline>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::AIPlatform::V1::TrainingPipeline. p response end
#operations_client
def operations_client() -> ::Google::Cloud::AIPlatform::V1::PipelineService::Operations
Get the associated client for long-running operations.