Class: Google::Cloud::Monitoring::V3::UptimeCheckServiceClient

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

Overview

The UptimeCheckService API is used to manage (list, create, delete, edit) uptime check configurations in the Stackdriver Monitoring product. An uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the Cloud Console, selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".

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
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
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(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ UptimeCheckServiceClient

Returns a new instance of UptimeCheckServiceClient

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.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



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
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 143

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    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/uptime_service_services_pb"

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

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Monitoring::V3::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

  package_version = Gem.loaded_specs['google-cloud-monitoring'].version.version

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

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "uptime_check_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.monitoring.v3.UptimeCheckService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @uptime_check_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Monitoring::V3::UptimeCheckService::Stub.method(:new)
  )

  @list_uptime_check_configs = Google::Gax.create_api_call(
    @uptime_check_service_stub.method(:list_uptime_check_configs),
    defaults["list_uptime_check_configs"],
    exception_transformer: exception_transformer
  )
  @get_uptime_check_config = Google::Gax.create_api_call(
    @uptime_check_service_stub.method(:get_uptime_check_config),
    defaults["get_uptime_check_config"],
    exception_transformer: exception_transformer
  )
  @create_uptime_check_config = Google::Gax.create_api_call(
    @uptime_check_service_stub.method(:create_uptime_check_config),
    defaults["create_uptime_check_config"],
    exception_transformer: exception_transformer
  )
  @update_uptime_check_config = Google::Gax.create_api_call(
    @uptime_check_service_stub.method(:update_uptime_check_config),
    defaults["update_uptime_check_config"],
    exception_transformer: exception_transformer
  )
  @delete_uptime_check_config = Google::Gax.create_api_call(
    @uptime_check_service_stub.method(:delete_uptime_check_config),
    defaults["delete_uptime_check_config"],
    exception_transformer: exception_transformer
  )
  @list_uptime_check_ips = Google::Gax.create_api_call(
    @uptime_check_service_stub.method(:list_uptime_check_ips),
    defaults["list_uptime_check_ips"],
    exception_transformer: exception_transformer
  )
end

Instance Attribute Details

#uptime_check_service_stub ⇒ Google::Monitoring::V3::UptimeCheckService::Stub (readonly)

Returns:

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


45
46
47
48
49
50
51
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
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 45

