Class: Google::Cloud::Monitoring::V3::GroupServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/group_service_client.rb

Overview

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.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"monitoring.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/monitoring",
  "https://www.googleapis.com/auth/monitoring.read",
  "https://www.googleapis.com/auth/monitoring.write"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ GroupServiceClient

Returns a new instance of GroupServiceClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.



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
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 141

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    updater_proc: nil,
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/monitoring/v3/group_service_services_pb"

  if channel || chan_creds || updater_proc
    warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
      "on 2017/09/08"
    credentials ||= channel
    credentials ||= chan_creds
    credentials ||= updater_proc
  end
  if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
    warn "`service_path` and `port` parameters are deprecated and will be removed"
  end

  credentials ||= Google::Cloud::Monitoring::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Monitoring::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "group_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.monitoring.v3.GroupService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @group_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Monitoring::V3::GroupService::Stub.method(:new)
  )

  @list_groups = Google::Gax.create_api_call(
    @group_service_stub.method(:list_groups),
    defaults["list_groups"]
  )
  @get_group = Google::Gax.create_api_call(
    @group_service_stub.method(:get_group),
    defaults["get_group"]
  )
  @create_group = Google::Gax.create_api_call(
    @group_service_stub.method(:create_group),
    defaults["create_group"]
  )
  @update_group = Google::Gax.create_api_call(
    @group_service_stub.method(:update_group),
    defaults["update_group"]
  )
  @delete_group = Google::Gax.create_api_call(
    @group_service_stub.method(:delete_group),
    defaults["delete_group"]
  )
  @list_group_members = Google::Gax.create_api_call(
    @group_service_stub.method(:list_group_members),
    defaults["list_group_members"]
  )
end

Instance Attribute Details

#group_service_stub ⇒ Google::Monitoring::V3::GroupService::Stub (readonly)

Returns:

  • (Google::Monitoring::V3::GroupService::Stub) 


52
53
54
55
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
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
126
127
128
129
130
131
132
133
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
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
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
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 52

