1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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="cloudmonitoring_v2beta2.html">Cloud Monitoring API</a> . <a href="cloudmonitoring_v2beta2.timeseriesDescriptors.html">timeseriesDescriptors</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#list">list(project, metric, youngest, count=None, timespan=None, aggregator=None, labels=None, window=None, pageToken=None, oldest=None)</a></code></p> 79 <p class="firstline">List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.</p> 80 <p class="toc_element"> 81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 82 <p class="firstline">Retrieves the next page of results.</p> 83 <h3>Method Details</h3> 84 <div class="method"> 85 <code class="details" id="list">list(project, metric, youngest, count=None, timespan=None, aggregator=None, labels=None, window=None, pageToken=None, oldest=None)</code> 86 <pre>List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken. 87 88 Args: 89 project: string, The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name. (required) 90 metric: string, Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count. (required) 91 youngest: string, End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp. (required) 92 count: integer, Maximum number of time series descriptors per page. Used for pagination. If not specified, count = 100. 93 timespan: string, Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units: 94 - s: second 95 - m: minute 96 - h: hour 97 - d: day 98 - w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead. 99 100 If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]. 101 aggregator: string, The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE. 102 Allowed values 103 max - 104 mean - 105 min - 106 sum - 107 labels: string, A collection of labels for the matching time series, which are represented as: 108 - key==value: key equals the value 109 - key=~value: key regex matches the value 110 - key!=value: key does not equal the value 111 - key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify: 112 label=cloud.googleapis.com%2Flocation=~us-central1.* (repeated) 113 window: string, The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units: 114 - m: minute 115 - h: hour 116 - d: day 117 - w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead. 118 pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results. 119 oldest: string, Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest] 120 121 Returns: 122 An object of the form: 123 124 { # The response of cloudmonitoring.timeseriesDescriptors.list 125 "nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set this value to the pageToken query parameter. 126 "youngest": "A String", # The youngest timestamp of the interval of this query, as an RFC 3339 string. 127 "kind": "cloudmonitoring#listTimeseriesDescriptorsResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesDescriptorsResponse". 128 "oldest": "A String", # The oldest timestamp of the interval of this query, as an RFC 3339 string. 129 "timeseries": [ # The returned time series descriptors. 130 { # TimeseriesDescriptor identifies a single time series. 131 "project": "A String", # The Developers Console project number to which this time series belongs. 132 "metric": "A String", # The name of the metric. 133 "labels": { # The label's name. 134 "a_key": "A String", # The label's name. 135 }, 136 }, 137 ], 138 }</pre> 139 </div> 140 141 <div class="method"> 142 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 143 <pre>Retrieves the next page of results. 144 145 Args: 146 previous_request: The request for the previous page. (required) 147 previous_response: The response from the request for the previous page. (required) 148 149 Returns: 150 A request object that you can call 'execute()' on to request the next 151 page. Returns None if there are no more items in the collection. 152 </pre> 153 </div> 154 155 </body></html>
