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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_engine
def delete_engine(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_engine REST call
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Engine)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesResponse) — A result object deserialized from the server's reply
- (::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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Engine)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — A result object deserialized from the server's reply
- (::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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Engine)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — A result object deserialized from the server's reply
- (::ArgumentError)
#tune_engine
def tune_engine(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the tune_engine REST call
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Engine)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Engine) — A result object deserialized from the server's reply
- (::ArgumentError)