1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="monitoring_v1.html">Cloud Monitoring API</a> . <a href="monitoring_v1.projects.html">projects</a> . <a href="monitoring_v1.projects.location.html">location</a> . <a href="monitoring_v1.projects.location.prometheus.html">prometheus</a> . <a href="monitoring_v1.projects.location.prometheus.api.html">api</a> . <a href="monitoring_v1.projects.location.prometheus.api.v1.html">v1</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="monitoring_v1.projects.location.prometheus.api.v1.label.html">label()</a></code> 79</p> 80<p class="firstline">Returns the label Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="monitoring_v1.projects.location.prometheus.api.v1.metadata.html">metadata()</a></code> 84</p> 85<p class="firstline">Returns the metadata Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#query">query(name, location, body=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Evaluate a PromQL query at a single point in time.</p> 93<p class="toc_element"> 94 <code><a href="#query_range">query_range(name, location, body=None, x__xgafv=None)</a></code></p> 95<p class="firstline">Evaluate a PromQL query with start, end time range.</p> 96<p class="toc_element"> 97 <code><a href="#series">series(name, location, body=None, x__xgafv=None)</a></code></p> 98<p class="firstline">Lists metadata for metrics.</p> 99<h3>Method Details</h3> 100<div class="method"> 101 <code class="details" id="close">close()</code> 102 <pre>Close httplib2 connections.</pre> 103</div> 104 105<div class="method"> 106 <code class="details" id="query">query(name, location, body=None, x__xgafv=None)</code> 107 <pre>Evaluate a PromQL query at a single point in time. 108 109Args: 110 name: string, 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. (required) 111 location: string, Location of the resource information. Has to be "global" now. (required) 112 body: object, The request body. 113 The object takes the form of: 114 115{ # QueryInstantRequest holds all parameters of the Prometheus upstream instant query API plus GCM specific parameters. 116 "query": "A String", # A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/. 117 "time": "A String", # The single point in time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. 118 "timeout": "A String", # 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. 119} 120 121 x__xgafv: string, V1 error format. 122 Allowed values 123 1 - v1 error format 124 2 - v2 error format 125 126Returns: 127 An object of the form: 128 129 { # 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. 130 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 131 "data": "A String", # The HTTP request/response body as raw binary. 132 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 133 { 134 "a_key": "", # Properties of the object. Contains field @type with type URL. 135 }, 136 ], 137}</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="query_range">query_range(name, location, body=None, x__xgafv=None)</code> 142 <pre>Evaluate a PromQL query with start, end time range. 143 144Args: 145 name: string, 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. (required) 146 location: string, Location of the resource information. Has to be "global" now. (required) 147 body: object, The request body. 148 The object takes the form of: 149 150{ # QueryRangeRequest holds all parameters of the Prometheus upstream range query API plus GCM specific parameters. 151 "end": "A String", # The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. 152 "query": "A String", # A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/. 153 "start": "A String", # The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. 154 "step": "A String", # 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. 155 "timeout": "A String", # 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. 156} 157 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # 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. 167 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 168 "data": "A String", # The HTTP request/response body as raw binary. 169 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 170 { 171 "a_key": "", # Properties of the object. Contains field @type with type URL. 172 }, 173 ], 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="series">series(name, location, body=None, x__xgafv=None)</code> 179 <pre>Lists metadata for metrics. 180 181Args: 182 name: string, 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. (required) 183 location: string, Location of the resource information. Has to be "global" for now. (required) 184 body: object, The request body. 185 The object takes the form of: 186 187{ # QuerySeries holds all parameters of the Prometheus upstream API for querying series. 188 "end": "A String", # The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. 189 "start": "A String", # The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. 190} 191 192 x__xgafv: string, V1 error format. 193 Allowed values 194 1 - v1 error format 195 2 - v2 error format 196 197Returns: 198 An object of the form: 199 200 { # 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. 201 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 202 "data": "A String", # The HTTP request/response body as raw binary. 203 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 204 { 205 "a_key": "", # Properties of the object. Contains field @type with type URL. 206 }, 207 ], 208}</pre> 209</div> 210 211</body></html>