Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::EngineService::Rest::ServiceStub (v0.16.0)

Version latest

• 0.16.0 (latest)
• 0.15.0
• 0.14.2
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.2
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::EngineService::Rest::ServiceStub.

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

Inherits

• Object

Methods

#create_engine

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

Baseline implementation for the create_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::CreateEngineRequest) — 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_engine

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

Baseline implementation for the delete_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::DeleteEngineRequest) — 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_engine

def get_engine(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine

Baseline implementation for the get_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::GetEngineRequest) — 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::DiscoveryEngine::V1beta::Engine)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — 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_engines

def list_engines(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesResponse

Baseline implementation for the list_engines REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesRequest) — 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::DiscoveryEngine::V1beta::ListEnginesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#pause_engine

def pause_engine(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine

Baseline implementation for the pause_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest) — 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::DiscoveryEngine::V1beta::Engine)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#resume_engine

def resume_engine(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine

Baseline implementation for the resume_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest) — 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::DiscoveryEngine::V1beta::Engine)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#tune_engine

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

Baseline implementation for the tune_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest) — 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)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_engine

def update_engine(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine

Baseline implementation for the update_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1beta::UpdateEngineRequest) — 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::DiscoveryEngine::V1beta::Engine)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)