Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / datafusion_v1beta1.projects.locations.html
blob: 2e9ab847ef69624a2d0896224eec977761a2d041 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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 -0700[diff] [blame^]88 <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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
94<p class="firstline">Gets information about a location.</p>
95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]96 <code><a href="#list">list(name, pageToken=None, pageSize=None, filter=None, includeUnrevealedLocations=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Lists information about the supported locations for this service.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="get">get(name, x__xgafv=None)</code>
104 <pre>Gets information about a location.
105
106Args:
107 name: string, Resource name for the location. (required)
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 # location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]121 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 &quot;labels&quot;: { # Cross-service attributes for the location. For example
123 #
124 # {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
125 &quot;a_key&quot;: &quot;A String&quot;,
126 },
127 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations.
128 # For example: `&quot;projects/example-project/locations/us-east1&quot;`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]129 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
130 # For example, &quot;Tokyo&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 }</pre>
132</div>
133
134<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]135 <code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, includeUnrevealedLocations=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 <pre>Lists information about the supported locations for this service.
137
138Args:
139 name: string, The resource that owns the locations collection, if applicable. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]140 pageToken: string, The standard list page token.
141 pageSize: integer, The standard list page size.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]142 filter: string, The standard list filter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 includeUnrevealedLocations: boolean, If true, the returned list will include locations which are not yet
144revealed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149
150Returns:
151 An object of the form:
152
153 { # The response message for Locations.ListLocations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 # location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]160 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;labels&quot;: { # Cross-service attributes for the location. For example
162 #
163 # {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
164 &quot;a_key&quot;: &quot;A String&quot;,
165 },
166 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations.
167 # For example: `&quot;projects/example-project/locations/us-east1&quot;`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]168 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
169 # For example, &quot;Tokyo&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 },
171 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]172 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 }</pre>
174</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 -0700[diff] [blame]185 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 page. Returns None if there are no more items in the collection.
187 </pre>
188</div>
189
190</body></html>