Class: Google::Cloud::Compute::V1::InstanceGroups::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Compute::V1::InstanceGroups::Rest::Client
- Defined in:
- lib/google/cloud/compute/v1/instance_groups/rest/client.rb
Overview
REST client for the InstanceGroups service.
The InstanceGroups API.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the InstanceGroups Client class.
Instance Method Summary collapse
-
#add_instances(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Adds a list of instances to the specified instance group.
-
#aggregated_list(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstanceGroupsScopedList>
Retrieves the list of instance groups and sorts them by zone.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the InstanceGroups Client instance.
-
#delete(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Deletes the specified instance group.
-
#get(request, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::InstanceGroup
Returns the specified zonal instance group.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new InstanceGroups REST client object.
-
#insert(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Creates an instance group in the specified project using the parameters that are included in the request.
-
#list(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceGroup>
Retrieves the list of zonal instance group resources contained within the specified zone.
-
#list_instances(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceWithNamedPorts>
Lists the instances in the specified instance group.
-
#remove_instances(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Removes one or more instances from the specified instance group, but does not delete those instances.
-
#set_named_ports(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Sets the named ports for the specified instance group.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new InstanceGroups REST client object.
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 136 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 @instance_groups_stub = ::Google::Cloud::Compute::V1::InstanceGroups::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the InstanceGroups 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 97 98 |
# File 'lib/google/cloud/compute/v1/instance_groups/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.add_instances.timeout = 600.0 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.list_instances.timeout = 600.0 default_config.rpcs.remove_instances.timeout = 600.0 default_config.rpcs.set_named_ports.timeout = 600.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#add_instances(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #add_instances(instance_group: nil, instance_groups_add_instances_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::Rest::BaseOperation
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
192 193 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 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 192 def add_instances request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AddInstancesInstanceGroupRequest # 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.add_instances..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.add_instances.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @instance_groups_stub.add_instances 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 |
#aggregated_list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstanceGroupsScopedList> #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::InstanceGroupsScopedList>
Retrieves the list of instance groups and sorts them by zone.
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 294 295 296 297 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 266 def aggregated_list request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AggregatedListInstanceGroupsRequest # 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. @instance_groups_stub.aggregated_list request, do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @instance_groups_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 InstanceGroups 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.
115 116 117 118 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 115 def configure yield @config if block_given? @config end |
#delete(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #delete(instance_group: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::Rest::BaseOperation
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
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 359 360 361 362 363 364 365 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 334 def delete request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteInstanceGroupRequest # 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. @instance_groups_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::InstanceGroup #get(instance_group: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::InstanceGroup
Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
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 427 428 429 430 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 400 def get request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetInstanceGroupRequest # 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. @instance_groups_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(instance_group_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::Rest::BaseOperation
Creates an instance group in the specified project using the parameters that are included in the request.
467 468 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 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 467 def insert request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertInstanceGroupRequest # 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. @instance_groups_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::InstanceGroup> #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceGroup>
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
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 571 572 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 541 def list request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListInstanceGroupsRequest # 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. @instance_groups_stub.list request, do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @instance_groups_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 |
#list_instances(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceWithNamedPorts> #list_instances(filter: nil, instance_group: nil, instance_groups_list_instances_request_resource: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceWithNamedPorts>
Lists the instances in the specified instance group. The orderBy query parameter is not supported.
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 619 def list_instances request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListInstancesInstanceGroupsRequest # 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_instances..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_instances.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @instance_groups_stub.list_instances request, do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @instance_groups_stub, :list_instances, "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 |
#remove_instances(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #remove_instances(instance_group: nil, instance_groups_remove_instances_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::Rest::BaseOperation
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 689 def remove_instances request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::RemoveInstancesInstanceGroupRequest # 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.remove_instances..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.remove_instances.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @instance_groups_stub.remove_instances 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_named_ports(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #set_named_ports(instance_group: nil, instance_groups_set_named_ports_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::Rest::BaseOperation
Sets the named ports for the specified instance group.
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 |
# File 'lib/google/cloud/compute/v1/instance_groups/rest/client.rb', line 759 def set_named_ports request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetNamedPortsInstanceGroupRequest # 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_named_ports..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_named_ports.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @instance_groups_stub.set_named_ports 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 |