Class: Google::Cloud::Compute::V1::ForwardingRules::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Compute::V1::ForwardingRules::Rest::Client
- Defined in:
- lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb
Overview
REST client for the ForwardingRules service.
The ForwardingRules API.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ForwardingRules Client class.
Instance Method Summary collapse
-
#aggregated_list(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::ForwardingRulesScopedList>
Retrieves an aggregated list of forwarding rules.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ForwardingRules Client instance.
-
#delete(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Deletes the specified ForwardingRule resource.
-
#get(request, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::ForwardingRule
Returns the specified ForwardingRule resource.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ForwardingRules REST client object.
-
#insert(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
-
#list(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::ForwardingRule>
Retrieves a list of ForwardingRule resources available to the specified project and region.
-
#patch(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Updates the specified forwarding rule with the data included in the request.
-
#set_labels(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Sets the labels on the specified resource.
-
#set_target(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Changes target URL for forwarding rule.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ForwardingRules REST client object.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 134 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @forwarding_rules_stub = ::Google::Cloud::Compute::V1::ForwardingRules::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ForwardingRules Client class.
See Configuration for a description of the configuration fields.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Compute", "V1"] 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.rpcs.aggregated_list.timeout = 600.0 default_config.rpcs.aggregated_list.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.delete.timeout = 600.0 default_config.rpcs.get.timeout = 600.0 default_config.rpcs.get.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.insert.timeout = 600.0 default_config.rpcs.list.timeout = 600.0 default_config.rpcs.list.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.patch.timeout = 600.0 default_config.rpcs.set_labels.timeout = 600.0 default_config.rpcs.set_target.timeout = 600.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#aggregated_list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::ForwardingRulesScopedList> #aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::ForwardingRulesScopedList>
Retrieves an aggregated list of forwarding rules.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 194 def aggregated_list request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AggregatedListForwardingRulesRequest # 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.aggregated_list..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.aggregated_list.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.aggregated_list request, do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @forwarding_rules_stub, :aggregated_list, "items", request, result, yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#configure {|config| ... } ⇒ Client::Configuration
Configure the ForwardingRules 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.
113 114 115 116 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 113 def configure yield @config if block_given? @config end |
#delete(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #delete(forwarding_rule: nil, project: nil, region: nil, request_id: nil) ⇒ ::Gapic::Rest::BaseOperation
Deletes the specified ForwardingRule resource.
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 262 def delete request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteForwardingRuleRequest # 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..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.delete.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.delete request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::ForwardingRule #get(forwarding_rule: nil, project: nil, region: nil) ⇒ ::Google::Cloud::Compute::V1::ForwardingRule
Returns the specified ForwardingRule resource.
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 355 356 357 358 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 328 def get request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetForwardingRuleRequest # 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..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.get.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.get request, do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#insert(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #insert(forwarding_rule_resource: nil, project: nil, region: nil, request_id: nil) ⇒ ::Gapic::Rest::BaseOperation
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 395 def insert request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertForwardingRuleRequest # 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.insert..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.insert.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.insert request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::ForwardingRule> #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::ForwardingRule>
Retrieves a list of ForwardingRule resources available to the specified project and region.
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 469 def list request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListForwardingRulesRequest # 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..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.list.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.list request, do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @forwarding_rules_stub, :list, "items", request, result, yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#patch(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #patch(forwarding_rule: nil, forwarding_rule_resource: nil, project: nil, region: nil, request_id: nil) ⇒ ::Gapic::Rest::BaseOperation
Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 539 def patch request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::PatchForwardingRuleRequest # 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.patch..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.patch.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.patch request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#set_labels(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #set_labels(project: nil, region: nil, region_set_labels_request_resource: nil, request_id: nil, resource: nil) ⇒ ::Gapic::Rest::BaseOperation
Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.
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 637 638 639 640 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 609 def set_labels request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetLabelsForwardingRuleRequest # 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.set_labels..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.set_labels.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.set_labels request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#set_target(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #set_target(forwarding_rule: nil, project: nil, region: nil, request_id: nil, target_reference_resource: nil) ⇒ ::Gapic::Rest::BaseOperation
Changes target URL for forwarding rule. The new target should be of the same type as the old target.
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 |
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 679 def set_target request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetTargetForwardingRuleRequest # 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.set_target..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.set_target.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @forwarding_rules_stub.set_target request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |