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

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

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

Inherits

Object

Methods

#create_sample_query

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

Baseline implementation for the create_sample_query REST call

Parameters

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

Returns

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

Raises

(::ArgumentError)

#delete_sample_query

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

Baseline implementation for the delete_sample_query REST call

Parameters

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

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get_sample_query

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

Baseline implementation for the get_sample_query REST call

Parameters

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

Returns

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

Raises

(::ArgumentError)

#import_sample_queries

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

Baseline implementation for the import_sample_queries REST call

Parameters

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

#initialize

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

Returns

(ServiceStub) — a new instance of ServiceStub

#list_sample_queries

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

Baseline implementation for the list_sample_queries REST call

Parameters

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

Returns

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

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_sample_query

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

Baseline implementation for the update_sample_query REST call

Parameters

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

Returns

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

Raises

(::ArgumentError)