Retail V2 API - Class Google::Cloud::Retail::V2::ModelService::Rest::ServiceStub (v0.19.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ModelService::Rest::ServiceStub.

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

Inherits

  • Object

Methods

#create_model

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

Baseline implementation for the create_model REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::CreateModelRequest) — 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)

#delete_model

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

Baseline implementation for the delete_model REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::DeleteModelRequest) — 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)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_model

def get_model(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Retail::V2::Model

Baseline implementation for the get_model REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::GetModelRequest) — 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_models

def list_models(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Retail::V2::ListModelsResponse

Baseline implementation for the list_models REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::ListModelsRequest) — 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)

#pause_model

def pause_model(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Retail::V2::Model

Baseline implementation for the pause_model REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::PauseModelRequest) — 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)

#resume_model

def resume_model(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Retail::V2::Model

Baseline implementation for the resume_model REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::ResumeModelRequest) — 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)

#tune_model

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

Baseline implementation for the tune_model REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::TuneModelRequest) — 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)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_model

def update_model(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Retail::V2::Model

Baseline implementation for the update_model REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::UpdateModelRequest) — 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)