class GroupServiceClient
  attr_reader :group_service_stub

  # The default address of the service.
  SERVICE_ADDRESS = "monitoring.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_groups" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "group"),
    "list_group_members" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "members")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/monitoring",
    "https://www.googleapis.com/auth/monitoring.read",
    "https://www.googleapis.com/auth/monitoring.write"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  GROUP_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/groups/{group}"
  )

  private_constant :GROUP_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified group resource name string.
  # @param project [String]
  # @param group [String]
  # @return [String]
  def self.group_path project, group
    GROUP_PATH_TEMPLATE.render(
      :"project" => project,
      :"group" => group
    )
  end

  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      updater_proc: nil,
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      lib_name: nil,
      lib_version: ""
    # 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 "google/gax/grpc"
    require "google/monitoring/v3/group_service_services_pb"

    if channel || chan_creds || updater_proc
      warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
        "on 2017/09/08"
      credentials ||= channel
      credentials ||= chan_creds
      credentials ||= updater_proc
    end
    if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
      warn "`service_path` and `port` parameters are deprecated and will be removed"
    end

    credentials ||= Google::Cloud::Monitoring::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Monitoring::Credentials.new(credentials).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "group_service_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.monitoring.v3.GroupService",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @group_service_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Monitoring::V3::GroupService::Stub.method(:new)
    )

    @list_groups = Google::Gax.create_api_call(
      @group_service_stub.method(:list_groups),
      defaults["list_groups"]
    )
    @get_group = Google::Gax.create_api_call(
      @group_service_stub.method(:get_group),
      defaults["get_group"]
    )
    @create_group = Google::Gax.create_api_call(
      @group_service_stub.method(:create_group),
      defaults["create_group"]
    )
    @update_group = Google::Gax.create_api_call(
      @group_service_stub.method(:update_group),
      defaults["update_group"]
    )
    @delete_group = Google::Gax.create_api_call(
      @group_service_stub.method(:delete_group),
      defaults["delete_group"]
    )
    @list_group_members = Google::Gax.create_api_call(
      @group_service_stub.method(:list_group_members),
      defaults["list_group_members"]
    )
  end

  # Service calls

  # Lists the existing groups.
  #
  # @param name [String]
  #   The project whose groups are to be listed. The format is
  #   +"projects/{project_id_or_number}"+.
  # @param children_of_group [String]
  #   A group name: +"projects/{project_id_or_number}/groups/{group_id}"+.
  #   Returns groups whose +parentName+ field contains the group
  #   name.  If no groups have this parent, the results are empty.
  # @param ancestors_of_group [String]
  #   A group name: +"projects/{project_id_or_number}/groups/{group_id}"+.
  #   Returns groups that are ancestors of the specified group.
  #   The groups are returned in order, starting with the immediate parent and
  #   ending with the most distant ancestor.  If the specified group has no
  #   immediate parent, the results are empty.
  # @param descendants_of_group [String]
  #   A group name: +"projects/{project_id_or_number}/groups/{group_id}"+.
  #   Returns the descendants of the specified group.  This is a superset of
  #   the results returned by the +childrenOfGroup+ filter, and includes
  #   children-of-children, and so forth.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Monitoring::V3::Group>]
  #   An enumerable of Google::Monitoring::V3::Group instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring/v3"
  #
  #   group_service_client = Google::Cloud::Monitoring::V3::Group.new
  #   formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   group_service_client.list_groups(formatted_name).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   group_service_client.list_groups(formatted_name).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_groups \
      name,
      children_of_group: nil,
      ancestors_of_group: nil,
      descendants_of_group: nil,
      page_size: nil,
      options: nil
    req = {
      name: name,
      children_of_group: children_of_group,
      ancestors_of_group: ancestors_of_group,
      descendants_of_group: descendants_of_group,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListGroupsRequest)
    @list_groups.call(req, options)
  end

  # Gets a single group.
  #
  # @param name [String]
  #   The group to retrieve. The format is
  #   +"projects/{project_id_or_number}/groups/{group_id}"+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Monitoring::V3::Group]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring/v3"
  #
  #   group_service_client = Google::Cloud::Monitoring::V3::Group.new
  #   formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.group_path("[PROJECT]", "[GROUP]")
  #   response = group_service_client.get_group(formatted_name)

  def get_group \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::GetGroupRequest)
    @get_group.call(req, options)
  end

  # Creates a new group.
  #
  # @param name [String]
  #   The project in which to create the group. The format is
  #   +"projects/{project_id_or_number}"+.
  # @param group [Google::Monitoring::V3::Group | Hash]
  #   A group definition. It is an error to define the +name+ field because
  #   the system assigns the name.
  #   A hash of the same form as `Google::Monitoring::V3::Group`
  #   can also be provided.
  # @param validate_only [true, false]
  #   If true, validate this request but do not create the group.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Monitoring::V3::Group]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring/v3"
  #
  #   group_service_client = Google::Cloud::Monitoring::V3::Group.new
  #   formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.project_path("[PROJECT]")
  #   group = {}
  #   response = group_service_client.create_group(formatted_name, group)

  def create_group \
      name,
      group,
      validate_only: nil,
      options: nil
    req = {
      name: name,
      group: group,
      validate_only: validate_only
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::CreateGroupRequest)
    @create_group.call(req, options)
  end

  # Updates an existing group.
  # You can change any group attributes except +name+.
  #
  # @param group [Google::Monitoring::V3::Group | Hash]
  #   The new definition of the group.  All fields of the existing group,
  #   excepting +name+, are replaced with the corresponding fields of this group.
  #   A hash of the same form as `Google::Monitoring::V3::Group`
  #   can also be provided.
  # @param validate_only [true, false]
  #   If true, validate this request but do not update the existing group.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Monitoring::V3::Group]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring/v3"
  #
  #   group_service_client = Google::Cloud::Monitoring::V3::Group.new
  #   group = {}
  #   response = group_service_client.update_group(group)

  def update_group \
      group,
      validate_only: nil,
      options: nil
    req = {
      group: group,
      validate_only: validate_only
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::UpdateGroupRequest)
    @update_group.call(req, options)
  end

  # Deletes an existing group.
  #
  # @param name [String]
  #   The group to delete. The format is
  #   +"projects/{project_id_or_number}/groups/{group_id}"+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring/v3"
  #
  #   group_service_client = Google::Cloud::Monitoring::V3::Group.new
  #   formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.group_path("[PROJECT]", "[GROUP]")
  #   group_service_client.delete_group(formatted_name)

  def delete_group \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::DeleteGroupRequest)
    @delete_group.call(req, options)
    nil
  end

  # Lists the monitored resources that are members of a group.
  #
  # @param name [String]
  #   The group whose members are listed. The format is
  #   +"projects/{project_id_or_number}/groups/{group_id}"+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param filter [String]
  #   An optional [list filter](https://cloud.google.com/monitoring/api/learn_more#filtering) describing
  #   the members to be returned.  The filter may reference the type, labels, and
  #   metadata of monitored resources that comprise the group.
  #   For example, to return only resources representing Compute Engine VM
  #   instances, use this filter:
  #
  #       resource.type = "gce_instance"
  # @param interval [Google::Monitoring::V3::TimeInterval | Hash]
  #   An optional time interval for which results should be returned. Only
  #   members that were part of the group during the specified interval are
  #   included in the response.  If no interval is provided then the group
  #   membership over the last minute is returned.
  #   A hash of the same form as `Google::Monitoring::V3::TimeInterval`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Api::MonitoredResource>]
  #   An enumerable of Google::Api::MonitoredResource instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring/v3"
  #
  #   group_service_client = Google::Cloud::Monitoring::V3::Group.new
  #   formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.group_path("[PROJECT]", "[GROUP]")
  #
  #   # Iterate over all results.
  #   group_service_client.list_group_members(formatted_name).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   group_service_client.list_group_members(formatted_name).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_group_members \
      name,
      page_size: nil,
      filter: nil,
      interval: nil,
      options: nil
    req = {
      name: name,
      page_size: page_size,
      filter: filter,
      interval: interval
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListGroupMembersRequest)
    @list_group_members.call(req, options)
  end
