Update all json files; make some fixes to make it work at all

This commit is contained in:
Sebastian Thiel
2022-03-08 07:59:31 +08:00
parent d12cd3238e
commit 743a56f4b7
372 changed files with 256017 additions and 32197 deletions

View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/monitoring": {
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
@@ -21,7 +21,7 @@
"baseUrl": "https://monitoring.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Monitoring",
"description": "Manages your Cloud Monitoring data and configurations. Most projects must be associated with a Workspace, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Cloud Monitoring documentation.",
"description": "Manages your Cloud Monitoring data and configurations.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/monitoring/api/",
"fullyEncodeReservedExpansion": true,
@@ -114,12 +114,168 @@
},
"protocol": "rest",
"resources": {
"locations": {
"resources": {
"global": {
"resources": {
"metricsScopes": {
"methods": {
"get": {
"description": "Returns a specific Metrics Scope, including the list of projects monitored by the specified Metrics Scope.",
"flatPath": "v1/locations/global/metricsScopes/{metricsScopesId}",
"httpMethod": "GET",
"id": "monitoring.locations.global.metricsScopes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Metrics Scope. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}",
"location": "path",
"pattern": "^locations/global/metricsScopes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "MetricsScope"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"listMetricsScopesByMonitoredProject": {
"description": "Returns a list of every Metrics Scope that a specific MonitoredProject has been added to. The metrics scope representing the specified monitored project will always be the first entry in the response.",
"flatPath": "v1/locations/global/metricsScopes:listMetricsScopesByMonitoredProject",
"httpMethod": "GET",
"id": "monitoring.locations.global.metricsScopes.listMetricsScopesByMonitoredProject",
"parameterOrder": [],
"parameters": {
"monitoredResourceContainer": {
"description": "Required. The resource name of the Monitored Project being requested. Example: projects/{MONITORED_PROJECT_ID_OR_NUMBER}",
"location": "query",
"type": "string"
}
},
"path": "v1/locations/global/metricsScopes:listMetricsScopesByMonitoredProject",
"response": {
"$ref": "ListMetricsScopesByMonitoredProjectResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
},
"resources": {
"projects": {
"methods": {
"create": {
"description": "Adds a MonitoredProject with the given project ID to the specified Metrics Scope.",
"flatPath": "v1/locations/global/metricsScopes/{metricsScopesId}/projects",
"httpMethod": "POST",
"id": "monitoring.locations.global.metricsScopes.projects.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}",
"location": "path",
"pattern": "^locations/global/metricsScopes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/projects",
"request": {
"$ref": "MonitoredProject"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
},
"delete": {
"description": "Deletes a MonitoredProject from the specified Metrics Scope.",
"flatPath": "v1/locations/global/metricsScopes/{metricsScopesId}/projects/{projectsId}",
"httpMethod": "DELETE",
"id": "monitoring.locations.global.metricsScopes.projects.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the MonitoredProject. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}Authorization requires the following Google IAM (https://cloud.google.com/iam) permissions on both the Metrics Scope and on the MonitoredProject: monitoring.metricsScopes.link",
"location": "path",
"pattern": "^locations/global/metricsScopes/[^/]+/projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
}
}
}
}
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "monitoring.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
}
},
"projects": {
"resources": {
"dashboards": {
"methods": {
"create": {
"description": "Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API. This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management.",
"description": "Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API (https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management (https://cloud.google.com/iam).",
"flatPath": "v1/projects/{projectsId}/dashboards",
"httpMethod": "POST",
"id": "monitoring.projects.dashboards.create",
@@ -133,6 +289,11 @@
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "If set, validate the request and preview the review, but do not actually save it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/dashboards",
@@ -255,6 +416,11 @@
"pattern": "^projects/[^/]+/dashboards/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "If set, validate the request and preview the review, but do not actually save it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
@@ -271,11 +437,249 @@
]
}
}
},
"location": {
"resources": {
"prometheus": {
"resources": {
"api": {
"resources": {
"v1": {
"methods": {
"query": {
"description": "Evaluate a PromQL query at a single point in time.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.query",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/query",
"request": {
"$ref": "QueryInstantRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"query_range": {
"description": "Evaluate a PromQL query with start, end time range.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query_range",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.query_range",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/query_range",
"request": {
"$ref": "QueryRangeRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"series": {
"description": "Lists metadata for metrics.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/series",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.series",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" for now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/series",
"request": {
"$ref": "QuerySeriesRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
},
"resources": {
"label": {
"methods": {
"values": {
"description": "Lists possible values for a given label name.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/label/{label}/values",
"httpMethod": "GET",
"id": "monitoring.projects.location.prometheus.api.v1.label.values",
"parameterOrder": [
"name",
"location",
"label"
],
"parameters": {
"end": {
"description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"location": "query",
"type": "string"
},
"label": {
"description": "The label name for which values are queried.",
"location": "path",
"required": true,
"type": "string"
},
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"match": {
"description": "A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them.",
"location": "query",
"type": "string"
},
"name": {
"description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"start": {
"description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/label/{label}/values",
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
}
},
"metadata": {
"methods": {
"list": {
"description": "Lists metadata for metrics.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/metadata",
"httpMethod": "GET",
"id": "monitoring.projects.location.prometheus.api.v1.metadata.list",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"limit": {
"description": "Maximum number of metrics to return.",
"format": "int64",
"location": "query",
"type": "string"
},
"location": {
"description": "Location of the resource information. Has to be \"global\" for now.",
"location": "path",
"required": true,
"type": "string"
},
"metric": {
"description": "The metric name for which to query metadata. If unset, all metric metadata is returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/metadata",
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"revision": "20210322",
"revision": "20220218",
"rootUrl": "https://monitoring.googleapis.com/",
"schemas": {
"Aggregation": {
@@ -379,6 +783,17 @@
},
"type": "object"
},
"AlertChart": {
"description": "A chart that displays alert policy data.",
"id": "AlertChart",
"properties": {
"name": {
"description": "Required. The resource name of the alert policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] ",
"type": "string"
}
},
"type": "object"
},
"Axis": {
"description": "A chart axis.",
"id": "Axis",
@@ -427,6 +842,17 @@
},
"type": "object"
},
"CollapsibleGroup": {
"description": "A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.",
"id": "CollapsibleGroup",
"properties": {
"collapsed": {
"description": "The collapsed state of the widget on first page load.",
"type": "boolean"
}
},
"type": "object"
},
"Column": {
"description": "Defines the layout properties and content for a column.",
"id": "Column",
@@ -480,6 +906,13 @@
"$ref": "GridLayout",
"description": "Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels applied to the dashboard",
"type": "object"
},
"mosaicLayout": {
"$ref": "MosaicLayout",
"description": "The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks."
@@ -526,6 +959,20 @@
],
"type": "string"
},
"targetAxis": {
"description": "Optional. The target axis to use for plotting the metric.",
"enum": [
"TARGET_AXIS_UNSPECIFIED",
"Y1",
"Y2"
],
"enumDescriptions": [
"The target axis was not specified. Defaults to Y1.",
"The y_axis (the right axis of chart).",
"The y2_axis (the left axis of chart)."
],
"type": "string"
},
"timeSeriesQuery": {
"$ref": "TimeSeriesQuery",
"description": "Required. Fields for querying time series data from the Stackdriver metrics API."
@@ -695,6 +1142,33 @@
},
"type": "object"
},
"HttpBody": {
"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.This message can be used both in streaming and non-streaming API methods in the request as well as the response.It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.",
"id": "HttpBody",
"properties": {
"contentType": {
"description": "The HTTP Content-Type header value specifying the content type of the body.",
"type": "string"
},
"data": {
"description": "The HTTP request/response body as raw binary.",
"format": "byte",
"type": "string"
},
"extensions": {
"description": "Application specific response metadata. Must be set in the first response for streaming APIs.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ListDashboardsResponse": {
"description": "The ListDashboards request.",
"id": "ListDashboardsResponse",
@@ -713,6 +1187,86 @@
},
"type": "object"
},
"ListMetricsScopesByMonitoredProjectResponse": {
"description": "Response for the ListMetricsScopesByMonitoredProject method.",
"id": "ListMetricsScopesByMonitoredProjectResponse",
"properties": {
"metricsScopes": {
"description": "A set of all metrics scopes that the specified monitored project has been added to.",
"items": {
"$ref": "MetricsScope"
},
"type": "array"
}
},
"type": "object"
},
"LogsPanel": {
"description": "A widget that displays a stream of log.",
"id": "LogsPanel",
"properties": {
"filter": {
"description": "A filter that chooses which log entries to return. See Advanced Logs Queries (https://cloud.google.com/logging/docs/view/advanced-queries). Only log entries that match the filter are returned. An empty filter matches all log entries.",
"type": "string"
},
"resourceNames": {
"description": "The names of logging resources to collect logs for. Currently only projects are supported. If empty, the widget will default to the host project.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MetricsScope": {
"description": "Represents a Metrics Scope (https://cloud.google.com/monitoring/settings#concept-scope) in Cloud Monitoring, which specifies one or more Google projects and zero or more AWS accounts to monitor together.",
"id": "MetricsScope",
"properties": {
"createTime": {
"description": "Output only. The time when this Metrics Scope was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"monitoredProjects": {
"description": "Output only. The list of projects monitored by this Metrics Scope.",
"items": {
"$ref": "MonitoredProject"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Immutable. The resource name of the Monitoring Metrics Scope. On input, the resource name can be specified with the scoping project ID or number. On output, the resource name is specified with the scoping project number. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}",
"type": "string"
},
"updateTime": {
"description": "Output only. The time when this Metrics Scope record was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"MonitoredProject": {
"description": "A project being monitored (https://cloud.google.com/monitoring/settings/multiple-projects#create-multi) by a Metrics Scope.",
"id": "MonitoredProject",
"properties": {
"createTime": {
"description": "Output only. The time when this MonitoredProject was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Immutable. The resource name of the MonitoredProject. On input, the resource name includes the scoping project ID and monitored project ID. On output, it contains the equivalent project numbers. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}",
"type": "string"
}
},
"type": "object"
},
"MosaicLayout": {
"description": "A mosaic layout divides the available space into a grid of blocks, and overlays the grid with tiles. Unlike GridLayout, tiles may span multiple grid blocks and can be placed at arbitrary locations in the grid.",
"id": "MosaicLayout",
@@ -732,6 +1286,76 @@
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
"type": "object"
}
},
"type": "object"
},
"OperationMetadata": {
"description": "Contains metadata for longrunning operation for the edit Metrics Scope endpoints.",
"id": "OperationMetadata",
"properties": {
"createTime": {
"description": "The time when the batch request was received.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "Current state of the batch operation.",
"enum": [
"STATE_UNSPECIFIED",
"CREATED",
"RUNNING",
"DONE",
"CANCELLED"
],
"enumDescriptions": [
"Invalid.",
"Request has been received.",
"Request is actively being processed.",
"The batch processing is done.",
"The batch processing was cancelled."
],
"type": "string"
},
"updateTime": {
"description": "The time when the operation result was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Option": {
"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
"id": "Option",
@@ -797,6 +1421,67 @@
},
"type": "object"
},
"QueryInstantRequest": {
"description": "QueryInstantRequest holds all parameters of the Prometheus upstream instant query API plus GCM specific parameters.",
"id": "QueryInstantRequest",
"properties": {
"query": {
"description": "A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.",
"type": "string"
},
"time": {
"description": "The single point in time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"type": "string"
},
"timeout": {
"description": "An upper bound timeout for the query. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field.",
"type": "string"
}
},
"type": "object"
},
"QueryRangeRequest": {
"description": "QueryRangeRequest holds all parameters of the Prometheus upstream range query API plus GCM specific parameters.",
"id": "QueryRangeRequest",
"properties": {
"end": {
"description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"type": "string"
},
"query": {
"description": "A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.",
"type": "string"
},
"start": {
"description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"type": "string"
},
"step": {
"description": "The resolution of query result. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field.",
"type": "string"
},
"timeout": {
"description": "An upper bound timeout for the query. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field.",
"type": "string"
}
},
"type": "object"
},
"QuerySeriesRequest": {
"description": "QuerySeries holds all parameters of the Prometheus upstream API for querying series.",
"id": "QuerySeriesRequest",
"properties": {
"end": {
"description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"type": "string"
},
"start": {
"description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"type": "string"
}
},
"type": "object"
},
"RatioPart": {
"description": "Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio.",
"id": "RatioPart",
@@ -883,7 +1568,7 @@
"type": "object"
},
"SpanContext": {
"description": "The context of a span, attached to Exemplars in Distribution values during aggregation.It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] ",
"description": "The context of a span. This is attached to an Exemplar in Distribution values during aggregation.It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] ",
"id": "SpanContext",
"properties": {
"spanName": {
@@ -943,6 +1628,71 @@
},
"type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"TableDataSet": {
"description": "Groups a time series query definition with table options.",
"id": "TableDataSet",
"properties": {
"minAlignmentPeriod": {
"description": "Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.",
"format": "google-duration",
"type": "string"
},
"tableDisplayOptions": {
"$ref": "TableDisplayOptions",
"description": "Optional. Table display options for configuring how the table is rendered."
},
"tableTemplate": {
"description": "Optional. A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value i.e. \"${resource.labels.project_id}.\"",
"type": "string"
},
"timeSeriesQuery": {
"$ref": "TimeSeriesQuery",
"description": "Required. Fields for querying time series data from the Stackdriver metrics API."
}
},
"type": "object"
},
"TableDisplayOptions": {
"description": "Table display options that can be reused.",
"id": "TableDisplayOptions",
"properties": {
"shownColumns": {
"description": "Optional. Columns to display in the table. Leave empty to display all available columns. Note: This field is for future features and is not currently used.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Text": {
"description": "A widget that displays textual content.",
"id": "Text",
@@ -1004,6 +1754,20 @@
"description": "A label for the threshold.",
"type": "string"
},
"targetAxis": {
"description": "The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard.",
"enum": [
"TARGET_AXIS_UNSPECIFIED",
"Y1",
"Y2"
],
"enumDescriptions": [
"The target axis was not specified. Defaults to Y1.",
"The y_axis (the right axis of chart).",
"The y2_axis (the left axis of chart)."
],
"type": "string"
},
"value": {
"description": "The value of the threshold. The value should be defined in the native scale of the metric.",
"format": "double",
@@ -1120,6 +1884,20 @@
},
"type": "object"
},
"TimeSeriesTable": {
"description": "A table that displays time series data.",
"id": "TimeSeriesTable",
"properties": {
"dataSets": {
"description": "Required. The data displayed in this table.",
"items": {
"$ref": "TableDataSet"
},
"type": "array"
}
},
"type": "object"
},
"Type": {
"description": "A protocol buffer message type.",
"id": "Type",
@@ -1172,10 +1950,22 @@
"description": "Widget contains a single dashboard component and configuration of how to present the component in the dashboard.",
"id": "Widget",
"properties": {
"alertChart": {
"$ref": "AlertChart",
"description": "A chart of alert policy data."
},
"blank": {
"$ref": "Empty",
"description": "A blank space."
},
"collapsibleGroup": {
"$ref": "CollapsibleGroup",
"description": "A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets."
},
"logsPanel": {
"$ref": "LogsPanel",
"description": "A widget that shows a stream of logs."
},
"scorecard": {
"$ref": "Scorecard",
"description": "A scorecard summarizing time series data."
@@ -1184,6 +1974,10 @@
"$ref": "Text",
"description": "A raw string or markdown displaying textual content."
},
"timeSeriesTable": {
"$ref": "TimeSeriesTable",
"description": "A widget that displays time series data in a tabular format."
},
"title": {
"description": "Optional. The title of the widget.",
"type": "string"
@@ -1226,6 +2020,10 @@
"$ref": "Axis",
"description": "The properties applied to the X axis."
},
"y2Axis": {
"$ref": "Axis",
"description": "The properties applied to the Y2 axis."
},
"yAxis": {
"$ref": "Axis",
"description": "The properties applied to the Y axis."