google-cloud-monitoring 0.38.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (101) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -54
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +361 -0
  6. data/README.md +34 -50
  7. data/lib/google-cloud-monitoring.rb +6 -5
  8. data/lib/google/cloud/monitoring.rb +255 -443
  9. data/lib/google/cloud/monitoring/dashboard.rb +88 -117
  10. data/lib/google/cloud/monitoring/{v3/doc/google/protobuf/wrappers.rb → dashboard/version.rb} +12 -9
  11. data/lib/google/cloud/monitoring/version.rb +6 -2
  12. metadata +71 -128
  13. data/LICENSE +0 -201
  14. data/lib/google/cloud/monitoring/dashboard/v1.rb +0 -148
  15. data/lib/google/cloud/monitoring/dashboard/v1/credentials.rb +0 -46
  16. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service_client.rb +0 -457
  17. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service_client_config.json +0 -51
  18. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/common.rb +0 -394
  19. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/dashboard.rb +0 -53
  20. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/dashboards_service.rb +0 -82
  21. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/layouts.rb +0 -71
  22. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/metrics.rb +0 -151
  23. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/scorecard.rb +0 -102
  24. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/text.rb +0 -43
  25. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/widget.rb +0 -41
  26. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/xychart.rb +0 -141
  27. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/protobuf/duration.rb +0 -91
  28. data/lib/google/cloud/monitoring/dashboard/v1/doc/google/protobuf/empty.rb +0 -29
  29. data/lib/google/cloud/monitoring/v3.rb +0 -532
  30. data/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb +0 -553
  31. data/lib/google/cloud/monitoring/v3/alert_policy_service_client_config.json +0 -51
  32. data/lib/google/cloud/monitoring/v3/credentials.rb +0 -44
  33. data/lib/google/cloud/monitoring/v3/doc/google/api/distribution.rb +0 -200
  34. data/lib/google/cloud/monitoring/v3/doc/google/api/label.rb +0 -42
  35. data/lib/google/cloud/monitoring/v3/doc/google/api/metric.rb +0 -245
  36. data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb +0 -108
  37. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb +0 -344
  38. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb +0 -138
  39. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/common.rb +0 -449
  40. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group.rb +0 -75
  41. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb +0 -167
  42. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb +0 -85
  43. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb +0 -230
  44. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/mutation_record.rb +0 -29
  45. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb +0 -156
  46. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb +0 -221
  47. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/service.rb +0 -361
  48. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/service_service.rb +0 -197
  49. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb +0 -364
  50. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb +0 -136
  51. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb +0 -131
  52. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/duration.rb +0 -91
  53. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb +0 -29
  54. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/field_mask.rb +0 -222
  55. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb +0 -74
  56. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb +0 -113
  57. data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb +0 -39
  58. data/lib/google/cloud/monitoring/v3/group_service_client.rb +0 -606
  59. data/lib/google/cloud/monitoring/v3/group_service_client_config.json +0 -56
  60. data/lib/google/cloud/monitoring/v3/metric_service_client.rb +0 -750
  61. data/lib/google/cloud/monitoring/v3/metric_service_client_config.json +0 -66
  62. data/lib/google/cloud/monitoring/v3/notification_channel_service_client.rb +0 -811
  63. data/lib/google/cloud/monitoring/v3/notification_channel_service_client_config.json +0 -76
  64. data/lib/google/cloud/monitoring/v3/service_monitoring_service_client.rb +0 -788
  65. data/lib/google/cloud/monitoring/v3/service_monitoring_service_client_config.json +0 -76
  66. data/lib/google/cloud/monitoring/v3/uptime_check_service_client.rb +0 -550
  67. data/lib/google/cloud/monitoring/v3/uptime_check_service_client_config.json +0 -56
  68. data/lib/google/monitoring/dashboard/v1/common_pb.rb +0 -95
  69. data/lib/google/monitoring/dashboard/v1/dashboard_pb.rb +0 -29
  70. data/lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb +0 -51
  71. data/lib/google/monitoring/dashboard/v1/dashboards_service_services_pb.rb +0 -76
  72. data/lib/google/monitoring/dashboard/v1/drilldowns_pb.rb +0 -17
  73. data/lib/google/monitoring/dashboard/v1/layouts_pb.rb +0 -41
  74. data/lib/google/monitoring/dashboard/v1/metrics_pb.rb +0 -76
  75. data/lib/google/monitoring/dashboard/v1/scorecard_pb.rb +0 -38
  76. data/lib/google/monitoring/dashboard/v1/service_pb.rb +0 -17
  77. data/lib/google/monitoring/dashboard/v1/text_pb.rb +0 -28
  78. data/lib/google/monitoring/dashboard/v1/widget_pb.rb +0 -32
  79. data/lib/google/monitoring/dashboard/v1/xychart_pb.rb +0 -66
  80. data/lib/google/monitoring/v3/alert_pb.rb +0 -87
  81. data/lib/google/monitoring/v3/alert_service_pb.rb +0 -53
  82. data/lib/google/monitoring/v3/alert_service_services_pb.rb +0 -63
  83. data/lib/google/monitoring/v3/common_pb.rb +0 -95
  84. data/lib/google/monitoring/v3/dropped_labels_pb.rb +0 -19
  85. data/lib/google/monitoring/v3/group_pb.rb +0 -24
  86. data/lib/google/monitoring/v3/group_service_pb.rb +0 -73
  87. data/lib/google/monitoring/v3/group_service_services_pb.rb +0 -66
  88. data/lib/google/monitoring/v3/metric_pb.rb +0 -82
  89. data/lib/google/monitoring/v3/metric_service_pb.rb +0 -130
  90. data/lib/google/monitoring/v3/metric_service_services_pb.rb +0 -66
  91. data/lib/google/monitoring/v3/mutation_record_pb.rb +0 -21
  92. data/lib/google/monitoring/v3/notification_pb.rb +0 -47
  93. data/lib/google/monitoring/v3/notification_service_pb.rb +0 -90
  94. data/lib/google/monitoring/v3/notification_service_services_pb.rb +0 -94
  95. data/lib/google/monitoring/v3/service_pb.rb +0 -149
  96. data/lib/google/monitoring/v3/service_service_pb.rb +0 -86
  97. data/lib/google/monitoring/v3/service_service_services_pb.rb +0 -65
  98. data/lib/google/monitoring/v3/span_context_pb.rb +0 -19
  99. data/lib/google/monitoring/v3/uptime_pb.rb +0 -123
  100. data/lib/google/monitoring/v3/uptime_service_pb.rb +0 -63
  101. data/lib/google/monitoring/v3/uptime_service_services_pb.rb +0 -67
