# Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::VizierService::Rest::ServiceStub (v1.44.0)

1.43.0 (latest) 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.1 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.1 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 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::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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::AddTrialMeasurementRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-AddTrialMeasurementRequest)) --- 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::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::CheckTrialEarlyStoppingStateRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-CheckTrialEarlyStoppingStateRequest)) --- 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::CompleteTrialRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-CompleteTrialRequest)) --- 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::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::CreateStudyRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-CreateStudyRequest)) --- 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::Study](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Study))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Study](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Study)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::CreateTrialRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-CreateTrialRequest)) --- 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::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::DeleteStudyRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-DeleteStudyRequest)) --- 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Protobuf-Empty))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Protobuf-Empty)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::DeleteTrialRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-DeleteTrialRequest)) --- 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Protobuf-Empty))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Protobuf-Empty)) --- A result object deserialized from the server's reply
**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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/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**

- **result** ([::Google::Cloud::AIPlatform::V1::Study](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Study))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Study](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Study)) --- A result object deserialized from the server's reply
**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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/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**

- **result** ([::Google::Cloud::AIPlatform::V1::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::ListOptimalTrialsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListOptimalTrialsRequest)) --- 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::ListOptimalTrialsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListOptimalTrialsResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::ListOptimalTrialsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListOptimalTrialsResponse)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::ListStudiesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListStudiesRequest)) --- 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::ListStudiesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListStudiesResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::ListStudiesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListStudiesResponse)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::ListTrialsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListTrialsRequest)) --- 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::ListTrialsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListTrialsResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::ListTrialsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ListTrialsResponse)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #logger

    def logger(stub: false) -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::LookupStudyRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-LookupStudyRequest)) --- 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::Study](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Study))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Study](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Study)) --- A result object deserialized from the server's reply
**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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/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**

- **result** ([::Google::Cloud::AIPlatform::V1::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::AIPlatform::V1::Trial](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial)) --- A result object deserialized from the server's reply
**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**

- **request_pb** ([::Google::Cloud::AIPlatform::V1::SuggestTrialsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-SuggestTrialsRequest)) --- 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)