blob: f6ab20ad0be41e6c369dad691331d2054cd723b7 [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="datafusion_v1beta1.html">Cloud Data Fusion API</a> . <a href="datafusion_v1beta1.projects.html">projects</a> . <a href="datafusion_v1beta1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="datafusion_v1beta1.projects.locations.instances.html">instances()</a></code>
79</p>
80<p class="firstline">Returns the instances Resource.</p>
81
82<p class="toc_element">
83 <code><a href="datafusion_v1beta1.projects.locations.operations.html">operations()</a></code>
84</p>
85<p class="firstline">Returns the operations Resource.</p>
86
87<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070088 <code><a href="datafusion_v1beta1.projects.locations.versions.html">versions()</a></code>
89</p>
90<p class="firstline">Returns the versions Resource.</p>
91
92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070093 <code><a href="#close">close()</a></code></p>
94<p class="firstline">Close httplib2 connections.</p>
95<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97<p class="firstline">Gets information about a location.</p>
98<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080099 <code><a href="#list">list(name, filter=None, includeUnrevealedLocations=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Lists information about the supported locations for this service.</p>
101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800104<p class="toc_element">
105 <code><a href="#removeIamPolicy">removeIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Remove IAM policy that is currently set on the given resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700107<h3>Method Details</h3>
108<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 <code class="details" id="get">get(name, x__xgafv=None)</code>
115 <pre>Gets information about a location.
116
117Args:
118 name: string, Resource name for the location. (required)
119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124Returns:
125 An object of the form:
126
127 { # A resource that represents Google Cloud Platform location.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
129 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
130 &quot;a_key&quot;: &quot;A String&quot;,
131 },
132 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
133 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
134 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
135 },
136 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
137}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700138</div>
139
140<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 <code class="details" id="list">list(name, filter=None, includeUnrevealedLocations=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700142 <pre>Lists information about the supported locations for this service.
143
144Args:
145 name: string, The resource that owns the locations collection, if applicable. (required)
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700146 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like &quot;displayName=tokyo&quot;, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800147 includeUnrevealedLocations: boolean, If true, the returned list will include locations which are not yet revealed.
yoshi-code-bota933dad2021-07-06 00:26:24 -0700148 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700149 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700154
155Returns:
156 An object of the form:
157
158 { # The response message for Locations.ListLocations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800159 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
160 { # A resource that represents Google Cloud Platform location.
161 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
162 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
163 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700164 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800165 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
166 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168 },
169 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
170 },
171 ],
172 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
173}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700174</div>
175
176<div class="method">
177 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
178 <pre>Retrieves the next page of results.
179
180Args:
181 previous_request: The request for the previous page. (required)
182 previous_response: The response from the request for the previous page. (required)
183
184Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700185 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700186 page. Returns None if there are no more items in the collection.
187 </pre>
188</div>
189
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800190<div class="method">
191 <code class="details" id="removeIamPolicy">removeIamPolicy(resource, body=None, x__xgafv=None)</code>
192 <pre>Remove IAM policy that is currently set on the given resource.
193
194Args:
195 resource: string, The resource on which IAM policy to be removed is attached to. (required)
196 body: object, The request body.
197 The object takes the form of:
198
199{ # Request message for RemoveIamPolicy method.
200}
201
202 x__xgafv: string, V1 error format.
203 Allowed values
204 1 - v1 error format
205 2 - v2 error format
206
207Returns:
208 An object of the form:
209
210 { # Response message for RemoveIamPolicy method.
211}</pre>
212</div>
213
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700214</body></html>