Class: Google::Cloud::Monitoring::V3::UptimeCheckConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/uptime.rb

Overview

This message configures which resources and services to monitor for availability.

Defined Under Namespace

Classes: ContentMatcher, HttpCheck, ResourceGroup, TcpCheck

Instance Attribute Summary collapse

Instance Attribute Details

#content_matchers ⇒ ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher>

Returns The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

Returns:

  • (::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher>) —

    The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#display_name ⇒ ::String

Returns A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

Returns:

  • (::String) —

    A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#http_check ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck

Returns Contains information needed to make an HTTP or HTTPS check.

Returns:


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#internal_checkers ⇒ ::Array<::Google::Cloud::Monitoring::V3::InternalChecker>

Returns The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

Returns:

  • (::Array<::Google::Cloud::Monitoring::V3::InternalChecker>) —

    The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#is_internal ⇒ ::Boolean

Returns If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

Returns:

  • (::Boolean) —

    If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#monitored_resource ⇒ ::Google::Api::MonitoredResource

Returns The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service.

Returns:

  • (::Google::Api::MonitoredResource) —

    The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#name ⇒ ::String

Returns A unique resource name for this Uptime check configuration. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

[PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

Returns:

  • (::String) —

    A unique resource name for this Uptime check configuration. The format is:

     projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

    [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

    This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#period ⇒ ::Google::Protobuf::Duration

Returns How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

Returns:

  • (::Google::Protobuf::Duration) —

    How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#resource_group ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup

Returns The group resource associated with the configuration.

Returns:


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#selected_regions ⇒ ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>

Returns The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

Returns:

  • (::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>) —

    The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#tcp_check ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck

Returns Contains information needed to make a TCP check.

Returns:


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end

#timeout ⇒ ::Google::Protobuf::Duration

Returns The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

Returns:

  • (::Google::Protobuf::Duration) —

    The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.


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
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 157

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional (defaults to "/"). The path to the page against which to run
  #     the check. Will be combined with the `host` (specified within the
  #     `monitored_resource`) and `port` to construct the full URL. If the
  #     provided path does not begin with "/", a "/" will be prepended
  #     automatically.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
  #     `use_ssl` is `true`). The TCP port on the HTTP server against which to
  #     run the check. Will be combined with host (specified within the
  #     `monitored_resource`) and `path` to construct the full URL.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::Boolean]
  #     Boolean specifying whether to encrypt the header information.
  #     Encryption should be specified for any headers related to authentication
  #     that you do not wish to be seen when retrieving the configuration. The
  #     server will be responsible for encrypting the headers.
  #     On Get/List calls, if `mask_headers` is set to `true` then the headers
  #     will be obscured with `******.`
  # @!attribute [rw] headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The list of headers to send as part of the Uptime check request.
  #     If two headers have the same key and different values, they should
  #     be entered as a single header, with the value being a comma-separated
  #     list of all the desired values as described at
  #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
  #     Entering two separate headers with the same key in a Create call will
  #     cause the first to be overwritten by the second.
  #     The maximum number of headers allowed is 100.
  # @!attribute [rw] content_type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
  #     The content type header to use for the check. The following
  #     configurations result in errors:
  #     1. Content type is specified in both the `headers` field and the
  #     `content_type` field.
  #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
  #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
  #     4. Request method is `POST` and a "Content-Type" header is provided via
  #     `headers` field. The `content_type` field should be used instead.
  # @!attribute [rw] validate_ssl
  #   @return [::Boolean]
  #     Boolean specifying whether to include SSL certificate validation as a
  #     part of the Uptime check. Only applies to checks where
  #     `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
  #     setting `validate_ssl` to `true` has no effect.
  # @!attribute [rw] body
  #   @return [::String]
  #     The request body associated with the HTTP POST request. If `content_type`
  #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
  #     provide a `Content-Length` header via the `headers` field or the API will
  #     do so. If the `request_method` is `GET` and `body` is not empty, the API
  #     will return an error. The maximum byte size is 1 megabyte. Note: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
  # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end