OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-13 21:19:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

update dependencies

Browse Source
This commit is contained in:
Sebastian Thiel
2023-01-25 11:39:00 +01:00
parent 37ccd2238d
commit 3edefb7f01
357 changed files with 128026 additions and 16259 deletions
Download Patch File Download Diff File Expand all files Collapse all files

520
etc/api/monitoring/v3/monitoring-api.json
View File

@@ -665,7 +665,7 @@
"alertPolicies": {
"methods": {
"create": {
"description": "Creates a new alerting policy.",
"description": "Creates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.",
"flatPath": "v3/projects/{projectsId}/alertPolicies",
"httpMethod": "POST",
"id": "monitoring.projects.alertPolicies.create",
@@ -674,7 +674,7 @@
],
"parameters": {
"name": {
"description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.",
"description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
@@ -694,7 +694,7 @@
]
},
"delete": {
"description": "Deletes an alerting policy.",
"description": "Deletes an alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.",
"flatPath": "v3/projects/{projectsId}/alertPolicies/{alertPoliciesId}",
"httpMethod": "DELETE",
"id": "monitoring.projects.alertPolicies.delete",
@@ -795,7 +795,7 @@
]
},
"patch": {
"description": "Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.",
"description": "Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.",
"flatPath": "v3/projects/{projectsId}/alertPolicies/{alertPoliciesId}",
"httpMethod": "PATCH",
"id": "monitoring.projects.alertPolicies.patch",
@@ -804,7 +804,7 @@
],
"parameters": {
"name": {
"description": "Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.",
"description": "Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.",
"location": "path",
"pattern": "^projects/[^/]+/alertPolicies/[^/]+$",
"required": true,
@@ -834,7 +834,7 @@
"collectdTimeSeries": {
"methods": {
"create": {
"description": "Stackdriver Monitoring Agent only: Creates a new time series.This method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.",
"description": "Cloud Monitoring Agent only: Creates a new time series.This method is only for use by the Cloud Monitoring Agent. Use projects.timeSeries.create instead.",
"flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
"httpMethod": "POST",
"id": "monitoring.projects.collectdTimeSeries.create",
@@ -1112,7 +1112,7 @@
"metricDescriptors": {
"methods": {
"create": {
"description": "Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).",
"description": "Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). The metric descriptor is updated if it already exists, except that metric labels are never removed.",
"flatPath": "v3/projects/{projectsId}/metricDescriptors",
"httpMethod": "POST",
"id": "monitoring.projects.metricDescriptors.create",
@@ -1389,7 +1389,7 @@
"notificationChannels": {
"methods": {
"create": {
"description": "Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.",
"description": "Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.",
"flatPath": "v3/projects/{projectsId}/notificationChannels",
"httpMethod": "POST",
"id": "monitoring.projects.notificationChannels.create",
@@ -1418,7 +1418,7 @@
]
},
"delete": {
"description": "Deletes a notification channel.",
"description": "Deletes a notification channel.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.",
"flatPath": "v3/projects/{projectsId}/notificationChannels/{notificationChannelsId}",
"httpMethod": "DELETE",
"id": "monitoring.projects.notificationChannels.delete",
@@ -1553,7 +1553,7 @@
]
},
"patch": {
"description": "Updates a notification channel. Fields not specified in the field mask remain unchanged.",
"description": "Updates a notification channel. Fields not specified in the field mask remain unchanged.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.",
"flatPath": "v3/projects/{projectsId}/notificationChannels/{notificationChannelsId}",
"httpMethod": "PATCH",
"id": "monitoring.projects.notificationChannels.patch",
@@ -1647,6 +1647,144 @@
}
}
},
"snoozes": {
"methods": {
"create": {
"description": "Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.",
"flatPath": "v3/projects/{projectsId}/snoozes",
"httpMethod": "POST",
"id": "monitoring.projects.snoozes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which a Snooze should be created. The format is: projects/[PROJECT_ID_OR_NUMBER] ",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3/{+parent}/snoozes",
"request": {
"$ref": "Snooze"
},
"response": {
"$ref": "Snooze"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
]
},
"get": {
"description": "Retrieves a Snooze by name.",
"flatPath": "v3/projects/{projectsId}/snoozes/{snoozesId}",
"httpMethod": "GET",
"id": "monitoring.projects.snoozes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The ID of the Snooze to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] ",
"location": "path",
"pattern": "^projects/[^/]+/snoozes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3/{+name}",
"response": {
"$ref": "Snooze"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"list": {
"description": "Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.",
"flatPath": "v3/projects/{projectsId}/snoozes",
"httpMethod": "GET",
"id": "monitoring.projects.snoozes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > \"2022-03-11T00:00:00-08:00\" AND interval.end_time < \"2022-03-12T00:00:00-08:00\" ``` ",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range 1, 1000. If the value given is outside this range, the server will decide the number of results to be returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] ",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v3/{+parent}/snoozes",
"response": {
"$ref": "ListSnoozesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"patch": {
"description": "Updates a Snooze, identified by its name, with the parameters in the given Snooze object.",
"flatPath": "v3/projects/{projectsId}/snoozes/{snoozesId}",
"httpMethod": "PATCH",
"id": "monitoring.projects.snoozes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.",
"location": "path",
"pattern": "^projects/[^/]+/snoozes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The fields to update.For each field listed in update_mask: If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze. If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.Fields not listed retain their existing value.The following are the field names that are accepted in update_mask: display_name interval.start_time interval.end_timeThat said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v3/{+name}",
"request": {
"$ref": "Snooze"
},
"response": {
"$ref": "Snooze"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
]
}
}
},
"timeSeries": {
"methods": {
"create": {
@@ -2099,6 +2237,11 @@
"parent"
],
"parameters": {
"filter": {
"description": "If provided, this field specifies the criteria that must be met by uptime checks to be included in the response.For more details, see Filtering syntax (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.",
"format": "int32",
@@ -2179,7 +2322,7 @@
],
"parameters": {
"parent": {
"description": "Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent workspace. The format is: projects/[PROJECT_ID_OR_NUMBER] ",
"description": "Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent Metrics Scope. The format is: projects/[PROJECT_ID_OR_NUMBER] ",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
@@ -2257,7 +2400,7 @@
]
},
"list": {
"description": "List Services for this workspace.",
"description": "List Services for this Metrics Scope.",
"flatPath": "v3/{v3Id}/{v3Id1}/services",
"httpMethod": "GET",
"id": "monitoring.services.list",
@@ -2266,7 +2409,7 @@
],
"parameters": {
"filter": {
"description": "A filter specifying what Services to return. The filter currently supports the following fields: - `identifier_case` - `app_engine.module_id` - `cloud_endpoints.service` (reserved for future use) - `mesh_istio.mesh_uid` - `mesh_istio.service_namespace` - `mesh_istio.service_name` - `cluster_istio.location` (deprecated) - `cluster_istio.cluster_name` (deprecated) - `cluster_istio.service_namespace` (deprecated) - `cluster_istio.service_name` (deprecated) identifier_case refers to which option in the identifier oneof is populated. For example, the filter identifier_case = \"CUSTOM\" would match all services with a value for the custom field. Valid options are \"CUSTOM\", \"APP_ENGINE\", \"MESH_ISTIO\", plus \"CLUSTER_ISTIO\" (deprecated) and \"CLOUD_ENDPOINTS\" (reserved for future use).",
"description": "A filter specifying what Services to return. The filter supports filtering on a particular service-identifier type or one of its attributes.To filter on a particular service-identifier type, the identifier_case refers to which option in the identifier field is populated. For example, the filter identifier_case = \"CUSTOM\" would match all services with a value for the custom field. Valid options include \"CUSTOM\", \"APP_ENGINE\", \"MESH_ISTIO\", and the other options listed at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#ServiceTo filter on an attribute of a service-identifier type, apply the filter name by using the snake case of the service-identifier type and the attribute of that service-identifier type, and join the two with a period. For example, to filter by the meshUid field of the MeshIstio service-identifier type, you must filter on mesh_istio.mesh_uid = \"123\" to match all services with mesh UID \"123\". Service-identifier types and their attributes are described at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service",
"location": "query",
"type": "string"
},
@@ -2282,7 +2425,7 @@
"type": "string"
},
"parent": {
"description": "Required. Resource name of the parent containing the listed services, either a project (https://cloud.google.com/monitoring/api/v3#project_name) or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER] ",
"description": "Required. Resource name of the parent containing the listed services, either a project (https://cloud.google.com/monitoring/api/v3#project_name) or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER] ",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
@@ -2466,7 +2609,7 @@
"type": "string"
},
"parent": {
"description": "Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/- ",
"description": "Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/- ",
"location": "path",
"pattern": "^[^/]+/[^/]+/services/[^/]+$",
"required": true,
@@ -2571,7 +2714,7 @@
}
}
},
"revision": "20220218",
"revision": "20230115",
"rootUrl": "https://monitoring.googleapis.com/",
"schemas": {
"Aggregation": {
@@ -2727,7 +2870,7 @@
"description": "A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored."
},
"name": {
"description": "Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.",
"description": "Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.",
"type": "string"
},
"notificationChannels": {
@@ -2772,7 +2915,7 @@
"id": "AppEngine",
"properties": {
"moduleId": {
"description": "The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource: https://cloud.google.com/monitoring/api/resources#tag_gae_app",
"description": "The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app).",
"type": "string"
}
},
@@ -2799,6 +2942,24 @@
},
"type": "object"
},
"BasicService": {
"description": "A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).",
"id": "BasicService",
"properties": {
"serviceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).",
"type": "object"
},
"serviceType": {
"description": "The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).",
"type": "string"
}
},
"type": "object"
},
"BasicSli": {
"description": "An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the service_resource determines the metrics to use and the service_resource.labels and metric_labels are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.",
"id": "BasicSli",
@@ -2859,7 +3020,22 @@
"id": "CloudEndpoints",
"properties": {
"service": {
"description": "The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource: https://cloud.google.com/monitoring/api/resources#tag_api",
"description": "The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api).",
"type": "string"
}
},
"type": "object"
},
"CloudRun": {
"description": "Cloud Run service. Learn more at https://cloud.google.com/run.",
"id": "CloudRun",
"properties": {
"location": {
"description": "The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).",
"type": "string"
},
"serviceName": {
"description": "The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).",
"type": "string"
}
},
@@ -3032,7 +3208,7 @@
"type": "string"
},
"name": {
"description": "Required if the condition exists. The unique resource name for this condition. Its format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Stackdriver Monitoring creates the condition identifiers and includes them in the new policy.When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.",
"description": "Required if the condition exists. The unique resource name for this condition. Its format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Cloud Monitoring when the condition is created as part of a new or updated alerting policy.When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Cloud Monitoring creates the condition identifiers and includes them in the new policy.When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.",
"type": "string"
}
},
@@ -3046,6 +3222,10 @@
"description": "String, regex or JSON content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.",
"type": "string"
},
"jsonPathMatcher": {
"$ref": "JsonPathMatcher",
"description": "Matcher information for MATCHES_JSON_PATH and NOT_MATCHES_JSON_PATH"
},
"matcher": {
"description": "The type of content matcher that will be applied to the server output, compared to the content string when the check is run.",
"enum": [
@@ -3053,14 +3233,18 @@
"CONTAINS_STRING",
"NOT_CONTAINS_STRING",
"MATCHES_REGEX",
"NOT_MATCHES_REGEX"
"NOT_MATCHES_REGEX",
"MATCHES_JSON_PATH",
"NOT_MATCHES_JSON_PATH"
],
"enumDescriptions": [
"No content matcher type specified (maintained for backward compatibility, but deprecated for future use). Treated as CONTAINS_STRING.",
"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.",
"Selects negation of substring matching. The match succeeds if the output does NOT contain the content string.",
"Selects regular-expression matching. The match succeeds if the output matches the regular expression specified in the content string. Regex matching is only supported for HTTP/HTTPS checks.",
"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."
"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.",
"Selects JSONPath matching. See JsonPathMatcher for details on when the match succeeds. JSONPath matching is only supported for HTTP/HTTPS checks.",
"Selects JSONPath matching. See JsonPathMatcher for details on when the match succeeds. Succeeds when output does NOT match as specified. JSONPath is only supported for HTTP/HTTPS checks."
],
"type": "string"
}
@@ -3145,8 +3329,22 @@
},
"type": "object"
},
"Criteria": {
"description": "Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied.",
"id": "Criteria",
"properties": {
"policies": {
"description": "The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 100 policies per snooze. This limit is checked during snooze creation.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Custom": {
"description": "Custom view of service telemetry. Currently a place-holder pending final design.",
"description": "Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service.",
"id": "Custom",
"properties": {},
"type": "object"
@@ -3216,7 +3414,7 @@
"id": "Documentation",
"properties": {
"content": {
"description": "The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables).",
"description": "The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables).",
"type": "string"
},
"mimeType": {
@@ -3241,7 +3439,7 @@
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.",
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } ",
"id": "Empty",
"properties": {},
"type": "object"
@@ -3433,6 +3631,18 @@
},
"type": "object"
},
"ForecastOptions": {
"description": "Options used when forecasting the time series and testing the predicted value against the threshold.",
"id": "ForecastOptions",
"properties": {
"forecastHorizon": {
"description": "Required. The length of time into the future to forecast whether a time series will violate the threshold. If the predicted value is found to violate the threshold, and the violation is observed in all forecasts made for the configured duration, then the time series is considered to be failing.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GetNotificationChannelVerificationCodeRequest": {
"description": "The GetNotificationChannelVerificationCode request.",
"id": "GetNotificationChannelVerificationCodeRequest",
@@ -3461,6 +3671,90 @@
},
"type": "object"
},
"GkeNamespace": {
"description": "GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod).",
"id": "GkeNamespace",
"properties": {
"clusterName": {
"description": "The name of the parent cluster.",
"type": "string"
},
"location": {
"description": "The location of the parent cluster. This may be a zone or region.",
"type": "string"
},
"namespaceName": {
"description": "The name of this namespace.",
"type": "string"
},
"projectId": {
"description": "Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GkeService": {
"description": "GKE Service. The \"service\" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service).",
"id": "GkeService",
"properties": {
"clusterName": {
"description": "The name of the parent cluster.",
"type": "string"
},
"location": {
"description": "The location of the parent cluster. This may be a zone or region.",
"type": "string"
},
"namespaceName": {
"description": "The name of the parent namespace.",
"type": "string"
},
"projectId": {
"description": "Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself.",
"readOnly": true,
"type": "string"
},
"serviceName": {
"description": "The name of this service.",
"type": "string"
}
},
"type": "object"
},
"GkeWorkload": {
"description": "A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod).",
"id": "GkeWorkload",
"properties": {
"clusterName": {
"description": "The name of the parent cluster.",
"type": "string"
},
"location": {
"description": "The location of the parent cluster. This may be a zone or region.",
"type": "string"
},
"namespaceName": {
"description": "The name of the parent namespace.",
"type": "string"
},
"projectId": {
"description": "Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself.",
"readOnly": true,
"type": "string"
},
"topLevelControllerName": {
"description": "The name of this workload.",
"type": "string"
},
"topLevelControllerType": {
"description": "The type of this workload (for example, \"Deployment\" or \"DaemonSet\")",
"type": "string"
}
},
"type": "object"
},
"GoogleMonitoringV3Range": {
"description": "Range of numerical values within min and max.",
"id": "GoogleMonitoringV3Range",
@@ -3509,6 +3803,13 @@
"description": "Information involved in an HTTP/HTTPS Uptime check request.",
"id": "HttpCheck",
"properties": {
"acceptedResponseStatusCodes": {
"description": "If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299.",
"items": {
"$ref": "ResponseStatusCode"
},
"type": "array"
},
"authInfo": {
"$ref": "BasicAuthentication",
"description": "The authentication information. Optional when creating an HTTP check; defaults to empty."
@@ -3545,6 +3846,10 @@
"description": "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.",
"type": "string"
},
"pingConfig": {
"$ref": "PingConfig",
"description": "Contains information needed to add pings to an HTTP check."
},
"port": {
"description": "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.",
"format": "int32",
@@ -3580,7 +3885,7 @@
"id": "InternalChecker",
"properties": {
"displayName": {
"description": "The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.",
"description": "The checker's human-readable name. The display name should be unique within a Cloud Monitoring Metrics Scope in order to make it easier to identify; however, uniqueness is not enforced.",
"type": "string"
},
"gcpZone": {
@@ -3588,7 +3893,7 @@
"type": "string"
},
"name": {
"description": "A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] [PROJECT_ID_OR_NUMBER] is the Stackdriver Workspace project for the Uptime check config associated with the internal checker.",
"description": "A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] [PROJECT_ID_OR_NUMBER] is the Cloud Monitoring Metrics Scope project for the Uptime check config associated with the internal checker.",
"type": "string"
},
"network": {
@@ -3596,7 +3901,7 @@
"type": "string"
},
"peerProjectId": {
"description": "The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.",
"description": "The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project.",
"type": "string"
},
"state": {
@@ -3635,6 +3940,31 @@
},
"type": "object"
},
"JsonPathMatcher": {
"description": "Information needed to perform a JSONPath content match. Used for ContentMatcherOption::MATCHES_JSON_PATH and ContentMatcherOption::NOT_MATCHES_JSON_PATH.",
"id": "JsonPathMatcher",
"properties": {
"jsonMatcher": {
"description": "The type of JSONPath match that will be applied to the JSON output (ContentMatcher.content)",
"enum": [
"JSON_PATH_MATCHER_OPTION_UNSPECIFIED",
"EXACT_MATCH",
"REGEX_MATCH"
],
"enumDescriptions": [
"No JSONPath matcher type specified (not valid).",
"Selects 'exact string' matching. The match succeeds if the content at the json_path within the output is exactly the same as the content string.",
"Selects regular-expression matching. The match succeeds if the content at the json_path within the output matches the regular expression specified in the content string."
],
"type": "string"
},
"jsonPath": {
"description": "JSONPath within the response output pointing to the expected ContentMatcher::content to match against.",
"type": "string"
}
},
"type": "object"
},
"LabelDescriptor": {
"description": "A description of a label.",
"id": "LabelDescriptor",
@@ -3895,6 +4225,24 @@
},
"type": "object"
},
"ListSnoozesResponse": {
"description": "The results of a successful ListSnoozes call, containing the matching Snoozes.",
"id": "ListSnoozesResponse",
"properties": {
"nextPageToken": {
"description": "Page token for repeated calls to ListSnoozes, to fetch additional pages of results. If this is empty or missing, there are no more pages.",
"type": "string"
},
"snoozes": {
"description": "Snoozes matching this list call.",
"items": {
"$ref": "Snooze"
},
"type": "array"
}
},
"type": "object"
},
"ListTimeSeriesResponse": {
"description": "The ListTimeSeries response.",
"id": "ListTimeSeriesResponse",
@@ -4270,7 +4618,7 @@
"enumDescriptions": [
"An unspecified evaluation missing data option. Equivalent to EVALUATION_MISSING_DATA_NO_OP.",
"If there is no data to evaluate the condition, then evaluate the condition as false.",
"If there is no data to evaluate the condition, then evaluate the condition as true. The default for conditions with a duration value.",
"If there is no data to evaluate the condition, then evaluate the condition as true.",
"Do not evaluate the condition to any value if there is no data."
],
"type": "string"
@@ -4279,6 +4627,10 @@
"description": "Required. A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.",
"type": "string"
},
"forecastOptions": {
"$ref": "ForecastOptions",
"description": "When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizion. When this field is not set, the MetricThreshold tests the current value of the timeseries against the threshold."
},
"thresholdValue": {
"description": "A value against which to compare the time series.",
"format": "double",
@@ -4405,7 +4757,7 @@
"enumDescriptions": [
"An unspecified evaluation missing data option. Equivalent to EVALUATION_MISSING_DATA_NO_OP.",
"If there is no data to evaluate the condition, then evaluate the condition as false.",
"If there is no data to evaluate the condition, then evaluate the condition as true. The default for conditions with a duration value.",
"If there is no data to evaluate the condition, then evaluate the condition as true.",
"Do not evaluate the condition to any value if there is no data."
],
"type": "string"
@@ -4560,8 +4912,8 @@
],
"enumDescriptions": [
"An invalid sentinel value, used to indicate that a tier has not been provided explicitly.",
"The Stackdriver Basic tier, a free tier of service that provides basic features, a moderate allotment of logs, and access to built-in metrics. A number of features are not available in this tier. For more details, see the service tiers documentation (https://cloud.google.com/monitoring/workspaces/tiers).",
"The Stackdriver Premium tier, a higher, more expensive tier of service that provides access to all Stackdriver features, lets you use Stackdriver with AWS accounts, and has a larger allotments for logs and metrics. For more details, see the service tiers documentation (https://cloud.google.com/monitoring/workspaces/tiers)."
"The Cloud Monitoring Basic tier, a free tier of service that provides basic features, a moderate allotment of logs, and access to built-in metrics. A number of features are not available in this tier. For more details, see the service tiers documentation (https://cloud.google.com/monitoring/workspaces/tiers).",
"The Cloud Monitoring Premium tier, a higher, more expensive tier of service that provides access to all Cloud Monitoring features, lets you use Cloud Monitoring with AWS accounts, and has a larger allotments for logs and metrics. For more details, see the service tiers documentation (https://cloud.google.com/monitoring/workspaces/tiers)."
],
"type": "string"
},
@@ -4660,6 +5012,18 @@
},
"type": "object"
},
"PingConfig": {
"description": "Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain.",
"id": "PingConfig",
"properties": {
"pingsCount": {
"description": "Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Point": {
"description": "A single data point in a time series.",
"id": "Point",
@@ -4799,6 +5163,40 @@
},
"type": "object"
},
"ResponseStatusCode": {
"description": "A status to accept. Either a status code class like \"2xx\", or an integer status code like \"200\".",
"id": "ResponseStatusCode",
"properties": {
"statusClass": {
"description": "A class of status codes to accept.",
"enum": [
"STATUS_CLASS_UNSPECIFIED",
"STATUS_CLASS_1XX",
"STATUS_CLASS_2XX",
"STATUS_CLASS_3XX",
"STATUS_CLASS_4XX",
"STATUS_CLASS_5XX",
"STATUS_CLASS_ANY"
],
"enumDescriptions": [
"Default value that matches no status codes.",
"The class of status codes between 100 and 199.",
"The class of status codes between 200 and 299.",
"The class of status codes between 300 and 399.",
"The class of status codes between 400 and 499.",
"The class of status codes between 500 and 599.",
"The class of all status codes."
],
"type": "string"
},
"statusValue": {
"description": "A status code to accept.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SendNotificationChannelVerificationCodeRequest": {
"description": "The SendNotificationChannelVerificationCode request.",
"id": "SendNotificationChannelVerificationCodeRequest",
@@ -4813,10 +5211,18 @@
"$ref": "AppEngine",
"description": "Type used for App Engine services."
},
"basicService": {
"$ref": "BasicService",
"description": "Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli)."
},
"cloudEndpoints": {
"$ref": "CloudEndpoints",
"description": "Type used for Cloud Endpoints services."
},
"cloudRun": {
"$ref": "CloudRun",
"description": "Type used for Cloud Run services."
},
"clusterIstio": {
"$ref": "ClusterIstio",
"description": "Type used for Istio services that live in a Kubernetes cluster."
@@ -4829,6 +5235,18 @@
"description": "Name used for UI elements listing this Service.",
"type": "string"
},
"gkeNamespace": {
"$ref": "GkeNamespace",
"description": "Type used for GKE Namespaces."
},
"gkeService": {
"$ref": "GkeService",
"description": "Type used for GKE Services (the Kubernetes concept of a service)."
},
"gkeWorkload": {
"$ref": "GkeWorkload",
"description": "Type used for GKE Workloads."
},
"istioCanonicalService": {
"$ref": "IstioCanonicalService",
"description": "Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/)"
@@ -4934,6 +5352,29 @@
},
"type": "object"
},
"Snooze": {
"description": "A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time.",
"id": "Snooze",
"properties": {
"criteria": {
"$ref": "Criteria",
"description": "Required. This defines the criteria for applying the Snooze. See Criteria for more information."
},
"displayName": {
"description": "Required. A display name for the Snooze. This can be, at most, 512 unicode characters.",
"type": "string"
},
"interval": {
"$ref": "TimeInterval",
"description": "Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI."
},
"name": {
"description": "Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.",
"type": "string"
}
},
"type": "object"
},
"SourceContext": {
"description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
"id": "SourceContext",
@@ -4987,6 +5428,10 @@
"description": "Information required for a TCP Uptime check request.",
"id": "TcpCheck",
"properties": {
"pingConfig": {
"$ref": "PingConfig",
"description": "Contains information needed to add pings to a TCP check."
},
"port": {
"description": "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.",
"format": "int32",
@@ -5272,7 +5717,7 @@
"type": "array"
},
"displayName": {
"description": "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.",
"description": "A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.",
"type": "string"
},
"httpCheck": {
@@ -5292,7 +5737,7 @@
},
"monitoredResource": {
"$ref": "MonitoredResource",
"description": "The monitored resource (https://cloud.google.com/monitoring/api/resources) 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 servicedirectory_service"
"description": "The monitored resource (https://cloud.google.com/monitoring/api/resources) 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 servicedirectory_service cloud_run_revision"
},
"name": {
"description": "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.",
@@ -5336,6 +5781,13 @@
"description": "The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.",
"format": "google-duration",
"type": "string"
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.",
"type": "object"
}
},
"type": "object"