Debian Codegraph @

docs/dyn/datastream_v1.projects.locations.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="datastream_v1.html">Datastream API</a> . <a href="datastream_v1.projects.html">projects</a> . <a href="datastream_v1.projects.locations.html">locations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="datastream_v1.projects.locations.connectionProfiles.html">connectionProfiles()</a></code>
79 </p>
80 <p class="firstline">Returns the connectionProfiles Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="datastream_v1.projects.locations.operations.html">operations()</a></code>
84 </p>
85 <p class="firstline">Returns the operations Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="datastream_v1.projects.locations.privateConnections.html">privateConnections()</a></code>
89 </p>
90 <p class="firstline">Returns the privateConnections Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="datastream_v1.projects.locations.streams.html">streams()</a></code>
94 </p>
95 <p class="firstline">Returns the streams Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="#close">close()</a></code></p>
99 <p class="firstline">Close httplib2 connections.</p>
100 <p class="toc_element">
101 <code><a href="#fetchStaticIps">fetchStaticIps(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
102 <p class="firstline">The FetchStaticIps API call exposes the static IP addresses used by Datastream.</p>
103 <p class="toc_element">
104 <code><a href="#fetchStaticIps_next">fetchStaticIps_next()</a></code></p>
105 <p class="firstline">Retrieves the next page of results.</p>
106 <p class="toc_element">
107 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
108 <p class="firstline">Gets information about a location.</p>
109 <p class="toc_element">
110 <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
111 <p class="firstline">Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.</p>
112 <p class="toc_element">
113 <code><a href="#list_next">list_next()</a></code></p>
114 <p class="firstline">Retrieves the next page of results.</p>
115 <h3>Method Details</h3>
116 <div class="method">
117 <code class="details" id="close">close()</code>
118 <pre>Close httplib2 connections.</pre>
119 </div>
120
121 <div class="method">
122 <code class="details" id="fetchStaticIps">fetchStaticIps(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
123 <pre>The FetchStaticIps API call exposes the static IP addresses used by Datastream.
124
125 Args:
126 name: string, Required. The resource name for the location for which static IPs should be returned. Must be in the format `projects/*/locations/*`. (required)
127 pageSize: integer, Optional. Maximum number of Ips to return, will likely not be specified.
128 pageToken: string, Optional. A page token, received from a previous `ListStaticIps` call. will likely not be specified.
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134 Returns:
135 An object of the form:
136
137 { # Response message for a &#x27;FetchStaticIps&#x27; response.
138 &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.
139 &quot;staticIps&quot;: [ # list of static ips by account
140 &quot;A String&quot;,
141 ],
142 }</pre>
143 </div>
144
145 <div class="method">
146 <code class="details" id="fetchStaticIps_next">fetchStaticIps_next()</code>
147 <pre>Retrieves the next page of results.
148
149 Args:
150 previous_request: The request for the previous page. (required)
151 previous_response: The response from the request for the previous page. (required)
152
153 Returns:
154 A request object that you can call &#x27;execute()&#x27; on to request the next
155 page. Returns None if there are no more items in the collection.
156 </pre>
157 </div>
158
159 <div class="method">
160 <code class="details" id="get">get(name, x__xgafv=None)</code>
161 <pre>Gets information about a location.
162
163 Args:
164 name: string, Resource name for the location. (required)
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170 Returns:
171 An object of the form:
172
173 { # A resource that represents a Google Cloud location.
174 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
175 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
176 &quot;a_key&quot;: &quot;A String&quot;,
177 },
178 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
179 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
180 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
181 },
182 &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;`
183 }</pre>
184 </div>
185
186 <div class="method">
187 <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
188 <pre>Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
189
190 Args:
191 name: string, The resource that owns the locations collection, if applicable. (required)
192 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
193 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).
194 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
195 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201 Returns:
202 An object of the form:
203
204 { # The response message for Locations.ListLocations.
205 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
206 { # A resource that represents a Google Cloud location.
207 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
208 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
209 &quot;a_key&quot;: &quot;A String&quot;,
210 },
211 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
212 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
213 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
214 },
215 &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;`
216 },
217 ],
218 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
219 }</pre>
220 </div>
221
222 <div class="method">
223 <code class="details" id="list_next">list_next()</code>
224 <pre>Retrieves the next page of results.
225
226 Args:
227 previous_request: The request for the previous page. (required)
228 previous_response: The response from the request for the previous page. (required)
229
230 Returns:
231 A request object that you can call &#x27;execute()&#x27; on to request the next
232 page. Returns None if there are no more items in the collection.
233 </pre>
234 </div>
235
236 </body></html>