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

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

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

Inherits

  • Object

Methods

#create_control

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

Baseline implementation for the create_control REST call

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

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

Baseline implementation for the delete_control REST call

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

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

Baseline implementation for the get_control REST call

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

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

Baseline implementation for the list_controls REST call

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

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

Baseline implementation for the update_control REST call

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