blob: 7f4699c39249544568f771c9ab9823b54df477e0 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.locations.html">locations</a> . <a href="dataflow_v1b3.projects.locations.sql.html">sql</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070081 <code><a href="#validate">validate(projectId, location, query=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the given query parses correctly, and if able to look up schema information from DataCatalog, will validate that the query analyzes properly as well.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070090 <code class="details" id="validate">validate(projectId, location, query=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <pre>Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the given query parses correctly, and if able to look up schema information from DataCatalog, will validate that the query analyzes properly as well.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092
93Args:
94 projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070095 location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096 query: string, The sql query to validate.
97 x__xgafv: string, V1 error format.
98 Allowed values
99 1 - v1 error format
100 2 - v2 error format
101
102Returns:
103 An object of the form:
104
105 { # Response to the validation request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800106 &quot;errorMessage&quot;: &quot;A String&quot;, # Will be empty if validation succeeds.
107 &quot;queryInfo&quot;: { # Information about a validated query. # Information about the validated query. Not defined if validation fails.
108 &quot;queryProperty&quot;: [ # Includes an entry for each satisfied QueryProperty.
109 &quot;A String&quot;,
110 ],
111 },
112}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113</div>
114
115</body></html>