Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

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

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

REST service stub for the PipelineService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

Object

Methods

#batch_cancel_pipeline_jobs

def batch_cancel_pipeline_jobs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the batch_cancel_pipeline_jobs REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::BatchCancelPipelineJobsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#batch_delete_pipeline_jobs

def batch_delete_pipeline_jobs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the batch_delete_pipeline_jobs REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::BatchDeletePipelineJobsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#cancel_pipeline_job

def cancel_pipeline_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the cancel_pipeline_job REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::CancelPipelineJobRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#cancel_training_pipeline

def cancel_training_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the cancel_training_pipeline REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::CancelTrainingPipelineRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#create_pipeline_job

def create_pipeline_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::PipelineJob

Baseline implementation for the create_pipeline_job REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AIPlatform::V1::PipelineJob)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AIPlatform::V1::PipelineJob) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#create_training_pipeline

def create_training_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline

Baseline implementation for the create_training_pipeline REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::CreateTrainingPipelineRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AIPlatform::V1::TrainingPipeline)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AIPlatform::V1::TrainingPipeline) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_pipeline_job

def delete_pipeline_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_pipeline_job REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::DeletePipelineJobRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_training_pipeline

def delete_training_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_training_pipeline REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::DeleteTrainingPipelineRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get_pipeline_job

def get_pipeline_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::PipelineJob

Baseline implementation for the get_pipeline_job REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::GetPipelineJobRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AIPlatform::V1::PipelineJob)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AIPlatform::V1::PipelineJob) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_training_pipeline

def get_training_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TrainingPipeline

Baseline implementation for the get_training_pipeline REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::GetTrainingPipelineRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AIPlatform::V1::TrainingPipeline)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AIPlatform::V1::TrainingPipeline) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#list_pipeline_jobs

def list_pipeline_jobs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ListPipelineJobsResponse

Baseline implementation for the list_pipeline_jobs REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::ListPipelineJobsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AIPlatform::V1::ListPipelineJobsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AIPlatform::V1::ListPipelineJobsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#list_training_pipelines

def list_training_pipelines(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ListTrainingPipelinesResponse

Baseline implementation for the list_training_pipelines REST call

Parameters

request_pb (::Google::Cloud::AIPlatform::V1::ListTrainingPipelinesRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AIPlatform::V1::ListTrainingPipelinesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AIPlatform::V1::ListTrainingPipelinesResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)