Class: Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Client
- Inherits:
-
Object
- Object
- Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Client
- Includes:
- Paths
- Defined in:
- lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb
Overview
Client for the RegionsService service.
Manages regions configuration.
This API defines the following resource model:
- [Region][google.shopping.merchant.accounts.v1main.Region]
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the RegionsService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the RegionsService Client instance.
-
#create_region(request, options = nil) {|response, operation| ... } ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region
Creates a region definition in your Merchant Center account.
-
#delete_region(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a region definition from your Merchant Center account.
-
#get_region(request, options = nil) {|response, operation| ... } ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region
Retrieves a region defined in your Merchant Center account.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new RegionsService client object.
-
#list_regions(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region>
Lists the regions in your Merchant Center account.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_region(request, options = nil) {|response, operation| ... } ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region
Updates a region definition in your Merchant Center account.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new RegionsService client object.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 134 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 |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the RegionsService Client class.
See Configuration for a description of the configuration fields.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 67 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 |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the RegionsService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
104 105 106 107 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 104 def configure yield @config if block_given? @config end |
#create_region(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region #create_region(parent: nil, region_id: nil, region: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region
Creates a region definition in your Merchant Center account. Executing this method requires admin access.
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 314 def create_region request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_region..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_region.timeout, metadata: , retry_policy: @config.rpcs.create_region.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @regions_service_stub.call_rpc :create_region, request, 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 |
#delete_region(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_region(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes a region definition from your Merchant Center account. Executing this method requires admin access.
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 493 def delete_region request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_region..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_region.timeout, metadata: , retry_policy: @config.rpcs.delete_region.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @regions_service_stub.call_rpc :delete_region, request, 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 |
#get_region(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region #get_region(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region
Retrieves a region defined in your Merchant Center account.
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 221 def get_region request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_region..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_region.timeout, metadata: , retry_policy: @config.rpcs.get_region.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @regions_service_stub.call_rpc :get_region, request, 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 |
#list_regions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region> #list_regions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region>
Lists the regions in your Merchant Center account.
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 595 def list_regions request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_regions..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_regions.timeout, metadata: , retry_policy: @config.rpcs.list_regions.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @regions_service_stub.call_rpc :list_regions, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @regions_service_stub, :list_regions, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
114 115 116 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 114 def universe_domain @regions_service_stub.universe_domain end |
#update_region(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region #update_region(region: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region
Updates a region definition in your Merchant Center account. Executing this method requires admin access.
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb', line 405 def update_region request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_region..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_region.timeout, metadata: , retry_policy: @config.rpcs.update_region.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @regions_service_stub.call_rpc :update_region, request, 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 |