class Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Client
- [Region][google.shopping.merchant.accounts.v1main.Region]
This API defines the following resource model:
Manages regions configuration.
Client for the RegionsService service.
#
def self.configure
-
(Client::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def self.configure @configure ||= begin namespace = ["Google", "Shopping", "Merchant", "Accounts", "V1beta"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end
def configure
-
(Client::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def configure yield @config if block_given? @config end
def create_region request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the RPC is aborted.
Returns:
-
(::Google::Shopping::Merchant::Accounts::V1beta::Region)
-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
region
(::Google::Shopping::Merchant::Accounts::V1beta::Region, ::Hash
) -- -
region_id
(::String
) -- -
parent
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Shopping::Merchant::Accounts::V1beta::CreateRegionRequest, ::Hash
) --
Overloads:
-
create_region(parent: nil, region_id: nil, region: nil)
-
create_region(request, options = nil)
def create_region request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::CreateRegionRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_region.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_region.timeout, metadata: metadata, retry_policy: @config.rpcs.create_region.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @regions_service_stub.call_rpc :create_region, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def delete_region request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the RPC is aborted.
Returns:
-
(::Google::Protobuf::Empty)
-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Shopping::Merchant::Accounts::V1beta::DeleteRegionRequest, ::Hash
) --
Overloads:
-
delete_region(name: nil)
-
delete_region(request, options = nil)
def delete_region request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::DeleteRegionRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_region.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_region.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_region.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @regions_service_stub.call_rpc :delete_region, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def get_region request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the RPC is aborted.
Returns:
-
(::Google::Shopping::Merchant::Accounts::V1beta::Region)
-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Shopping::Merchant::Accounts::V1beta::GetRegionRequest, ::Hash
) --
Overloads:
-
get_region(name: nil)
-
get_region(request, options = nil)
def get_region request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::GetRegionRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_region.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_region.timeout, metadata: metadata, retry_policy: @config.rpcs.get_region.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @regions_service_stub.call_rpc :get_region, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def initialize
- Yieldparam: config -
Other tags:
- Yield: - Configure the RegionsService client.
def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/shopping/merchant/accounts/v1beta/regions_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @regions_service_stub = ::Gapic::ServiceStub.new( ::Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end
def list_regions request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the RPC is aborted.
Returns:
-
(::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region>)
-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
page_token
(::String
) -- -
page_size
(::Integer
) -- -
parent
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Shopping::Merchant::Accounts::V1beta::ListRegionsRequest, ::Hash
) --
Overloads:
-
list_regions(parent: nil, page_size: nil, page_token: nil)
-
list_regions(request, options = nil)
def list_regions request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::ListRegionsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_regions.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_regions.timeout, metadata: metadata, retry_policy: @config.rpcs.list_regions.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @regions_service_stub.call_rpc :list_regions, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @regions_service_stub, :list_regions, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def universe_domain
-
(String)
-
def universe_domain @regions_service_stub.universe_domain end
def update_region request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the RPC is aborted.
Returns:
-
(::Google::Shopping::Merchant::Accounts::V1beta::Region)
-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
update_mask
(::Google::Protobuf::FieldMask, ::Hash
) -- -
region
(::Google::Shopping::Merchant::Accounts::V1beta::Region, ::Hash
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Shopping::Merchant::Accounts::V1beta::UpdateRegionRequest, ::Hash
) --
Overloads:
-
update_region(region: nil, update_mask: nil)
-
update_region(request, options = nil)
def update_region request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::UpdateRegionRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_region.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.region&.name header_params["region.name"] = request.region.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_region.timeout, metadata: metadata, retry_policy: @config.rpcs.update_region.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @regions_service_stub.call_rpc :update_region, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end