| { |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| }, |
| "https://www.googleapis.com/auth/monitoring": { |
| "description": "View and write monitoring data for all of your Google and third-party Cloud and API projects" |
| }, |
| "https://www.googleapis.com/auth/monitoring.read": { |
| "description": "View monitoring data for all of your Google Cloud and third-party projects" |
| }, |
| "https://www.googleapis.com/auth/monitoring.write": { |
| "description": "Publish metric data to your Google Cloud projects" |
| } |
| } |
| } |
| }, |
| "basePath": "", |
| "baseUrl": "https://monitoring.googleapis.com/", |
| "batchPath": "batch", |
| "canonicalName": "Monitoring", |
| "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, 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 Stackdriver Monitoring documentation.", |
| "discoveryVersion": "v1", |
| "documentationLink": "https://cloud.google.com/monitoring/api/", |
| "fullyEncodeReservedExpansion": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "id": "monitoring:v1", |
| "kind": "discovery#restDescription", |
| "name": "monitoring", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "parameters": { |
| "$.xgafv": { |
| "description": "V1 error format.", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alt": { |
| "default": "json", |
| "description": "Data format for response.", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "key": { |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "quotaUser": { |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "location": "query", |
| "type": "string" |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "protocol": "rest", |
| "resources": { |
| "projects": { |
| "resources": { |
| "dashboards": { |
| "methods": { |
| "create": { |
| "description": "Creates a new custom dashboard.This method requires the monitoring.dashboards.create permission on the specified project. For more information, see Google Cloud IAM (https://cloud.google.com/iam).", |
| "flatPath": "v1/projects/{projectsId}/dashboards", |
| "httpMethod": "POST", |
| "id": "monitoring.projects.dashboards.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\". The {project_id_or_number} must match the dashboard resource name.", |
| "location": "path", |
| "pattern": "^projects/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/dashboards", |
| "request": { |
| "$ref": "Dashboard" |
| }, |
| "response": { |
| "$ref": "Dashboard" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform", |
| "https://www.googleapis.com/auth/monitoring", |
| "https://www.googleapis.com/auth/monitoring.write" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an existing custom dashboard.This method requires the monitoring.dashboards.delete permission on the specified dashboard. For more information, see Google Cloud IAM (https://cloud.google.com/iam).", |
| "flatPath": "v1/projects/{projectsId}/dashboards/{dashboardsId}", |
| "httpMethod": "DELETE", |
| "id": "monitoring.projects.dashboards.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The resource name of the Dashboard. The format is \"projects/{project_id_or_number}/dashboards/{dashboard_id}\".", |
| "location": "path", |
| "pattern": "^projects/[^/]+/dashboards/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform", |
| "https://www.googleapis.com/auth/monitoring", |
| "https://www.googleapis.com/auth/monitoring.write" |
| ] |
| }, |
| "get": { |
| "description": "Fetches a specific dashboard.This method requires the monitoring.dashboards.get permission on the specified dashboard. For more information, see Google Cloud IAM (https://cloud.google.com/iam).", |
| "flatPath": "v1/projects/{projectsId}/dashboards/{dashboardsId}", |
| "httpMethod": "GET", |
| "id": "monitoring.projects.dashboards.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The resource name of the Dashboard. The format is one of \"dashboards/{dashboard_id}\" (for system dashboards) or \"projects/{project_id_or_number}/dashboards/{dashboard_id}\" (for custom dashboards).", |
| "location": "path", |
| "pattern": "^projects/[^/]+/dashboards/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "Dashboard" |
| }, |
| "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 existing dashboards.This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Google Cloud IAM (https://cloud.google.com/iam).", |
| "flatPath": "v1/projects/{projectsId}/dashboards", |
| "httpMethod": "GET", |
| "id": "monitoring.projects.dashboards.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "The scope of the dashboards to list. A project scope must be specified in the form of \"projects/{project_id_or_number}\".", |
| "location": "path", |
| "pattern": "^projects/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+parent}/dashboards", |
| "response": { |
| "$ref": "ListDashboardsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform", |
| "https://www.googleapis.com/auth/monitoring", |
| "https://www.googleapis.com/auth/monitoring.read" |
| ] |
| }, |
| "patch": { |
| "description": "Replaces an existing custom dashboard with a new definition.This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Google Cloud IAM (https://cloud.google.com/iam).", |
| "flatPath": "v1/projects/{projectsId}/dashboards/{dashboardsId}", |
| "httpMethod": "PATCH", |
| "id": "monitoring.projects.dashboards.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The resource name of the dashboard.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/dashboards/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "request": { |
| "$ref": "Dashboard" |
| }, |
| "response": { |
| "$ref": "Dashboard" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform", |
| "https://www.googleapis.com/auth/monitoring", |
| "https://www.googleapis.com/auth/monitoring.write" |
| ] |
| } |
| } |
| } |
| } |
| } |
| }, |
| "revision": "20191207", |
| "rootUrl": "https://monitoring.googleapis.com/", |
| "schemas": { |
| "Aggregation": { |
| "description": "Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see Aggregation.", |
| "id": "Aggregation", |
| "properties": { |
| "alignmentPeriod": { |
| "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.", |
| "format": "google-duration", |
| "type": "string" |
| }, |
| "crossSeriesReducer": { |
| "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.", |
| "enum": [ |
| "REDUCE_NONE", |
| "REDUCE_MEAN", |
| "REDUCE_MIN", |
| "REDUCE_MAX", |
| "REDUCE_SUM", |
| "REDUCE_STDDEV", |
| "REDUCE_COUNT", |
| "REDUCE_COUNT_TRUE", |
| "REDUCE_COUNT_FALSE", |
| "REDUCE_FRACTION_TRUE", |
| "REDUCE_PERCENTILE_99", |
| "REDUCE_PERCENTILE_95", |
| "REDUCE_PERCENTILE_50", |
| "REDUCE_PERCENTILE_05" |
| ], |
| "enumDescriptions": [ |
| "No cross-time series reduction. The output of the aligner is returned.", |
| "Reduce by computing the mean across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric or distribution values. The value type of the output is DOUBLE.", |
| "Reduce by computing the minimum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric values. The value type of the output is the same as the value type of the input.", |
| "Reduce by computing the maximum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric values. The value type of the output is the same as the value type of the input.", |
| "Reduce by computing the sum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric and distribution values. The value type of the output is the same as the value type of the input.", |
| "Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric or distribution values. The value type of the output is DOUBLE.", |
| "Reduce by computing the count of data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of numeric, Boolean, distribution, and string value type. The value type of the output is INT64.", |
| "Reduce by computing the count of True-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The value type of the output is INT64.", |
| "Reduce by computing the count of False-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The value type of the output is INT64.", |
| "Reduce by computing the fraction of True-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The output value is in the range 0, 1 and has value type DOUBLE.", |
| "Reduce by computing 99th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is DOUBLE", |
| "Reduce by computing 95th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is DOUBLE", |
| "Reduce by computing 50th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is DOUBLE", |
| "Reduce by computing 5th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is DOUBLE" |
| ], |
| "type": "string" |
| }, |
| "groupByFields": { |
| "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "perSeriesAligner": { |
| "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.", |
| "enum": [ |
| "ALIGN_NONE", |
| "ALIGN_DELTA", |
| "ALIGN_RATE", |
| "ALIGN_INTERPOLATE", |
| "ALIGN_NEXT_OLDER", |
| "ALIGN_MIN", |
| "ALIGN_MAX", |
| "ALIGN_MEAN", |
| "ALIGN_COUNT", |
| "ALIGN_SUM", |
| "ALIGN_STDDEV", |
| "ALIGN_COUNT_TRUE", |
| "ALIGN_COUNT_FALSE", |
| "ALIGN_FRACTION_TRUE", |
| "ALIGN_PERCENTILE_99", |
| "ALIGN_PERCENTILE_95", |
| "ALIGN_PERCENTILE_50", |
| "ALIGN_PERCENTILE_05", |
| "ALIGN_PERCENT_CHANGE" |
| ], |
| "enumDescriptions": [ |
| "No alignment. Raw data is returned. Not valid if cross-time series reduction is requested. The value type of the result is the same as the value type of the input.", |
| "Align and convert to delta metric type. This alignment is valid for cumulative metrics and delta metrics. Aligning an existing delta metric to a delta metric requires that the alignment period be increased. The value type of the result is the same as the value type of the input.One can think of this aligner as a rate but without time units; that is, the output is conceptually (second_point - first_point).", |
| "Align and convert to a rate. This alignment is valid for cumulative metrics and delta metrics with numeric values. The output is a gauge metric with value type DOUBLE.One can think of this aligner as conceptually providing the slope of the line that passes through the value at the start and end of the window. In other words, this is conceptually ((y1 - y0)/(t1 - t0)), and the output unit is one that has a \"/time\" dimension.If, by rate, you are looking for percentage change, see the ALIGN_PERCENT_CHANGE aligner option.", |
| "Align by interpolating between adjacent points around the period boundary. This alignment is valid for gauge metrics with numeric values. The value type of the result is the same as the value type of the input.", |
| "Align by shifting the oldest data point before the period boundary to the boundary. This alignment is valid for gauge metrics. The value type of the result is the same as the value type of the input.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the minimum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the result is the same as the value type of the input.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the maximum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the result is the same as the value type of the input.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the average or arithmetic mean of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the output is DOUBLE.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the count of all data points in the period. This alignment is valid for gauge and delta metrics with numeric or Boolean values. The value type of the output is INT64.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the sum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric and distribution values. The value type of the output is the same as the value type of the input.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the standard deviation of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the output is DOUBLE.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the count of True-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The value type of the output is INT64.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the count of False-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The value type of the output is INT64.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the fraction of True-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The output value is in the range 0, 1 and has value type DOUBLE.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the 99th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type DOUBLE.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the 95th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type DOUBLE.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the 50th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type DOUBLE.", |
| "Align time series via aggregation. The resulting data point in the alignment period is the 5th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type DOUBLE.", |
| "Align and convert to a percentage change. This alignment is valid for gauge and delta metrics with numeric values. This alignment conceptually computes the equivalent of \"((current - previous)/previous)*100\" where previous value is determined based on the alignmentPeriod. In the event that previous is 0 the calculated value is infinity with the exception that if both (current - previous) and previous are 0 the calculated value is 0. A 10 minute moving mean is computed at each point of the time window prior to the above calculation to smooth the metric and prevent false positives from very short lived spikes. Only applicable for data that is \u003e= 0. Any values \u003c 0 are treated as no data. While delta metrics are accepted by this alignment special care should be taken that the values for the metric will always be positive. The output is a gauge metric with value type DOUBLE." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Axis": { |
| "description": "A chart axis.", |
| "id": "Axis", |
| "properties": { |
| "label": { |
| "description": "The label of the axis.", |
| "type": "string" |
| }, |
| "scale": { |
| "description": "The axis scale. By default, a linear scale is used.", |
| "enum": [ |
| "SCALE_UNSPECIFIED", |
| "LINEAR", |
| "LOG10" |
| ], |
| "enumDescriptions": [ |
| "Scale is unspecified. The view will default to LINEAR.", |
| "Linear scale.", |
| "Logarithmic scale (base 10)." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "ChartOptions": { |
| "description": "Options to control visual rendering of a chart.", |
| "id": "ChartOptions", |
| "properties": { |
| "mode": { |
| "description": "The chart mode.", |
| "enum": [ |
| "MODE_UNSPECIFIED", |
| "COLOR", |
| "X_RAY", |
| "STATS" |
| ], |
| "enumDescriptions": [ |
| "Mode is unspecified. The view will default to COLOR.", |
| "The chart distinguishes data series using different color. Line colors may get reused when there are many lines in the chart.", |
| "The chart uses the Stackdriver x-ray mode, in which each data set is plotted using the same semi-transparent color.", |
| "The chart displays statistics such as average, median, 95th percentile, and more." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Column": { |
| "description": "Defines the layout properties and content for a column.", |
| "id": "Column", |
| "properties": { |
| "weight": { |
| "description": "The relative weight of this column. The column weight is used to adjust the width of columns on the screen (relative to peers). Greater the weight, greater the width of the column on the screen. If omitted, a value of 1 is used while rendering.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "widgets": { |
| "description": "The display widgets arranged vertically in this column.", |
| "items": { |
| "$ref": "Widget" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "ColumnLayout": { |
| "description": "A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.", |
| "id": "ColumnLayout", |
| "properties": { |
| "columns": { |
| "description": "The columns of content to display.", |
| "items": { |
| "$ref": "Column" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "Dashboard": { |
| "description": "A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.", |
| "id": "Dashboard", |
| "properties": { |
| "columnLayout": { |
| "$ref": "ColumnLayout", |
| "description": "The content is divided into equally spaced columns and the widgets are arranged vertically." |
| }, |
| "displayName": { |
| "description": "The mutable, human-readable name.", |
| "type": "string" |
| }, |
| "etag": { |
| "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. An etag is returned in the response to GetDashboard, and users are expected to put that etag in the request to UpdateDashboard to ensure that their change will be applied to the same version of the Dashboard configuration. The field should not be passed during dashboard creation.", |
| "type": "string" |
| }, |
| "gridLayout": { |
| "$ref": "GridLayout", |
| "description": "Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles." |
| }, |
| "name": { |
| "description": "The resource name of the dashboard.", |
| "type": "string" |
| }, |
| "rowLayout": { |
| "$ref": "RowLayout", |
| "description": "The content is divided into equally spaced rows and the widgets are arranged horizontally." |
| } |
| }, |
| "type": "object" |
| }, |
| "DataSet": { |
| "description": "Groups a time series query definition with charting options.", |
| "id": "DataSet", |
| "properties": { |
| "legendTemplate": { |
| "description": "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.", |
| "type": "string" |
| }, |
| "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" |
| }, |
| "plotType": { |
| "description": "How this data should be plotted on the chart.", |
| "enum": [ |
| "PLOT_TYPE_UNSPECIFIED", |
| "LINE", |
| "STACKED_AREA", |
| "STACKED_BAR", |
| "HEATMAP" |
| ], |
| "enumDescriptions": [ |
| "Plot type is unspecified. The view will default to LINE.", |
| "The data is plotted as a set of lines (one line per series).", |
| "The data is plotted as a set of filled areas (one area per series), with the areas stacked vertically (the base of each area is the top of its predecessor, and the base of the first area is the X axis). Since the areas do not overlap, each is filled with a different opaque color.", |
| "The data is plotted as a set of rectangular boxes (one box per series), with the boxes stacked vertically (the base of each box is the top of its predecessor, and the base of the first box is the X axis). Since the boxes do not overlap, each is filled with a different opaque color.", |
| "The data is plotted as a heatmap. The series being plotted must have a DISTRIBUTION value type. The value of each bucket in the distribution is displayed as a color. This type is not currently available in the Stackdriver Monitoring application." |
| ], |
| "type": "string" |
| }, |
| "timeSeriesQuery": { |
| "$ref": "TimeSeriesQuery", |
| "description": "Fields for querying time series data from the Stackdriver metrics API." |
| } |
| }, |
| "type": "object" |
| }, |
| "DroppedLabels": { |
| "description": "A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.", |
| "id": "DroppedLabels", |
| "properties": { |
| "label": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Map from label to its value, for all labels dropped in any aggregation.", |
| "type": "object" |
| } |
| }, |
| "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", |
| "id": "Empty", |
| "properties": {}, |
| "type": "object" |
| }, |
| "Field": { |
| "description": "A single field of a message type.", |
| "id": "Field", |
| "properties": { |
| "cardinality": { |
| "description": "The field cardinality.", |
| "enum": [ |
| "CARDINALITY_UNKNOWN", |
| "CARDINALITY_OPTIONAL", |
| "CARDINALITY_REQUIRED", |
| "CARDINALITY_REPEATED" |
| ], |
| "enumDescriptions": [ |
| "For fields with unknown cardinality.", |
| "For optional fields.", |
| "For required fields. Proto2 syntax only.", |
| "For repeated fields." |
| ], |
| "type": "string" |
| }, |
| "defaultValue": { |
| "description": "The string value of the default value of this field. Proto2 syntax only.", |
| "type": "string" |
| }, |
| "jsonName": { |
| "description": "The field JSON name.", |
| "type": "string" |
| }, |
| "kind": { |
| "description": "The field type.", |
| "enum": [ |
| "TYPE_UNKNOWN", |
| "TYPE_DOUBLE", |
| "TYPE_FLOAT", |
| "TYPE_INT64", |
| "TYPE_UINT64", |
| "TYPE_INT32", |
| "TYPE_FIXED64", |
| "TYPE_FIXED32", |
| "TYPE_BOOL", |
| "TYPE_STRING", |
| "TYPE_GROUP", |
| "TYPE_MESSAGE", |
| "TYPE_BYTES", |
| "TYPE_UINT32", |
| "TYPE_ENUM", |
| "TYPE_SFIXED32", |
| "TYPE_SFIXED64", |
| "TYPE_SINT32", |
| "TYPE_SINT64" |
| ], |
| "enumDescriptions": [ |
| "Field type unknown.", |
| "Field type double.", |
| "Field type float.", |
| "Field type int64.", |
| "Field type uint64.", |
| "Field type int32.", |
| "Field type fixed64.", |
| "Field type fixed32.", |
| "Field type bool.", |
| "Field type string.", |
| "Field type group. Proto2 syntax only, and deprecated.", |
| "Field type message.", |
| "Field type bytes.", |
| "Field type uint32.", |
| "Field type enum.", |
| "Field type sfixed32.", |
| "Field type sfixed64.", |
| "Field type sint32.", |
| "Field type sint64." |
| ], |
| "type": "string" |
| }, |
| "name": { |
| "description": "The field name.", |
| "type": "string" |
| }, |
| "number": { |
| "description": "The field number.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "oneofIndex": { |
| "description": "The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "options": { |
| "description": "The protocol buffer options.", |
| "items": { |
| "$ref": "Option" |
| }, |
| "type": "array" |
| }, |
| "packed": { |
| "description": "Whether to use alternative packed wire representation.", |
| "type": "boolean" |
| }, |
| "typeUrl": { |
| "description": "The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GaugeView": { |
| "description": "A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).", |
| "id": "GaugeView", |
| "properties": { |
| "lowerBound": { |
| "description": "The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this.", |
| "format": "double", |
| "type": "number" |
| }, |
| "upperBound": { |
| "description": "The upper bound for this gauge chart. The value of the chart should always be less than or equal to this.", |
| "format": "double", |
| "type": "number" |
| } |
| }, |
| "type": "object" |
| }, |
| "GridLayout": { |
| "description": "A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.", |
| "id": "GridLayout", |
| "properties": { |
| "columns": { |
| "description": "The number of columns into which the view's width is divided. If omitted or set to zero, a system default will be used while rendering.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "widgets": { |
| "description": "The informational elements that are arranged into the columns row-first.", |
| "items": { |
| "$ref": "Widget" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "ListDashboardsResponse": { |
| "description": "The ListDashboards request.", |
| "id": "ListDashboardsResponse", |
| "properties": { |
| "dashboards": { |
| "description": "The list of requested dashboards.", |
| "items": { |
| "$ref": "Dashboard" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Option": { |
| "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", |
| "id": "Option", |
| "properties": { |
| "name": { |
| "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".", |
| "type": "string" |
| }, |
| "value": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "PickTimeSeriesFilter": { |
| "description": "Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter lets through up to num_time_series time series, selecting them based on the relative ranking.", |
| "id": "PickTimeSeriesFilter", |
| "properties": { |
| "direction": { |
| "description": "How to use the ranking to select time series that pass through the filter.", |
| "enum": [ |
| "DIRECTION_UNSPECIFIED", |
| "TOP", |
| "BOTTOM" |
| ], |
| "enumDescriptions": [ |
| "Not allowed in well-formed requests.", |
| "Pass the highest ranking inputs.", |
| "Pass the lowest ranking inputs." |
| ], |
| "type": "string" |
| }, |
| "numTimeSeries": { |
| "description": "How many time series to return.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "rankingMethod": { |
| "description": "rankingMethod is applied to each time series independently to produce the value which will be used to compare the time series to other time series.", |
| "enum": [ |
| "METHOD_UNSPECIFIED", |
| "METHOD_MEAN", |
| "METHOD_MAX", |
| "METHOD_MIN", |
| "METHOD_SUM", |
| "METHOD_LATEST" |
| ], |
| "enumDescriptions": [ |
| "Not allowed in well-formed requests.", |
| "Select the mean of all values.", |
| "Select the maximum value.", |
| "Select the minimum value.", |
| "Compute the sum of all values.", |
| "Select the most recent value." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "RatioPart": { |
| "description": "Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio.", |
| "id": "RatioPart", |
| "properties": { |
| "aggregation": { |
| "$ref": "Aggregation", |
| "description": "By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data." |
| }, |
| "filter": { |
| "description": "Required. The monitoring filter that identifies the metric types, resources, and projects to query.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Row": { |
| "description": "Defines the layout properties and content for a row.", |
| "id": "Row", |
| "properties": { |
| "weight": { |
| "description": "The relative weight of this row. The row weight is used to adjust the height of rows on the screen (relative to peers). Greater the weight, greater the height of the row on the screen. If omitted, a value of 1 is used while rendering.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "widgets": { |
| "description": "The display widgets arranged horizontally in this row.", |
| "items": { |
| "$ref": "Widget" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "RowLayout": { |
| "description": "A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.", |
| "id": "RowLayout", |
| "properties": { |
| "rows": { |
| "description": "The rows of content to display.", |
| "items": { |
| "$ref": "Row" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "Scorecard": { |
| "description": "A widget showing the latest value of a metric, and how this value relates to one or more thresholds.", |
| "id": "Scorecard", |
| "properties": { |
| "gaugeView": { |
| "$ref": "GaugeView", |
| "description": "Will cause the scorecard to show a gauge chart." |
| }, |
| "sparkChartView": { |
| "$ref": "SparkChartView", |
| "description": "Will cause the scorecard to show a spark chart." |
| }, |
| "thresholds": { |
| "description": "The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', }Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.", |
| "items": { |
| "$ref": "Threshold" |
| }, |
| "type": "array" |
| }, |
| "timeSeriesQuery": { |
| "$ref": "TimeSeriesQuery", |
| "description": "Fields for querying time series data from the Stackdriver metrics API." |
| } |
| }, |
| "type": "object" |
| }, |
| "SourceContext": { |
| "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.", |
| "id": "SourceContext", |
| "properties": { |
| "fileName": { |
| "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "SpanContext": { |
| "description": "The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.It contains the name of a span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID", |
| "id": "SpanContext", |
| "properties": { |
| "spanName": { |
| "description": "The resource name of the span in the following format:\nprojects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]\nTRACE_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.SPAN_ID is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "SparkChartView": { |
| "description": "A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries.", |
| "id": "SparkChartView", |
| "properties": { |
| "minAlignmentPeriod": { |
| "description": "The lower bound on data point frequency in the chart 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 it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.", |
| "format": "google-duration", |
| "type": "string" |
| }, |
| "sparkChartType": { |
| "description": "The type of sparkchart to show in this chartView.", |
| "enum": [ |
| "SPARK_CHART_TYPE_UNSPECIFIED", |
| "SPARK_LINE", |
| "SPARK_BAR" |
| ], |
| "enumDescriptions": [ |
| "Not allowed in well-formed requests.", |
| "The sparkline will be rendered as a small line chart.", |
| "The sparkbar will be rendered as a small bar chart." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "StatisticalTimeSeriesFilter": { |
| "description": "A filter that ranks streams based on their statistical relation to other streams in a request.", |
| "id": "StatisticalTimeSeriesFilter", |
| "properties": { |
| "numTimeSeries": { |
| "description": "How many time series to output.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "rankingMethod": { |
| "description": "rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series.", |
| "enum": [ |
| "METHOD_UNSPECIFIED", |
| "METHOD_CLUSTER_OUTLIER" |
| ], |
| "enumDescriptions": [ |
| "Not allowed in well-formed requests.", |
| "Compute the outlier score of each stream." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Text": { |
| "description": "A widget that displays textual content.", |
| "id": "Text", |
| "properties": { |
| "content": { |
| "description": "The text content to be displayed.", |
| "type": "string" |
| }, |
| "format": { |
| "description": "How the text content is formatted.", |
| "enum": [ |
| "FORMAT_UNSPECIFIED", |
| "MARKDOWN", |
| "RAW" |
| ], |
| "enumDescriptions": [ |
| "Format is unspecified. Defaults to MARKDOWN.", |
| "The text contains Markdown formatting.", |
| "The text contains no special formatting." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Threshold": { |
| "description": "Defines a threshold for categorizing time series values.", |
| "id": "Threshold", |
| "properties": { |
| "color": { |
| "description": "The state color for this threshold. Color is not allowed in a XyChart.", |
| "enum": [ |
| "COLOR_UNSPECIFIED", |
| "YELLOW", |
| "RED" |
| ], |
| "enumDescriptions": [ |
| "Color is unspecified. Not allowed in well-formed requests.", |
| "Crossing the threshold is \"concerning\" behavior.", |
| "Crossing the threshold is \"emergency\" behavior." |
| ], |
| "type": "string" |
| }, |
| "direction": { |
| "description": "The direction for the current threshold. Direction is not allowed in a XyChart.", |
| "enum": [ |
| "DIRECTION_UNSPECIFIED", |
| "ABOVE", |
| "BELOW" |
| ], |
| "enumDescriptions": [ |
| "Not allowed in well-formed requests.", |
| "The threshold will be considered crossed if the actual value is above the threshold value.", |
| "The threshold will be considered crossed if the actual value is below the threshold value." |
| ], |
| "type": "string" |
| }, |
| "label": { |
| "description": "A label for the threshold.", |
| "type": "string" |
| }, |
| "value": { |
| "description": "The value of the threshold. The value should be defined in the native scale of the metric.", |
| "format": "double", |
| "type": "number" |
| } |
| }, |
| "type": "object" |
| }, |
| "TimeSeriesFilter": { |
| "description": "A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries method.", |
| "id": "TimeSeriesFilter", |
| "properties": { |
| "aggregation": { |
| "$ref": "Aggregation", |
| "description": "By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data." |
| }, |
| "filter": { |
| "description": "Required. The monitoring filter that identifies the metric types, resources, and projects to query.", |
| "type": "string" |
| }, |
| "pickTimeSeriesFilter": { |
| "$ref": "PickTimeSeriesFilter", |
| "description": "Ranking based time series filter." |
| }, |
| "statisticalTimeSeriesFilter": { |
| "$ref": "StatisticalTimeSeriesFilter", |
| "description": "Statistics based time series filter." |
| } |
| }, |
| "type": "object" |
| }, |
| "TimeSeriesFilterRatio": { |
| "description": "A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series.", |
| "id": "TimeSeriesFilterRatio", |
| "properties": { |
| "denominator": { |
| "$ref": "RatioPart", |
| "description": "The denominator of the ratio." |
| }, |
| "numerator": { |
| "$ref": "RatioPart", |
| "description": "The numerator of the ratio." |
| }, |
| "pickTimeSeriesFilter": { |
| "$ref": "PickTimeSeriesFilter", |
| "description": "Ranking based time series filter." |
| }, |
| "secondaryAggregation": { |
| "$ref": "Aggregation", |
| "description": "Apply a second aggregation after the ratio is computed." |
| }, |
| "statisticalTimeSeriesFilter": { |
| "$ref": "StatisticalTimeSeriesFilter", |
| "description": "Statistics based time series filter." |
| } |
| }, |
| "type": "object" |
| }, |
| "TimeSeriesQuery": { |
| "description": "TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.", |
| "id": "TimeSeriesQuery", |
| "properties": { |
| "timeSeriesFilter": { |
| "$ref": "TimeSeriesFilter", |
| "description": "Filter parameters to fetch time series." |
| }, |
| "timeSeriesFilterRatio": { |
| "$ref": "TimeSeriesFilterRatio", |
| "description": "Parameters to fetch a ratio between two time series filters." |
| }, |
| "unitOverride": { |
| "description": "The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Type": { |
| "description": "A protocol buffer message type.", |
| "id": "Type", |
| "properties": { |
| "fields": { |
| "description": "The list of fields.", |
| "items": { |
| "$ref": "Field" |
| }, |
| "type": "array" |
| }, |
| "name": { |
| "description": "The fully qualified message name.", |
| "type": "string" |
| }, |
| "oneofs": { |
| "description": "The list of types appearing in oneof definitions in this type.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "options": { |
| "description": "The protocol buffer options.", |
| "items": { |
| "$ref": "Option" |
| }, |
| "type": "array" |
| }, |
| "sourceContext": { |
| "$ref": "SourceContext", |
| "description": "The source context." |
| }, |
| "syntax": { |
| "description": "The source syntax.", |
| "enum": [ |
| "SYNTAX_PROTO2", |
| "SYNTAX_PROTO3" |
| ], |
| "enumDescriptions": [ |
| "Syntax proto2.", |
| "Syntax proto3." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Widget": { |
| "description": "Widget contains a single dashboard component and configuration of how to present the component in the dashboard.", |
| "id": "Widget", |
| "properties": { |
| "blank": { |
| "$ref": "Empty", |
| "description": "A blank space." |
| }, |
| "scorecard": { |
| "$ref": "Scorecard", |
| "description": "A scorecard summarizing time series data." |
| }, |
| "text": { |
| "$ref": "Text", |
| "description": "A raw string or markdown displaying textual content." |
| }, |
| "title": { |
| "description": "Optional. The title of the widget.", |
| "type": "string" |
| }, |
| "xyChart": { |
| "$ref": "XyChart", |
| "description": "A chart of time series data." |
| } |
| }, |
| "type": "object" |
| }, |
| "XyChart": { |
| "description": "A chart that displays data on a 2D (X and Y axes) plane.", |
| "id": "XyChart", |
| "properties": { |
| "chartOptions": { |
| "$ref": "ChartOptions", |
| "description": "Display options for the chart." |
| }, |
| "dataSets": { |
| "description": "The data displayed in this chart.", |
| "items": { |
| "$ref": "DataSet" |
| }, |
| "type": "array" |
| }, |
| "thresholds": { |
| "description": "Threshold lines drawn horizontally across the chart.", |
| "items": { |
| "$ref": "Threshold" |
| }, |
| "type": "array" |
| }, |
| "timeshiftDuration": { |
| "description": "The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type.", |
| "format": "google-duration", |
| "type": "string" |
| }, |
| "xAxis": { |
| "$ref": "Axis", |
| "description": "The properties applied to the X axis." |
| }, |
| "yAxis": { |
| "$ref": "Axis", |
| "description": "The properties applied to the Y axis." |
| } |
| }, |
| "type": "object" |
| } |
| }, |
| "servicePath": "", |
| "title": "Stackdriver Monitoring API", |
| "version": "v1", |
| "version_module": true |
| } |
