Cloud Channel V1 API - Class Google::Cloud::Channel::V1::CloudChannelService::Rest::ServiceStub (v1.2.0)

Reference documentation and code samples for the Cloud Channel V1 API class Google::Cloud::Channel::V1::CloudChannelService::Rest::ServiceStub.

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

Inherits

  • Object

Methods

#activate_entitlement

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

Baseline implementation for the activate_entitlement REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#cancel_entitlement

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

Baseline implementation for the cancel_entitlement REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#change_offer

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

Baseline implementation for the change_offer REST call

Parameters
  • request_pb (::Google::Cloud::Channel::V1::ChangeOfferRequest) — 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)

#change_parameters

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

Baseline implementation for the change_parameters REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#change_renewal_settings

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

Baseline implementation for the change_renewal_settings REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#check_cloud_identity_accounts_exist

def check_cloud_identity_accounts_exist(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse

Baseline implementation for the check_cloud_identity_accounts_exist REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_channel_partner_link

def create_channel_partner_link(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ChannelPartnerLink

Baseline implementation for the create_channel_partner_link REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_channel_partner_repricing_config

def create_channel_partner_repricing_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig

Baseline implementation for the create_channel_partner_repricing_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_customer

def create_customer(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::Customer

Baseline implementation for the create_customer REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_customer_repricing_config

def create_customer_repricing_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::CustomerRepricingConfig

Baseline implementation for the create_customer_repricing_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_entitlement

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

Baseline implementation for the create_entitlement REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_channel_partner_repricing_config

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

Baseline implementation for the delete_channel_partner_repricing_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_customer

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

Baseline implementation for the delete_customer REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_customer_repricing_config

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

Baseline implementation for the delete_customer_repricing_config REST call

Parameters
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_channel_partner_link

def get_channel_partner_link(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ChannelPartnerLink

Baseline implementation for the get_channel_partner_link REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_channel_partner_repricing_config

def get_channel_partner_repricing_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig

Baseline implementation for the get_channel_partner_repricing_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_customer

def get_customer(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::Customer

Baseline implementation for the get_customer REST call

Parameters
  • request_pb (::Google::Cloud::Channel::V1::GetCustomerRequest) — 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)

#get_customer_repricing_config

def get_customer_repricing_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::CustomerRepricingConfig

Baseline implementation for the get_customer_repricing_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_entitlement

def get_entitlement(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::Entitlement

Baseline implementation for the get_entitlement REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#import_customer

def import_customer(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::Customer

Baseline implementation for the import_customer REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_channel_partner_links

def list_channel_partner_links(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse

Baseline implementation for the list_channel_partner_links REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_channel_partner_repricing_configs

def list_channel_partner_repricing_configs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListChannelPartnerRepricingConfigsResponse

Baseline implementation for the list_channel_partner_repricing_configs REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_customer_repricing_configs

def list_customer_repricing_configs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListCustomerRepricingConfigsResponse

Baseline implementation for the list_customer_repricing_configs REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_customers

def list_customers(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListCustomersResponse

Baseline implementation for the list_customers REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_entitlement_changes

def list_entitlement_changes(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListEntitlementChangesResponse

Baseline implementation for the list_entitlement_changes REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_entitlements

def list_entitlements(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListEntitlementsResponse

Baseline implementation for the list_entitlements REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_offers

def list_offers(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListOffersResponse

Baseline implementation for the list_offers REST call

Parameters
  • request_pb (::Google::Cloud::Channel::V1::ListOffersRequest) — 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)

#list_products

def list_products(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListProductsResponse

Baseline implementation for the list_products REST call

Parameters
  • request_pb (::Google::Cloud::Channel::V1::ListProductsRequest) — 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)

#list_purchasable_offers

def list_purchasable_offers(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListPurchasableOffersResponse

Baseline implementation for the list_purchasable_offers REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_purchasable_skus

def list_purchasable_skus(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListPurchasableSkusResponse

Baseline implementation for the list_purchasable_skus REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_sku_group_billable_skus

def list_sku_group_billable_skus(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListSkuGroupBillableSkusResponse

Baseline implementation for the list_sku_group_billable_skus REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_sku_groups

def list_sku_groups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListSkuGroupsResponse

Baseline implementation for the list_sku_groups REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_skus

def list_skus(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListSkusResponse

Baseline implementation for the list_skus REST call

Parameters
  • request_pb (::Google::Cloud::Channel::V1::ListSkusRequest) — 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)

#list_subscribers

def list_subscribers(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListSubscribersResponse

Baseline implementation for the list_subscribers REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_transferable_offers

def list_transferable_offers(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListTransferableOffersResponse

Baseline implementation for the list_transferable_offers REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_transferable_skus

def list_transferable_skus(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ListTransferableSkusResponse

Baseline implementation for the list_transferable_skus REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#lookup_offer

def lookup_offer(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::Offer

Baseline implementation for the lookup_offer REST call

Parameters
  • request_pb (::Google::Cloud::Channel::V1::LookupOfferRequest) — 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)

#provision_cloud_identity

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

Baseline implementation for the provision_cloud_identity REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#query_eligible_billing_accounts

def query_eligible_billing_accounts(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::QueryEligibleBillingAccountsResponse

Baseline implementation for the query_eligible_billing_accounts REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#register_subscriber

def register_subscriber(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::RegisterSubscriberResponse

Baseline implementation for the register_subscriber REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#start_paid_service

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

Baseline implementation for the start_paid_service REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#suspend_entitlement

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

Baseline implementation for the suspend_entitlement REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#transfer_entitlements

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

Baseline implementation for the transfer_entitlements REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#transfer_entitlements_to_google

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

Baseline implementation for the transfer_entitlements_to_google REST call

Parameters
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)

#unregister_subscriber

def unregister_subscriber(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::UnregisterSubscriberResponse

Baseline implementation for the unregister_subscriber REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_channel_partner_link

def update_channel_partner_link(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ChannelPartnerLink

Baseline implementation for the update_channel_partner_link REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_channel_partner_repricing_config

def update_channel_partner_repricing_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig

Baseline implementation for the update_channel_partner_repricing_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_customer

def update_customer(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::Customer

Baseline implementation for the update_customer REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_customer_repricing_config

def update_customer_repricing_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Channel::V1::CustomerRepricingConfig

Baseline implementation for the update_customer_repricing_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)