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

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

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

Inherits

  • Object

Methods

#add_trial_measurement

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

Baseline implementation for the add_trial_measurement REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#check_trial_early_stopping_state

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

Baseline implementation for the check_trial_early_stopping_state REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#complete_trial

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

Baseline implementation for the complete_trial REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_study

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

Baseline implementation for the create_study REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_trial

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

Baseline implementation for the create_trial REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_study

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

Baseline implementation for the delete_study REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_trial

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

Baseline implementation for the delete_trial REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_study

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

Baseline implementation for the get_study REST call

Parameters
  • request_pb (::Google::Cloud::AIPlatform::V1::GetStudyRequest) — 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
Returns
Raises
  • (::ArgumentError)

#get_trial

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

Baseline implementation for the get_trial REST call

Parameters
  • request_pb (::Google::Cloud::AIPlatform::V1::GetTrialRequest) — 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
Returns
Raises
  • (::ArgumentError)

#initialize

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

#list_optimal_trials

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

Baseline implementation for the list_optimal_trials REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_studies

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

Baseline implementation for the list_studies REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_trials

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

Baseline implementation for the list_trials REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#lookup_study

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

Baseline implementation for the lookup_study REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#stop_trial

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

Baseline implementation for the stop_trial REST call

Parameters
  • request_pb (::Google::Cloud::AIPlatform::V1::StopTrialRequest) — 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
Returns
Raises
  • (::ArgumentError)

#suggest_trials

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

Baseline implementation for the suggest_trials REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)