Class: Google::Cloud::Monitoring::V3::GroupService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::V3::GroupService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/monitoring/v3/group_service/client.rb
Overview
Client for the GroupService service.
The Group API lets you inspect and manage your groups.
A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the GroupService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the GroupService Client instance.
-
#create_group(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::Group
Creates a new group.
-
#delete_group(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an existing group.
-
#get_group(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::Group
Gets a single group.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new GroupService client object.
-
#list_group_members(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResource>
Lists the monitored resources that are members of a group.
-
#list_groups(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::Group>
Lists the existing groups.
-
#update_group(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::V3::Group
Updates an existing group.
Methods included from Paths
#folder_path, #group_path, #organization_path, #workspace_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new GroupService client object.
Examples
To create a new GroupService client with the default configuration:
client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new
To create a new GroupService client with a custom configuration:
client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new do |config|
config.timeout = 10.0
end
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 167 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/monitoring/v3/group_service_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 scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @config.endpoint == Client.configure.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 @group_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Monitoring::V3::GroupService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the GroupService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all GroupService clients:
::Google::Cloud::Monitoring::V3::GroupService::Client.configure do |config|
config.timeout = 10.0
end
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 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 68 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Monitoring", "V3"] 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.list_groups.timeout = 30.0 default_config.rpcs.list_groups.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.get_group.timeout = 30.0 default_config.rpcs.get_group.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.create_group.timeout = 30.0 default_config.rpcs.update_group.timeout = 30.0 default_config.rpcs.update_group.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.delete_group.timeout = 30.0 default_config.rpcs.delete_group.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.list_group_members.timeout = 30.0 default_config.rpcs.list_group_members.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the GroupService 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.
142 143 144 145 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 142 def configure yield @config if block_given? @config end |
#create_group(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Group #create_group(name: nil, group: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::V3::Group
Creates a new group.
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 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 409 def create_group request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::CreateGroupRequest # 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_group..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Monitoring::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_group.timeout, metadata: , retry_policy: @config.rpcs.create_group.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @group_service_stub.call_rpc :create_group, 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_group(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_group(name: nil, recursive: nil) ⇒ ::Google::Protobuf::Empty
Deletes an existing group.
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 551 def delete_group request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::DeleteGroupRequest # 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_group..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Monitoring::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_group.timeout, metadata: , retry_policy: @config.rpcs.delete_group.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @group_service_stub.call_rpc :delete_group, 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_group(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Group #get_group(name: nil) ⇒ ::Google::Cloud::Monitoring::V3::Group
Gets a single group.
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 366 367 368 369 370 371 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 336 def get_group request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetGroupRequest # 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_group..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Monitoring::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_group.timeout, metadata: , retry_policy: @config.rpcs.get_group.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @group_service_stub.call_rpc :get_group, 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_group_members(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResource> #list_group_members(name: nil, page_size: nil, page_token: nil, filter: nil, interval: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResource>
Lists the monitored resources that are members of a group.
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 639 def list_group_members request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListGroupMembersRequest # 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_group_members..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Monitoring::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_group_members.timeout, metadata: , retry_policy: @config.rpcs.list_group_members.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @group_service_stub.call_rpc :list_group_members, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @group_service_stub, :list_group_members, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_groups(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::Group> #list_groups(name: nil, children_of_group: nil, ancestors_of_group: nil, descendants_of_group: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::Group>
Lists the existing groups.
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 298 299 300 301 302 303 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 267 def list_groups request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListGroupsRequest # 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_groups..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Monitoring::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_groups.timeout, metadata: , retry_policy: @config.rpcs.list_groups.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @group_service_stub.call_rpc :list_groups, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @group_service_stub, :list_groups, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#update_group(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Group #update_group(group: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::V3::Group
Updates an existing group.
You can change any group attributes except name
.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 479 def update_group request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::UpdateGroupRequest # 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_group..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Monitoring::V3::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "group.name" => request.group.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_group.timeout, metadata: , retry_policy: @config.rpcs.update_group.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @group_service_stub.call_rpc :update_group, 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 |