end

Class Method Details

.group_path(project, group) ⇒ String

Returns a fully-qualified group resource name string.

Parameters:

  • project (String)
  • group (String)

Returns:

  • (String) 


110
111
112
113
114
115
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 110

def self.group_path project, group
  GROUP_PATH_TEMPLATE.render(
    :"project" => project,
    :"group" => group
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


100
101
102
103
104
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 100

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#create_group(name, group, validate_only: nil, options: nil) ⇒ Google::Monitoring::V3::Group

Creates a new group.

Examples:

require "google/cloud/monitoring/v3"

group_service_client = Google::Cloud::Monitoring::V3::Group.new
formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.project_path("[PROJECT]")
group = {}
response = group_service_client.create_group(formatted_name, group)

Parameters:

  • name (String) —

    The project in which to create the group. The format is +"projects/project_id_or_number"+.

  • group (Google::Monitoring::V3::Group | Hash) —

    A group definition. It is an error to define the +name+ field because the system assigns the name. A hash of the same form as Google::Monitoring::V3::Group can also be provided.

  • validate_only (true, false) —

    If true, validate this request but do not create the group.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 372

def create_group \
    name,
    group,
    validate_only: nil,
    options: nil
  req = {
    name: name,
    group: group,
    validate_only: validate_only
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::CreateGroupRequest)
  @create_group.call(req, options)
end

#delete_group(name, options: nil) ⇒ Object

Deletes an existing group.

Examples:

require "google/cloud/monitoring/v3"

group_service_client = Google::Cloud::Monitoring::V3::Group.new
formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.group_path("[PROJECT]", "[GROUP]")
group_service_client.delete_group(formatted_name)

Parameters:

  • name (String) —

    The group to delete. The format is +"projects/project_id_or_number/groups/group_id"+.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



436
437
438
439
440
441
442
443
444
445
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 436

def delete_group \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::DeleteGroupRequest)
  @delete_group.call(req, options)
  nil
end

#get_group(name, options: nil) ⇒ Google::Monitoring::V3::Group

Gets a single group.

Examples:

require "google/cloud/monitoring/v3"