@@ -1,197 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Monitoring
18
- module V3
19
- # The `CreateService` request.
20
- # @!attribute [rw] parent
21
- # @return [String]
22
- # Required. Resource name of the parent workspace. The format is:
23
- #
24
- # projects/[PROJECT_ID_OR_NUMBER]
25
- # @!attribute [rw] service_id
26
- # @return [String]
27
- # Optional. The Service id to use for this Service. If omitted, an id will be
28
- # generated instead. Must match the pattern `[a-z0-9\-]+`
29
- # @!attribute [rw] service
30
- # @return [Google::Monitoring::V3::Service]
31
- # Required. The `Service` to create.
32
- class CreateServiceRequest; end
33
-
34
- # The `GetService` request.
35
- # @!attribute [rw] name
36
- # @return [String]
37
- # Required. Resource name of the `Service`. The format is:
38
- #
39
- # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
40
- class GetServiceRequest; end
41
-
42
- # The `ListServices` request.
43
- # @!attribute [rw] parent
44
- # @return [String]
45
- # Required. Resource name of the parent containing the listed services, either a
46
- # project or a Monitoring Workspace. The formats are:
47
- #
48
- # projects/[PROJECT_ID_OR_NUMBER]
49
- # workspaces/[HOST_PROJECT_ID_OR_NUMBER]
50
- # @!attribute [rw] filter
51
- # @return [String]
52
- # A filter specifying what `Service`s to return. The filter currently
53
- # supports the following fields:
54
- #
55
- # * `identifier_case`
56
- # * `app_engine.module_id`
57
- # * `cloud_endpoints.service`
58
- # * `cluster_istio.location`
59
- # * `cluster_istio.cluster_name`
60
- # * `cluster_istio.service_namespace`
61
- # * `cluster_istio.service_name`
62
- #
63
- # `identifier_case` refers to which option in the identifier oneof is
64
- # populated. For example, the filter `identifier_case = "CUSTOM"` would match
65
- # all services with a value for the `custom` field. Valid options are
66
- # "CUSTOM", "APP_ENGINE", "CLOUD_ENDPOINTS", and "CLUSTER_ISTIO".
67
- # @!attribute [rw] page_size
68
- # @return [Integer]
69
- # A non-negative number that is the maximum number of results to return.
70
- # When 0, use default page size.
71
- # @!attribute [rw] page_token
72
- # @return [String]
73
- # If this field is not empty then it must contain the `nextPageToken` value
74
- # returned by a previous call to this method. Using this field causes the
75
- # method to return additional results from the previous method call.
76
- class ListServicesRequest; end
77
-
78
- # The `ListServices` response.
79
- # @!attribute [rw] services
80
- # @return [Array<Google::Monitoring::V3::Service>]
81
- # The `Service`s matching the specified filter.
82
- # @!attribute [rw] next_page_token
83
- # @return [String]
84
- # If there are more results than have been returned, then this field is set
85
- # to a non-empty value. To see the additional results,
86
- # use that value as `page_token` in the next call to this method.
87
- class ListServicesResponse; end
88
-
89
- # The `UpdateService` request.
90
- # @!attribute [rw] service
91
- # @return [Google::Monitoring::V3::Service]
92
- # Required. The `Service` to draw updates from.
93
- # The given `name` specifies the resource to update.
94
- # @!attribute [rw] update_mask
95
- # @return [Google::Protobuf::FieldMask]
96
- # A set of field paths defining which fields to use for the update.
97
- class UpdateServiceRequest; end
98
-
99
- # The `DeleteService` request.
100
- # @!attribute [rw] name
101
- # @return [String]
102
- # Required. Resource name of the `Service` to delete. The format is:
103
- #
104
- # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
105
- class DeleteServiceRequest; end
106
-
107
- # The `CreateServiceLevelObjective` request.
108
- # @!attribute [rw] parent
109
- # @return [String]
110
- # Required. Resource name of the parent `Service`. The format is:
111
- #
112
- # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
113
- # @!attribute [rw] service_level_objective_id
114
- # @return [String]
115
- # Optional. The ServiceLevelObjective id to use for this
116
- # ServiceLevelObjective. If omitted, an id will be generated instead. Must
117
- # match the pattern `[a-z0-9\-]+`
118
- # @!attribute [rw] service_level_objective
119
- # @return [Google::Monitoring::V3::ServiceLevelObjective]
120
- # Required. The `ServiceLevelObjective` to create.
121
- # The provided `name` will be respected if no `ServiceLevelObjective` exists
122
- # with this name.
123
- class CreateServiceLevelObjectiveRequest; end
124
-
125
- # The `GetServiceLevelObjective` request.
126
- # @!attribute [rw] name
127
- # @return [String]
128
- # Required. Resource name of the `ServiceLevelObjective` to get. The format is:
129
- #
130
- # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
131
- # @!attribute [rw] view
132
- # @return [Google::Monitoring::V3::ServiceLevelObjective::View]
133
- # View of the `ServiceLevelObjective` to return. If `DEFAULT`, return the
134
- # `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the
135
- # `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the
136
- # `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.
137
- class GetServiceLevelObjectiveRequest; end
138
-
139
- # The `ListServiceLevelObjectives` request.
140
- # @!attribute [rw] parent
141
- # @return [String]
142
- # Required. Resource name of the parent containing the listed SLOs, either a
143
- # project or a Monitoring Workspace. The formats are:
144
- #
145
- # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
146
- # workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
147
- # @!attribute [rw] filter
148
- # @return [String]
149
- # A filter specifying what `ServiceLevelObjective`s to return.
150
- # @!attribute [rw] page_size
151
- # @return [Integer]
152
- # A non-negative number that is the maximum number of results to return.
153
- # When 0, use default page size.
154
- # @!attribute [rw] page_token
155
- # @return [String]
156
- # If this field is not empty then it must contain the `nextPageToken` value
157
- # returned by a previous call to this method. Using this field causes the
158
- # method to return additional results from the previous method call.
159
- # @!attribute [rw] view
160
- # @return [Google::Monitoring::V3::ServiceLevelObjective::View]
161
- # View of the `ServiceLevelObjective`s to return. If `DEFAULT`, return each
162
- # `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the
163
- # `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the
164
- # `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.
165
- class ListServiceLevelObjectivesRequest; end
166
-
167
- # The `ListServiceLevelObjectives` response.
168
- # @!attribute [rw] service_level_objectives
169
- # @return [Array<Google::Monitoring::V3::ServiceLevelObjective>]
170
- # The `ServiceLevelObjective`s matching the specified filter.
171
- # @!attribute [rw] next_page_token
172
- # @return [String]
173
- # If there are more results than have been returned, then this field is set
174
- # to a non-empty value. To see the additional results,
175
- # use that value as `page_token` in the next call to this method.
176
- class ListServiceLevelObjectivesResponse; end
177
-
178
- # The `UpdateServiceLevelObjective` request.
179
- # @!attribute [rw] service_level_objective
180
- # @return [Google::Monitoring::V3::ServiceLevelObjective]
181
- # Required. The `ServiceLevelObjective` to draw updates from.
182
- # The given `name` specifies the resource to update.
183
- # @!attribute [rw] update_mask
184
- # @return [Google::Protobuf::FieldMask]
185
- # A set of field paths defining which fields to use for the update.
186
- class UpdateServiceLevelObjectiveRequest; end
187
-
188
- # The `DeleteServiceLevelObjective` request.
189
- # @!attribute [rw] name
190
- # @return [String]
191
- # Required. Resource name of the `ServiceLevelObjective` to delete. The format is:
192
- #
193
- # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
194
- class DeleteServiceLevelObjectiveRequest; end
195
- end
196
- end
197
- end
@@ -1,364 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Monitoring
18
- module V3
19
- # An internal checker allows Uptime checks to run on private/internal GCP
20
- # resources.
21
- # @!attribute [rw] name
22
- # @return [String]
23
- # A unique resource name for this InternalChecker. The format is:
24
- #
25
- # projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID]
26
- #
27
- # `[PROJECT_ID_OR_NUMBER]` is the Stackdriver Workspace project for the
28
- # Uptime check config associated with the internal checker.
29
- # @!attribute [rw] display_name
30
- # @return [String]
31
- # The checker's human-readable name. The display name
32
- # should be unique within a Stackdriver Workspace in order to make it easier
33
- # to identify; however, uniqueness is not enforced.
34
- # @!attribute [rw] network
35
- # @return [String]
36
- # The [GCP VPC network](https://cloud.google.com/vpc/docs/vpc) where the
37
- # internal resource lives (ex: "default").
38
- # @!attribute [rw] gcp_zone
39
- # @return [String]
40
- # The GCP zone the Uptime check should egress from. Only respected for
41
- # internal Uptime checks, where internal_network is specified.
42
- # @!attribute [rw] peer_project_id
43
- # @return [String]
44
- # The GCP project ID where the internal checker lives. Not necessary
45
- # the same as the Workspace project.
46
- # @!attribute [rw] state
47
- # @return [Google::Monitoring::V3::InternalChecker::State]
48
- # The current operational state of the internal checker.
49
- class InternalChecker
50
- # Operational states for an internal checker.
51
- module State
52
- # An internal checker should never be in the unspecified state.
53
- UNSPECIFIED = 0
54
-
55
- # The checker is being created, provisioned, and configured. A checker in
56
- # this state can be returned by `ListInternalCheckers` or
57
- # `GetInternalChecker`, as well as by examining the [long running
58
- # Operation](https://cloud.google.com/apis/design/design_patterns#long_running_operations)
59
- # that created it.
60
- CREATING = 1
61
-
62
- # The checker is running and available for use. A checker in this state
63
- # can be returned by `ListInternalCheckers` or `GetInternalChecker` as
64
- # well as by examining the [long running
65
- # Operation](https://cloud.google.com/apis/design/design_patterns#long_running_operations)
66
- # that created it.
67
- # If a checker is being torn down, it is neither visible nor usable, so
68
- # there is no "deleting" or "down" state.
69
- RUNNING = 2
70
- end
71
- end
72
-
73
- # This message configures which resources and services to monitor for
74
- # availability.
75
- # @!attribute [rw] name
76
- # @return [String]
77
- # A unique resource name for this Uptime check configuration. The format is:
78
- #
79
- # projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
80
- #
81
- # This field should be omitted when creating the Uptime check configuration;
82
- # on create, the resource name is assigned by the server and included in the
83
- # response.
84
- # @!attribute [rw] display_name
85
- # @return [String]
86
- # A human-friendly name for the Uptime check configuration. The display name
87
- # should be unique within a Stackdriver Workspace in order to make it easier
88
- # to identify; however, uniqueness is not enforced. Required.
89
- # @!attribute [rw] monitored_resource
90
- # @return [Google::Api::MonitoredResource]
91
- # The [monitored
92
- # resource](https://cloud.google.com/monitoring/api/resources) associated
93
- # with the configuration.
94
- # The following monitored resource types are supported for Uptime checks:
95
- # `uptime_url`,
96
- # `gce_instance`,
97
- # `gae_app`,
98
- # `aws_ec2_instance`,
99
- # `aws_elb_load_balancer`
100
- # @!attribute [rw] resource_group
101
- # @return [Google::Monitoring::V3::UptimeCheckConfig::ResourceGroup]
102
- # The group resource associated with the configuration.
103
- # @!attribute [rw] http_check
104
- # @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck]
105
- # Contains information needed to make an HTTP or HTTPS check.
106
- # @!attribute [rw] tcp_check
107
- # @return [Google::Monitoring::V3::UptimeCheckConfig::TcpCheck]
108
- # Contains information needed to make a TCP check.
109
- # @!attribute [rw] period
110
- # @return [Google::Protobuf::Duration]
111
- # How often, in seconds, the Uptime check is performed.
112
- # Currently, the only supported values are `60s` (1 minute), `300s`
113
- # (5 minutes), `600s` (10 minutes), and `900s` (15 minutes). Optional,
114
- # defaults to `60s`.
115
- # @!attribute [rw] timeout
116
- # @return [Google::Protobuf::Duration]
117
- # The maximum amount of time to wait for the request to complete (must be
118
- # between 1 and 60 seconds). Required.
119
- # @!attribute [rw] content_matchers
120
- # @return [Array<Google::Monitoring::V3::UptimeCheckConfig::ContentMatcher>]
121
- # The content that is expected to appear in the data returned by the target
122
- # server against which the check is run. Currently, only the first entry
123
- # in the `content_matchers` list is supported, and additional entries will
124
- # be ignored. This field is optional and should only be specified if a
125
- # content match is required as part of the/ Uptime check.
126
- # @!attribute [rw] selected_regions
127
- # @return [Array<Google::Monitoring::V3::UptimeCheckRegion>]
128
- # The list of regions from which the check will be run.
129
- # Some regions contain one location, and others contain more than one.
130
- # If this field is specified, enough regions must be provided to include a
131
- # minimum of 3 locations. Not specifying this field will result in Uptime
132
- # checks running from all available regions.
133
- # @!attribute [rw] is_internal
134
- # @return [true, false]
135
- # If this is `true`, then checks are made only from the 'internal_checkers'.
136
- # If it is `false`, then checks are made only from the 'selected_regions'.
137
- # It is an error to provide 'selected_regions' when is_internal is `true`,
138
- # or to provide 'internal_checkers' when is_internal is `false`.
139
- # @!attribute [rw] internal_checkers
140
- # @return [Array<Google::Monitoring::V3::InternalChecker>]
141
- # The internal checkers that this check will egress from. If `is_internal` is
142
- # `true` and this list is empty, the check will egress from all the
143
- # InternalCheckers configured for the project that owns this
144
- # `UptimeCheckConfig`.
145
- class UptimeCheckConfig
146
- # The resource submessage for group checks. It can be used instead of a
147
- # monitored resource, when multiple resources are being monitored.
148
- # @!attribute [rw] group_id
149
- # @return [String]
150
- # The group of resources being monitored. Should be only the `[GROUP_ID]`,
151
- # and not the full-path
152
- # `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
153
- # @!attribute [rw] resource_type
154
- # @return [Google::Monitoring::V3::GroupResourceType]
155
- # The resource type of the group members.
156
- class ResourceGroup; end
157
-
158
- # Information involved in an HTTP/HTTPS Uptime check request.
159
- # @!attribute [rw] request_method
160
- # @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
161
- # The HTTP request method to use for the check.
162
- # @!attribute [rw] use_ssl
163
- # @return [true, false]
164
- # If `true`, use HTTPS instead of HTTP to run the check.
165
- # @!attribute [rw] path
166
- # @return [String]
167
- # Optional (defaults to "/"). The path to the page against which to run
168
- # the check. Will be combined with the `host` (specified within the
169
- # `monitored_resource`) and `port` to construct the full URL. If the
170
- # provided path does not begin with "/", a "/" will be prepended
171
- # automatically.
172
- # @!attribute [rw] port
173
- # @return [Integer]
174
- # Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
175
- # `use_ssl` is `true`). The TCP port on the HTTP server against which to
176
- # run the check. Will be combined with host (specified within the
177
- # `monitored_resource`) and `path` to construct the full URL.
178
- # @!attribute [rw] auth_info
179
- # @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
180
- # The authentication information. Optional when creating an HTTP check;
181
- # defaults to empty.
182
- # @!attribute [rw] mask_headers
183
- # @return [true, false]
184
- # Boolean specifiying whether to encrypt the header information.
185
- # Encryption should be specified for any headers related to authentication
186
- # that you do not wish to be seen when retrieving the configuration. The
187
- # server will be responsible for encrypting the headers.
188
- # On Get/List calls, if `mask_headers` is set to `true` then the headers
189
- # will be obscured with `******.`
190
- # @!attribute [rw] headers
191
- # @return [Hash{String => String}]
192
- # The list of headers to send as part of the Uptime check request.
193
- # If two headers have the same key and different values, they should
194
- # be entered as a single header, with the value being a comma-separated
195
- # list of all the desired values as described at
196
- # https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
197
- # Entering two separate headers with the same key in a Create call will
198
- # cause the first to be overwritten by the second.
199
- # The maximum number of headers allowed is 100.
200
- # @!attribute [rw] content_type
201
- # @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
202
- # The content type to use for the check.
203
- # @!attribute [rw] validate_ssl
204
- # @return [true, false]
205
- # Boolean specifying whether to include SSL certificate validation as a
206
- # part of the Uptime check. Only applies to checks where
207
- # `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
208
- # setting `validate_ssl` to `true` has no effect.
209
- # @!attribute [rw] body
210
- # @return [String]
211
- # The request body associated with the HTTP request. If `content_type` is
212
- # `URL_ENCODED`, the body passed in must be URL-encoded. Users can provide
213
- # a `Content-Length` header via the `headers` field or the API will do
214
- # so. The maximum byte size is 1 megabyte. Note: As with all `bytes` fields
215
- # JSON representations are base64 encoded.
216
- class HttpCheck
217
- # The authentication parameters to provide to the specified resource or
218
- # URL that requires a username and password. Currently, only
219
- # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
220
- # supported in Uptime checks.
221
- # @!attribute [rw] username
222
- # @return [String]
223
- # The username to use when authenticating with the HTTP server.
224
- # @!attribute [rw] password
225
- # @return [String]
226
- # The password to use when authenticating with the HTTP server.
227
- class BasicAuthentication; end
228
-
229
- # Header options corresponding to the Content-Type of the body in HTTP
230
- # requests. Note that a `Content-Type` header cannot be present in the
231
- # `headers` field if this field is specified.
232
- module ContentType
233
- # No content type specified. If the request method is POST, an
234
- # unspecified content type results in a check creation rejection.
235
- TYPE_UNSPECIFIED = 0
236
-
237
- # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
238
- # to `application/x-www-form-urlencoded` in the HTTP request.
239
- URL_ENCODED = 1
240
- end
241
-
242
- # The HTTP request method options.
243
- module RequestMethod
244
- # No request method specified.
245
- METHOD_UNSPECIFIED = 0
246
-
247
- # GET request.
248
- GET = 1
249
-
250
- # POST request.
251
- POST = 2
252
- end
253
- end
254
-
255
- # Information required for a TCP Uptime check request.
256
- # @!attribute [rw] port
257
- # @return [Integer]
258
- # The TCP port on the server against which to run the check. Will be
259
- # combined with host (specified within the `monitored_resource`) to
260
- # construct the full URL. Required.
261
- class TcpCheck; end
262
-
263
- # Optional. Used to perform content matching. This allows matching based on
264
- # substrings and regular expressions, together with their negations. Only the
265
- # first 4&nbsp;MB of an HTTP or HTTPS check's response (and the first
266
- # 1&nbsp;MB of a TCP check's response) are examined for purposes of content
267
- # matching.
268
- # @!attribute [rw] content
269
- # @return [String]
270
- # String or regex content to match. Maximum 1024 bytes. An empty `content`
271
- # string indicates no content matching is to be performed.
272
- # @!attribute [rw] matcher
273
- # @return [Google::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
274
- # The type of content matcher that will be applied to the server output,
275
- # compared to the `content` string when the check is run.
276
- class ContentMatcher
277
- # Options to perform content matching.
278
- module ContentMatcherOption
279
- # No content matcher type specified (maintained for backward
280
- # compatibility, but deprecated for future use).
281
- # Treated as `CONTAINS_STRING`.
282
- CONTENT_MATCHER_OPTION_UNSPECIFIED = 0
283
-
284
- # Selects substring matching. The match succeeds if the output contains
285
- # the `content` string. This is the default value for checks without
286
- # a `matcher` option, or where the value of `matcher` is
287
- # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
288
- CONTAINS_STRING = 1
289
-
290
- # Selects negation of substring matching. The match succeeds if the
291
- # output does _NOT_ contain the `content` string.
292
- NOT_CONTAINS_STRING = 2
293
-
294
- # Selects regular-expression matching. The match succeeds of the output
295
- # matches the regular expression specified in the `content` string.
296
- MATCHES_REGEX = 3
297
-
298
- # Selects negation of regular-expression matching. The match succeeds if
299
- # the output does _NOT_ match the regular expression specified in the
300
- # `content` string.
301
- NOT_MATCHES_REGEX = 4
302
- end
303
- end
304
- end
305
-
306
- # Contains the region, location, and list of IP
307
- # addresses where checkers in the location run from.
308
- # @!attribute [rw] region
309
- # @return [Google::Monitoring::V3::UptimeCheckRegion]
310
- # A broad region category in which the IP address is located.
311
- # @!attribute [rw] location
312
- # @return [String]
313
- # A more specific location within the region that typically encodes
314
- # a particular city/town/metro (and its containing state/province or country)
315
- # within the broader umbrella region category.
316
- # @!attribute [rw] ip_address
317
- # @return [String]
318
- # The IP address from which the Uptime check originates. This is a fully
319
- # specified IP address (not an IP address range). Most IP addresses, as of
320
- # this publication, are in IPv4 format; however, one should not rely on the
321
- # IP addresses being in IPv4 format indefinitely, and should support
322
- # interpreting this field in either IPv4 or IPv6 format.
323
- class UptimeCheckIp; end
324
-
325
- # The supported resource types that can be used as values of
326
- # `group_resource.resource_type`.
327
- # `INSTANCE` includes `gce_instance` and `aws_ec2_instance` resource types.
328
- # The resource types `gae_app` and `uptime_url` are not valid here because
329
- # group checks on App Engine modules and URLs are not allowed.
330
- module GroupResourceType
331
- # Default value (not valid).
332
- RESOURCE_TYPE_UNSPECIFIED = 0
333
-
334
- # A group of instances from Google Cloud Platform (GCP) or
335
- # Amazon Web Services (AWS).
336
- INSTANCE = 1
337
-
338
- # A group of Amazon ELB load balancers.
339
- AWS_ELB_LOAD_BALANCER = 2
340
- end
341
-
342
- # The regions from which an Uptime check can be run.
343
- module UptimeCheckRegion
344
- # Default value if no region is specified. Will result in Uptime checks
345
- # running from all regions.
346
- REGION_UNSPECIFIED = 0
347
-
348
- # Allows checks to run from locations within the United States of America.
349
- USA = 1
350
-
351
- # Allows checks to run from locations within the continent of Europe.
352
- EUROPE = 2
353
-
354
- # Allows checks to run from locations within the continent of South
355
- # America.
356
- SOUTH_AMERICA = 3
357
-
358
- # Allows checks to run from locations within the Asia Pacific area (ex:
359
- # Singapore).
360
- ASIA_PACIFIC = 4
361
- end
362
- end
363
- end
364
- end