class UptimeCheckServiceClient
  attr_reader :uptime_check_service_stub

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

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  # The default set of gRPC interceptors.
  GRPC_INTERCEPTORS = []

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_uptime_check_configs" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "uptime_check_configs"),
    "list_uptime_check_ips" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "uptime_check_ips")
  }.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

  UPTIME_CHECK_CONFIG_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/uptimeCheckConfigs/{uptime_check_config}"
  )

  private_constant :UPTIME_CHECK_CONFIG_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 uptime_check_config resource name string.
  # @param project [String]
  # @param uptime_check_config [String]
  # @return [String]
  def self.uptime_check_config_path project, uptime_check_config
    UPTIME_CHECK_CONFIG_PATH_TEMPLATE.render(
      :"project" => project,
      :"uptime_check_config" => uptime_check_config
    )
  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.
  # @param metadata [Hash]
  #   Default metadata to be sent with each request. This can be overridden on a per call basis.
  # @param exception_transformer [Proc]
  #   An optional proc that intercepts any exceptions raised during an API call to inject
  #   custom error handling.
  def initialize \
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      metadata: nil,
      exception_transformer: nil,
      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/uptime_service_services_pb"

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

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Monitoring::V3::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

    package_version = Gem.loaded_specs['google-cloud-monitoring'].version.version

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

    headers = { :"x-goog-api-client" => google_api_client }
    headers.merge!(metadata) unless metadata.nil?
    client_config_file = Pathname.new(__dir__).join(
      "uptime_check_service_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.monitoring.v3.UptimeCheckService",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        metadata: headers
      )
    end

    # Allow overriding the service path/port in subclasses.
    service_path = self.class::SERVICE_ADDRESS
    port = self.class::DEFAULT_SERVICE_PORT
    interceptors = self.class::GRPC_INTERCEPTORS
    @uptime_check_service_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      interceptors: interceptors,
      &Google::Monitoring::V3::UptimeCheckService::Stub.method(:new)
    )

    @list_uptime_check_configs = Google::Gax.create_api_call(
      @uptime_check_service_stub.method(:list_uptime_check_configs),
      defaults["list_uptime_check_configs"],
      exception_transformer: exception_transformer
    )
    @get_uptime_check_config = Google::Gax.create_api_call(
      @uptime_check_service_stub.method(:get_uptime_check_config),
      defaults["get_uptime_check_config"],
      exception_transformer: exception_transformer
    )
    @create_uptime_check_config = Google::Gax.create_api_call(
      @uptime_check_service_stub.method(:create_uptime_check_config),
      defaults["create_uptime_check_config"],
      exception_transformer: exception_transformer
    )
    @update_uptime_check_config = Google::Gax.create_api_call(
      @uptime_check_service_stub.method(:update_uptime_check_config),
      defaults["update_uptime_check_config"],
      exception_transformer: exception_transformer
    )
    @delete_uptime_check_config = Google::Gax.create_api_call(
      @uptime_check_service_stub.method(:delete_uptime_check_config),
      defaults["delete_uptime_check_config"],
      exception_transformer: exception_transformer
    )
    @list_uptime_check_ips = Google::Gax.create_api_call(
      @uptime_check_service_stub.method(:list_uptime_check_ips),
      defaults["list_uptime_check_ips"],
      exception_transformer: exception_transformer
    )
  end

  # Service calls

  # Lists the existing valid uptime check configurations for the project,
  # leaving out any invalid configurations.
  #
  # @param parent [String]
  #   The project whose uptime check configurations are listed. The format
  #     is +projects/[PROJECT_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 options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Gax::PagedEnumerable<Google::Monitoring::V3::UptimeCheckConfig>]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Gax::PagedEnumerable<Google::Monitoring::V3::UptimeCheckConfig>]
  #   An enumerable of Google::Monitoring::V3::UptimeCheckConfig 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"
  #
  #   uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
  #   formatted_parent = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   uptime_check_service_client.list_uptime_check_configs(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   uptime_check_service_client.list_uptime_check_configs(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_uptime_check_configs \
      parent,
      page_size: nil,
      options: nil,
      &block
    req = {
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListUptimeCheckConfigsRequest)
    @list_uptime_check_configs.call(req, options, &block)
  end

  # Gets a single uptime check configuration.
  #
  # @param name [String]
  #   The uptime check configuration to retrieve. The format
  #     is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Monitoring::V3::UptimeCheckConfig]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Monitoring::V3::UptimeCheckConfig]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring"
  #
  #   uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
  #   formatted_name = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.uptime_check_config_path("[PROJECT]", "[UPTIME_CHECK_CONFIG]")
  #   response = uptime_check_service_client.get_uptime_check_config(formatted_name)

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

  # Creates a new uptime check configuration.
  #
  # @param parent [String]
  #   The project in which to create the uptime check. The format
  #     is +projects/[PROJECT_ID]+.
  # @param uptime_check_config [Google::Monitoring::V3::UptimeCheckConfig | Hash]
  #   The new uptime check configuration.
  #   A hash of the same form as `Google::Monitoring::V3::UptimeCheckConfig`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Monitoring::V3::UptimeCheckConfig]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Monitoring::V3::UptimeCheckConfig]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring"
  #
  #   uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
  #   formatted_parent = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.project_path("[PROJECT]")
  #
  #   # TODO: Initialize +uptime_check_config+:
  #   uptime_check_config = {}
  #   response = uptime_check_service_client.create_uptime_check_config(formatted_parent, uptime_check_config)

  def create_uptime_check_config \
      parent,
      uptime_check_config,
      options: nil,
      &block
    req = {
      parent: parent,
      uptime_check_config: uptime_check_config
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::CreateUptimeCheckConfigRequest)
    @create_uptime_check_config.call(req, options, &block)
  end

  # Updates an uptime check configuration. You can either replace the entire
  # configuration with a new one or replace only certain fields in the current
  # configuration by specifying the fields to be updated via +"updateMask"+.
  # Returns the updated configuration.
  #
  # @param uptime_check_config [Google::Monitoring::V3::UptimeCheckConfig | Hash]
  #   Required. If an +"updateMask"+ has been specified, this field gives
  #   the values for the set of fields mentioned in the +"updateMask"+. If an
  #   +"updateMask"+ has not been given, this uptime check configuration replaces
  #   the current configuration. If a field is mentioned in +"updateMask"+ but
  #   the corresonding field is omitted in this partial uptime check
  #   configuration, it has the effect of deleting/clearing the field from the
  #   configuration on the server.
  #
  #   The following fields can be updated: +display_name+,
  #   +http_check+, +tcp_check+, +timeout+, +content_matchers+, and
  #   +selected_regions+.
  #   A hash of the same form as `Google::Monitoring::V3::UptimeCheckConfig`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Optional. If present, only the listed fields in the current uptime check
  #   configuration are updated with values from the new configuration. If this
  #   field is empty, then the current configuration is completely replaced with
  #   the new configuration.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Monitoring::V3::UptimeCheckConfig]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Monitoring::V3::UptimeCheckConfig]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring"
  #
  #   uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
  #
  #   # TODO: Initialize +uptime_check_config+:
  #   uptime_check_config = {}
  #   response = uptime_check_service_client.update_uptime_check_config(uptime_check_config)

  def update_uptime_check_config \
      uptime_check_config,
      update_mask: nil,
      options: nil,
      &block
    req = {
      uptime_check_config: uptime_check_config,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::UpdateUptimeCheckConfigRequest)
    @update_uptime_check_config.call(req, options, &block)
  end

  # Deletes an uptime check configuration. Note that this method will fail
  # if the uptime check configuration is referenced by an alert policy or
  # other dependent configs that would be rendered invalid by the deletion.
  #
  # @param name [String]
  #   The uptime check configuration to delete. The format
  #     is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result []
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/monitoring"
  #
  #   uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
  #   formatted_name = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.uptime_check_config_path("[PROJECT]", "[UPTIME_CHECK_CONFIG]")
  #   uptime_check_service_client.delete_uptime_check_config(formatted_name)

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

  # Returns the list of IPs that checkers run from
  #
  # @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.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Gax::PagedEnumerable<Google::Monitoring::V3::UptimeCheckIp>]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Gax::PagedEnumerable<Google::Monitoring::V3::UptimeCheckIp>]
  #   An enumerable of Google::Monitoring::V3::UptimeCheckIp 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"
  #
  #   uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
  #
  #   # Iterate over all results.
  #   uptime_check_service_client.list_uptime_check_ips.each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   uptime_check_service_client.list_uptime_check_ips.each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_uptime_check_ips \
      page_size: nil,
      options: nil,
      &block
    req = {
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListUptimeCheckIpsRequest)
    @list_uptime_check_ips.call(req, options, &block)
  end
