Debian Codegraph @

docs/dyn/databasecenter_v1beta.organizations.html

raw
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="databasecenter_v1beta.html">Database Center API</a> . <a href="databasecenter_v1beta.organizations.html">organizations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregateQueryStats">aggregateQueryStats(parent, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">AggregateQueryStats provides database resource query execution statistics.</p>
80 <p class="toc_element">
81 <code><a href="#aggregateQueryStats_next">aggregateQueryStats_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="aggregateQueryStats">aggregateQueryStats(parent, body=None, x__xgafv=None)</code>
89 <pre>AggregateQueryStats provides database resource query execution statistics.
90
91 Args:
92 parent: string, Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the `parent`. The allowed values are: * projects/{PROJECT_ID} (e.g., &quot;projects/foo-bar&quot;) * projects/{PROJECT_NUMBER} (e.g., &quot;projects/12345678&quot;) * folders/{FOLDER_NUMBER} (e.g., &quot;folders/1234567&quot;) * organizations/{ORGANIZATION_NUMBER} (e.g., &quot;organizations/123456&quot;) (required)
93 body: object, The request body.
94 The object takes the form of:
95
96 { # AggregateQueryStatsRequest represents the input to the AggregateQueryStats method.
97 &quot;filter&quot;: &quot;A String&quot;, # Optional. The expression to filter resources. Supported fields are: `full_resource_name`, `resource_type`, `container`, `product.type`, `product.engine`, `product.version`, `location`, `labels`, `issues`, fields of availability_info, data_protection_info,&#x27;resource_name&#x27;, etc. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location=&quot;us-east1&quot;` Example: `container=&quot;projects/123&quot; OR container=&quot;projects/456&quot;` Example: `(container=&quot;projects/123&quot; OR container=&quot;projects/456&quot;) AND location=&quot;us-east1&quot;` Additional specific fields for query stats are: `metric_window`, `query_hash`, `normalized_query`. Example: `metric_window=&quot;LAST_ONE_DAY&quot;` (Possible values for `metric_window` are: `LAST_ONE_DAY`, `LAST_ONE_WEEK`, `LAST_TWO_WEEKS`) Example: `query_hash=&quot;12345678&quot;` Example: `normalized_query=&quot;SELECT * FROM table&quot;`
98 &quot;orderBy&quot;: &quot;A String&quot;, # Optional. The expression to order the results by. Example: `order_by=&quot;execution_count&quot;` Example: `order_by=&quot;execution_count desc&quot;` Supported order by fields are `execution_count`, `rows_processed`, `total_cpu_time`, `avg_cpu_time`.
99 &quot;pageSize&quot;: 42, # Optional. If unspecified, at most 100 query stats will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
100 &quot;pageToken&quot;: &quot;A String&quot;, # Optional. A page token, received from a previous `AggregateQueryStatsRequest` call. Provide this to retrieve the subsequent page. All parameters except page_token should match the parameters in the call that provided the page token.
101 }
102
103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108 Returns:
109 An object of the form:
110
111 { # The response message containing relevant query stats for database resources.
112 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
113 &quot;queryStats&quot;: [ # List of query stats where each group contains stats for resources having a particular combination of relevant query stats.
114 { # QueryStatsInfo contains the aggregated and detailed query stats for a particular combination of relevant query stats for queries having same normalized query.
115 &quot;aggregatedQueryStats&quot;: { # QueryStats contains the stats for a particular combination of query_hash, query_string and resource_type. # Aggregated query stats for the resources for same normalized query.
116 &quot;inefficientQueryInfo&quot;: { # Metadata about inefficient query signal info for a database resource. # Information about inefficient query.
117 &quot;database&quot;: &quot;A String&quot;, # Name of the database where index is required. For example, &quot;db1&quot;, which is the name of the database present in the instance.
118 &quot;impactedQueriesCount&quot;: &quot;A String&quot;, # Count of queries to be impacted if index is applied
119 &quot;sqlIndexStatement&quot;: &quot;A String&quot;, # SQL statement of the index. Based on the ddl type, this will be either CREATE INDEX or DROP INDEX.
120 &quot;storageCostBytes&quot;: &quot;A String&quot;, # Cost of additional disk usage in bytes
121 &quot;table&quot;: &quot;A String&quot;, # Name of the table where index is required
122 },
123 &quot;normalizedQuery&quot;: &quot;A String&quot;, # The query string is normalized query without any PII data.
124 &quot;queryHash&quot;: &quot;A String&quot;, # The query hash of the query.
125 &quot;queryMetrics&quot;: { # QueryMetrics contains the metrics related to the query execution. # Metrics related to the query performance.
126 &quot;avgCpuTime&quot;: &quot;A String&quot;, # The average execution period of the query across all runs.
127 &quot;executionCount&quot;: &quot;A String&quot;, # The number of times the query was executed.
128 &quot;metricsWindow&quot;: &quot;A String&quot;, # The window over which the metrics are aggregated.
129 &quot;rowsProcessed&quot;: &quot;A String&quot;, # The average number of rows processed by the query across all runs.
130 &quot;totalCpuTime&quot;: &quot;A String&quot;, # The total CPU time consumed by the query across all runs.
131 },
132 &quot;resourceIds&quot;: [ # The resource ids for which the query stats are collected.
133 { # ResourceId contains the identifier for a database resource, including the full resource name, resource type, and product.
134 &quot;fullResourceName&quot;: &quot;A String&quot;, # The full resource name of the resource.
135 &quot;product&quot;: { # Product specification for databasecenter resources. # The product of the resource, including the type, engine, and version.
136 &quot;engine&quot;: &quot;A String&quot;, # Optional. The specific engine that the underlying database is running.
137 &quot;minorVersion&quot;: &quot;A String&quot;, # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be &quot;8.0.35&quot;, &quot;5.7.25&quot; etc. For PostgreSQL, it could be &quot;14.4&quot;, &quot;15.5&quot; etc.
138 &quot;type&quot;: &quot;A String&quot;, # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
139 &quot;version&quot;: &quot;A String&quot;, # Optional. Version of the underlying database engine. Example values: For MySQL, it could be &quot;8.0&quot;, &quot;5.7&quot; etc. For Postgres, it could be &quot;14&quot;, &quot;15&quot; etc.
140 },
141 &quot;resourceType&quot;: &quot;A String&quot;, # The type of the resource. sqladmin.googleapis.com/Instance alloydb.googleapis.com/Cluster alloydb.googleapis.com/Instance
142 },
143 ],
144 &quot;resourceType&quot;: &quot;A String&quot;, # The type of the resource. sqladmin.googleapis.com/Instance alloydb.googleapis.com/Cluster alloydb.googleapis.com/Instance
145 },
146 &quot;queryStats&quot;: [ # List of query stats for the resources in the group. This stats is stats at resource level for the resources having same normalized query.
147 { # QueryStats contains the stats for a particular combination of query_hash, query_string and resource_type.
148 &quot;inefficientQueryInfo&quot;: { # Metadata about inefficient query signal info for a database resource. # Information about inefficient query.
149 &quot;database&quot;: &quot;A String&quot;, # Name of the database where index is required. For example, &quot;db1&quot;, which is the name of the database present in the instance.
150 &quot;impactedQueriesCount&quot;: &quot;A String&quot;, # Count of queries to be impacted if index is applied
151 &quot;sqlIndexStatement&quot;: &quot;A String&quot;, # SQL statement of the index. Based on the ddl type, this will be either CREATE INDEX or DROP INDEX.
152 &quot;storageCostBytes&quot;: &quot;A String&quot;, # Cost of additional disk usage in bytes
153 &quot;table&quot;: &quot;A String&quot;, # Name of the table where index is required
154 },
155 &quot;normalizedQuery&quot;: &quot;A String&quot;, # The query string is normalized query without any PII data.
156 &quot;queryHash&quot;: &quot;A String&quot;, # The query hash of the query.
157 &quot;queryMetrics&quot;: { # QueryMetrics contains the metrics related to the query execution. # Metrics related to the query performance.
158 &quot;avgCpuTime&quot;: &quot;A String&quot;, # The average execution period of the query across all runs.
159 &quot;executionCount&quot;: &quot;A String&quot;, # The number of times the query was executed.
160 &quot;metricsWindow&quot;: &quot;A String&quot;, # The window over which the metrics are aggregated.
161 &quot;rowsProcessed&quot;: &quot;A String&quot;, # The average number of rows processed by the query across all runs.
162 &quot;totalCpuTime&quot;: &quot;A String&quot;, # The total CPU time consumed by the query across all runs.
163 },
164 &quot;resourceIds&quot;: [ # The resource ids for which the query stats are collected.
165 { # ResourceId contains the identifier for a database resource, including the full resource name, resource type, and product.
166 &quot;fullResourceName&quot;: &quot;A String&quot;, # The full resource name of the resource.
167 &quot;product&quot;: { # Product specification for databasecenter resources. # The product of the resource, including the type, engine, and version.
168 &quot;engine&quot;: &quot;A String&quot;, # Optional. The specific engine that the underlying database is running.
169 &quot;minorVersion&quot;: &quot;A String&quot;, # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be &quot;8.0.35&quot;, &quot;5.7.25&quot; etc. For PostgreSQL, it could be &quot;14.4&quot;, &quot;15.5&quot; etc.
170 &quot;type&quot;: &quot;A String&quot;, # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
171 &quot;version&quot;: &quot;A String&quot;, # Optional. Version of the underlying database engine. Example values: For MySQL, it could be &quot;8.0&quot;, &quot;5.7&quot; etc. For Postgres, it could be &quot;14&quot;, &quot;15&quot; etc.
172 },
173 &quot;resourceType&quot;: &quot;A String&quot;, # The type of the resource. sqladmin.googleapis.com/Instance alloydb.googleapis.com/Cluster alloydb.googleapis.com/Instance
174 },
175 ],
176 &quot;resourceType&quot;: &quot;A String&quot;, # The type of the resource. sqladmin.googleapis.com/Instance alloydb.googleapis.com/Cluster alloydb.googleapis.com/Instance
177 },
178 ],
179 },
180 ],
181 &quot;unreachable&quot;: [ # Unordered list. List of unreachable regions from where data could not be retrieved.
182 &quot;A String&quot;,
183 ],
184 }</pre>
185 </div>
186
187 <div class="method">
188 <code class="details" id="aggregateQueryStats_next">aggregateQueryStats_next()</code>
189 <pre>Retrieves the next page of results.
190
191 Args:
192 previous_request: The request for the previous page. (required)
193 previous_response: The response from the request for the previous page. (required)
194
195 Returns:
196 A request object that you can call &#x27;execute()&#x27; on to request the next
197 page. Returns None if there are no more items in the collection.
198 </pre>
199 </div>
200
201 <div class="method">
202 <code class="details" id="close">close()</code>
203 <pre>Close httplib2 connections.</pre>
204 </div>
205
206 </body></html>