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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/doc/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::Monitoring::V3::UptimeCheckConfig::ContentMatcher>

Returns The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.

Returns:

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

    The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

#display_name ⇒ String

Returns A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account 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 Account in order to make it easier to identify; however, uniqueness is not enforced. Required.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

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

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

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

#internal_checkers ⇒ Array<Google::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 InternalCheckers configured for the project that owns this CheckConfig.

Returns:

  • (Array<Google::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 InternalCheckers configured for the project that owns this CheckConfig.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

#is_internal ⇒ true, false

Returns Denotes whether this is a check that egresses from InternalCheckers.

Returns:

  • (true, false) —

    Denotes whether this is a check that egresses from InternalCheckers.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

#monitored_resource ⇒ Google::Api::MonitoredResource

Returns The monitored resource associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

#name ⇒ String

Returns A unique resource name for this UptimeCheckConfig. The format is:

+projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.

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 UptimeCheckConfig. The format is:

    +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.

    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.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; 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 +300s+.

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 +300s+.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

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

Returns The group resource associated with the configuration.

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

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

Returns The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.

Returns:

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

    The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end

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

Returns Contains information needed to make a TCP check.

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; 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.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 107

class UptimeCheckConfig
  # 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, not projects/<project_id>/groups/<group_id>.
  # @!attribute [rw] resource_type
  #   @return [Google::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup; end

  # Information involved in an HTTP/HTTPS uptime check request.
  # @!attribute [rw] use_ssl
  #   @return [true, false]
  #     If true, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [String]
  #     The path to the page to run the check against. Will be combined with the
  #     host (specified within the MonitoredResource) and port to construct the
  #     full URL. Optional (defaults to "/").
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) and path to construct the full
  #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
  # @!attribute [rw] auth_info
  #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [true, false]
  #     Boolean specifiying 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 [Hash{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.
  class HttpCheck
    # A type of authentication to perform against the specified resource or URL
    # that uses username and password.
    # Currently, only Basic authentication is supported in Uptime Monitoring.
    # @!attribute [rw] username
    #   @return [String]
    #     The username to authenticate.
    # @!attribute [rw] password
    #   @return [String]
    #     The password to authenticate.
    class BasicAuthentication; end
  end

  # Information required for a TCP uptime check request.
  # @!attribute [rw] port
  #   @return [Integer]
  #     The port to the page to run the check against. Will be combined with host
  #     (specified within the MonitoredResource) to construct the full URL.
  #     Required.
  class TcpCheck; end

  # Used to perform string matching. Currently, this matches on the exact
  # content. In the future, it can be expanded to allow for regular expressions
  # and more complex matching.
  # @!attribute [rw] content
  #   @return [String]
  #     String content to match (max 1024 bytes)
  class ContentMatcher; end
end