end

Class Method Details

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


97
98
99
100
101
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 97

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

.uptime_check_config_path(project, uptime_check_config) ⇒ String

Returns a fully-qualified uptime_check_config resource name string.

Parameters:

  • project (String)
  • uptime_check_config (String)

Returns:

  • (String) 


107
108
109
110
111
112
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 107

def self.uptime_check_config_path project, uptime_check_config
  UPTIME_CHECK_CONFIG_PATH_TEMPLATE.render(
    :"project" => project,
    :"uptime_check_config" => uptime_check_config
  )
end

Instance Method Details

#create_uptime_check_config(parent, uptime_check_config, options: nil) {|result, operation| ... } ⇒ Google::Monitoring::V3::UptimeCheckConfig

Creates a new uptime check configuration.

Examples:

require "google/cloud/monitoring"

uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
formatted_parent = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.project_path("[PROJECT]")

# TODO: Initialize +uptime_check_config+:
uptime_check_config = {}
response = uptime_check_service_client.create_uptime_check_config(formatted_parent, uptime_check_config)

Parameters:

  • parent (String) —

    The project in which to create the uptime check. The format is +projects/[PROJECT_ID]+.

  • uptime_check_config (Google::Monitoring::V3::UptimeCheckConfig | Hash) —

    The new uptime check configuration. A hash of the same form as Google::Monitoring::V3::UptimeCheckConfig can also be provided.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 365