group_service_client = Google::Cloud::Monitoring::V3::Group.new
formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.group_path("[PROJECT]", "[GROUP]")
response = group_service_client.get_group(formatted_name)

Parameters:

  • name (String) —

    The group to retrieve. The format is +"projects/project_id_or_number/groups/group_id"+.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



337
338
339
340
341
342
343
344
345
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 337

def get_group \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::GetGroupRequest)
  @get_group.call(req, options)
end

#list_group_members(name, page_size: nil, filter: nil, interval: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Api::MonitoredResource>

Lists the monitored resources that are members of a group.

Examples:

require "google/cloud/monitoring/v3"

group_service_client = Google::Cloud::Monitoring::V3::Group.new
formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.group_path("[PROJECT]", "[GROUP]")

# Iterate over all results.
group_service_client.list_group_members(formatted_name).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
group_service_client.list_group_members(formatted_name).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • name (String) —

    The group whose members are listed. The format is +"projects/project_id_or_number/groups/group_id"+.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • filter (String) —

    An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:

    resource.type = "gce_instance"
  • interval (Google::Monitoring::V3::TimeInterval | Hash) —

    An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned. A hash of the same form as Google::Monitoring::V3::TimeInterval can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::PagedEnumerable<Google::Api::MonitoredResource>) —

    An enumerable of Google::Api::MonitoredResource instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 501

def list_group_members \
    name,
    page_size: nil,
    filter: nil,
    interval: nil,
    options: nil
  req = {
    name: name,
    page_size: page_size,
    filter: filter,
    interval: interval
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListGroupMembersRequest)
  @list_group_members.call(req, options)
end

#list_groups(name, children_of_group: nil, ancestors_of_group: nil, descendants_of_group: nil, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Monitoring::V3::Group>

Lists the existing groups.

Examples:

require "google/cloud/monitoring/v3"

group_service_client = Google::Cloud::Monitoring::V3::Group.new
formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.project_path("[PROJECT]")

# Iterate over all results.
group_service_client.list_groups(formatted_name).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
group_service_client.list_groups(formatted_name).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • name (String) —

    The project whose groups are to be listed. The format is +"projects/project_id_or_number"+.

  • children_of_group (String) —

    A group name: +"projects/project_id_or_number/groups/group_id"+. Returns groups whose +parentName+ field contains the group name. If no groups have this parent, the results are empty.

  • ancestors_of_group (String) —

    A group name: +"projects/project_id_or_number/groups/group_id"+. Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

  • descendants_of_group (String) —

    A group name: +"projects/project_id_or_number/groups/group_id"+. Returns the descendants of the specified group. This is a superset of the results returned by the +childrenOfGroup+ filter, and includes children-of-children, and so forth.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::PagedEnumerable<Google::Monitoring::V3::Group>) —

    An enumerable of Google::Monitoring::V3::Group instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 302

def list_groups \
    name,
    children_of_group: nil,
    ancestors_of_group: nil,
    descendants_of_group: nil,
    page_size: nil,
    options: nil
  req = {
    name: name,
    children_of_group: children_of_group,
    ancestors_of_group: ancestors_of_group,
    descendants_of_group: descendants_of_group,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListGroupsRequest)
  @list_groups.call(req, options)
end

#update_group(group, validate_only: nil, options: nil) ⇒ Google::Monitoring::V3::Group

Updates an existing group. You can change any group attributes except +name+.

Examples:

require "google/cloud/monitoring/v3"

group_service_client = Google::Cloud::Monitoring::V3::Group.new
group = {}
response = group_service_client.update_group(group)

Parameters:

  • group (Google::Monitoring::V3::Group | Hash) —

    The new definition of the group. All fields of the existing group, excepting +name+, are replaced with the corresponding fields of this group. A hash of the same form as Google::Monitoring::V3::Group can also be provided.

  • validate_only (true, false) —

    If true, validate this request but do not update the existing group.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/google/cloud/monitoring/v3/group_service_client.rb', line 408

def update_group \
    group,
    validate_only: nil,
    options: nil
  req = {
    group: group,
    validate_only: validate_only
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::UpdateGroupRequest)
  @update_group.call(req, options)
end