1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analyticshub_v1.html">Analytics Hub API</a> . <a href="analyticshub_v1.projects.html">projects</a> . <a href="analyticshub_v1.projects.locations.html">locations</a> . <a href="analyticshub_v1.projects.locations.dataExchanges.html">dataExchanges</a> . <a href="analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html">queryTemplates</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Approves a query template.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, queryTemplateId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new QueryTemplate</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a query template.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a QueryTemplate</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all QueryTemplates in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing QueryTemplate</p>
<p class="toc_element">
<code><a href="#submit">submit(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submits a query template for approval.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
<pre>Approves a query template.
Args:
name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
body: object, The request body.
The object takes the form of:
{ # Message for approving a QueryTemplate.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, queryTemplateId=None, x__xgafv=None)</code>
<pre>Creates a new QueryTemplate
Args:
parent: string, Required. The parent resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myQueryTemplate`. (required)
body: object, The request body.
The object takes the form of:
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}
queryTemplateId: string, Required. The ID of the QueryTemplate to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a query template.
Args:
name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a QueryTemplate
Args:
name: string, Required. The parent resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all QueryTemplates in a given project and location.
Args:
parent: string, Required. The parent resource path of the QueryTemplates. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
pageSize: integer, Optional. The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Optional. Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to the list of QueryTemplates.
"nextPageToken": "A String", # A token to request the next page of results.
"queryTemplates": [ # The list of QueryTemplates.
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing QueryTemplate
Args:
name: string, Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` (required)
body: object, The request body.
The object takes the form of:
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}
updateMask: string, Optional. Field mask specifies the fields to update in the query template resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}</pre>
</div>
<div class="method">
<code class="details" id="submit">submit(name, body=None, x__xgafv=None)</code>
<pre>Submits a query template for approval.
Args:
name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
body: object, The request body.
The object takes the form of:
{ # Message for submitting a QueryTemplate.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
"createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
"description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
"displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the QueryTemplate.
"name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
"routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
"definitionBody": "A String", # Optional. The definition body of the routine.
"routineType": "A String", # Required. The type of routine.
},
"state": "A String", # Output only. The QueryTemplate lifecycle state.
"updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}</pre>
</div>
</body></html>
|