def create_uptime_check_config \
    parent,
    uptime_check_config,
    options: nil,
    &block
  req = {
    parent: parent,
    uptime_check_config: uptime_check_config
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::CreateUptimeCheckConfigRequest)
  @create_uptime_check_config.call(req, options, &block)
end

#delete_uptime_check_config(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Examples:

require "google/cloud/monitoring"

uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.uptime_check_config_path("[PROJECT]", "[UPTIME_CHECK_CONFIG]")
uptime_check_service_client.delete_uptime_check_config(formatted_name)

Parameters:

  • name (String) —

    The uptime check configuration to delete. The format is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 455

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

#get_uptime_check_config(name, options: nil) {|result, operation| ... } ⇒ Google::Monitoring::V3::UptimeCheckConfig

Gets a single uptime check configuration.

Examples:

require "google/cloud/monitoring"

uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.uptime_check_config_path("[PROJECT]", "[UPTIME_CHECK_CONFIG]")
response = uptime_check_service_client.get_uptime_check_config(formatted_name)

Parameters:

  • name (String) —

    The uptime check configuration to retrieve. The format is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 327

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

#list_uptime_check_configs(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Monitoring::V3::UptimeCheckConfig>

Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.

Examples:

require "google/cloud/monitoring"

uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
formatted_parent = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.project_path("[PROJECT]")

# Iterate over all results.
uptime_check_service_client.list_uptime_check_configs(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
uptime_check_service_client.list_uptime_check_configs(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    The project whose uptime check configurations are listed. The format is +projects/[PROJECT_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.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

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

    An enumerable of Google::Monitoring::V3::UptimeCheckConfig 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.



294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 294

def list_uptime_check_configs \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListUptimeCheckConfigsRequest)
  @list_uptime_check_configs.call(req, options, &block)
end

#list_uptime_check_ips(page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Monitoring::V3::UptimeCheckIp>

Returns the list of IPs that checkers run from

Examples:

require "google/cloud/monitoring"

uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)

# Iterate over all results.
uptime_check_service_client.list_uptime_check_ips.each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
uptime_check_service_client.list_uptime_check_ips.each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • 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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

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

    An enumerable of Google::Monitoring::V3::UptimeCheckIp 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.



505
506
507
508
509
510
511
512
513
514
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 505

def list_uptime_check_ips \
    page_size: nil,
    options: nil,
    &block
  req = {
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListUptimeCheckIpsRequest)
  @list_uptime_check_ips.call(req, options, &block)
end

#update_uptime_check_config(uptime_check_config, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Monitoring::V3::UptimeCheckConfig

Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via +"updateMask"+. Returns the updated configuration.

Examples:

require "google/cloud/monitoring"

uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)

# TODO: Initialize +uptime_check_config+:
uptime_check_config = {}
response = uptime_check_service_client.update_uptime_check_config(uptime_check_config)

Parameters:

  • uptime_check_config (Google::Monitoring::V3::UptimeCheckConfig | Hash) —

    Required. If an +"updateMask"+ has been specified, this field gives the values for the set of fields mentioned in the +"updateMask"+. If an +"updateMask"+ has not been given, this uptime check configuration replaces the current configuration. If a field is mentioned in +"updateMask"+ but the corresonding field is omitted in this partial uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server.

    The following fields can be updated: +display_name+, +http_check+, +tcp_check+, +timeout+, +content_matchers+, and +selected_regions+. A hash of the same form as Google::Monitoring::V3::UptimeCheckConfig can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service_client.rb', line 421

def update_uptime_check_config \
    uptime_check_config,
    update_mask: nil,
    options: nil,
    &block
  req = {
    uptime_check_config: uptime_check_config,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::UpdateUptimeCheckConfigRequest)
  @update_uptime_check_config.call(req, options, &block)
end