Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / serviceregistry_alpha.endpoints.html
blob: fb47c39fe71b95797556770ed74bdf811d6f5eb5 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]75<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, endpoint)</a></code></p>
79<p class="firstline">Deletes an endpoint.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, endpoint)</a></code></p>
82<p class="firstline">Gets an endpoint.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates an endpoint.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Lists endpoints for a project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(project, endpoint, body)</a></code></p>
94<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(project, endpoint, body)</a></code></p>
97<p class="firstline">Updates an endpoint.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, endpoint)</code>
101 <pre>Deletes an endpoint.
102
103Args:
104 project: string, The project ID for this request. (required)
105 endpoint: string, The name of the endpoint for this request. (required)
106
107Returns:
108 An object of the form:
109
110 { # An Operation resource, used to manage asynchronous API requests.
111 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]112 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
114 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]115 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]117 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]118 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
119 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
120 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
121 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
122 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
123 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
124 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
125 {
126 "message": "A String", # [Output Only] A human-readable description of the warning code.
127 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
128 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
129 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
130 {
131 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]132 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]133 },
134 ],
135 },
136 ],
137 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
138 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
139 "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
140 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]141 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]142 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
143 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
144 {
145 "message": "A String", # [Output Only] An optional, human-readable error message.
146 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]147 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]148 },
149 ],
150 },
151 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
152 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]153 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="get">get(project, endpoint)</code>
159 <pre>Gets an endpoint.
160
161Args:
162 project: string, The project ID for this request. (required)
163 endpoint: string, The name of the endpoint for this request. (required)
164
165Returns:
166 An object of the form:
167
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]168 { # Next available tag: 13
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]169 "description": "A String", # An optional user-provided description of the endpoint.
170 "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]171 "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]172 "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
173 "A String",
174 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]175 "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176 },
177 "port": 42, # An optional user-provided port of the service represented by this endpoint.
178 "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
179 "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
180 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
181 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
182 "selfLink": "A String", # [Output Only] Self link for the endpoint.
183 "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
184 }</pre>
185</div>
186
187<div class="method">
188 <code class="details" id="insert">insert(project, body)</code>
189 <pre>Creates an endpoint.
190
191Args:
192 project: string, The project ID for this request. (required)
193 body: object, The request body. (required)
194 The object takes the form of:
195
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]196{ # Next available tag: 13
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "description": "A String", # An optional user-provided description of the endpoint.
198 "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]199 "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]200 "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
201 "A String",
202 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]203 "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]204 },
205 "port": 42, # An optional user-provided port of the service represented by this endpoint.
206 "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
207 "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
208 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
209 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
210 "selfLink": "A String", # [Output Only] Self link for the endpoint.
211 "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
212 }
213
214
215Returns:
216 An object of the form:
217
218 { # An Operation resource, used to manage asynchronous API requests.
219 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]220 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]221 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
222 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]223 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]224 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]225 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]226 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
227 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
228 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
229 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
230 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
231 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
232 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
233 {
234 "message": "A String", # [Output Only] A human-readable description of the warning code.
235 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
236 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
237 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
238 {
239 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]240 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]241 },
242 ],
243 },
244 ],
245 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
246 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
247 "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
248 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]249 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
251 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
252 {
253 "message": "A String", # [Output Only] An optional, human-readable error message.
254 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]255 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 },
257 ],
258 },
259 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
260 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]261 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]262 }</pre>
263</div>
264
265<div class="method">
266 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
267 <pre>Lists endpoints for a project.
268
269Args:
270 project: string, The project ID for this request. (required)
271 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
272
273You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
274
275Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]276 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]277 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
278 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
279
280The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
281
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]282For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]283
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]284Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]285
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]286The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]287
288Returns:
289 An object of the form:
290
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]291 { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]292 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
293 "endpoints": [ # The endpoints contained in this response.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]294 { # Next available tag: 13
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]295 "description": "A String", # An optional user-provided description of the endpoint.
296 "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]297 "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]298 "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
299 "A String",
300 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]301 "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]302 },
303 "port": 42, # An optional user-provided port of the service represented by this endpoint.
304 "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
305 "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
306 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
307 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
308 "selfLink": "A String", # [Output Only] Self link for the endpoint.
309 "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
310 },
311 ],
312 }</pre>
313</div>
314
315<div class="method">
316 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
317 <pre>Retrieves the next page of results.
318
319Args:
320 previous_request: The request for the previous page. (required)
321 previous_response: The response from the request for the previous page. (required)
322
323Returns:
324 A request object that you can call 'execute()' on to request the next
325 page. Returns None if there are no more items in the collection.
326 </pre>
327</div>
328
329<div class="method">
330 <code class="details" id="patch">patch(project, endpoint, body)</code>
331 <pre>Updates an endpoint. This method supports patch semantics.
332
333Args:
334 project: string, The project ID for this request. (required)
335 endpoint: string, The name of the endpoint for this request. (required)
336 body: object, The request body. (required)
337 The object takes the form of:
338
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]339{ # Next available tag: 13
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]340 "description": "A String", # An optional user-provided description of the endpoint.
341 "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]342 "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]343 "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
344 "A String",
345 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]346 "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]347 },
348 "port": 42, # An optional user-provided port of the service represented by this endpoint.
349 "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
350 "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
351 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
352 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
353 "selfLink": "A String", # [Output Only] Self link for the endpoint.
354 "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
355 }
356
357
358Returns:
359 An object of the form:
360
361 { # An Operation resource, used to manage asynchronous API requests.
362 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]363 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]364 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
365 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]366 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]367 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]368 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]369 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
370 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
371 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
372 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
373 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
374 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
375 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
376 {
377 "message": "A String", # [Output Only] A human-readable description of the warning code.
378 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
379 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
380 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
381 {
382 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]383 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]384 },
385 ],
386 },
387 ],
388 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
389 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
390 "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
391 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]392 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]393 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
394 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
395 {
396 "message": "A String", # [Output Only] An optional, human-readable error message.
397 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]398 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]399 },
400 ],
401 },
402 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
403 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]404 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]405 }</pre>
406</div>
407
408<div class="method">
409 <code class="details" id="update">update(project, endpoint, body)</code>
410 <pre>Updates an endpoint.
411
412Args:
413 project: string, The project ID for this request. (required)
414 endpoint: string, The name of the endpoint for this request. (required)
415 body: object, The request body. (required)
416 The object takes the form of:
417
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]418{ # Next available tag: 13
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]419 "description": "A String", # An optional user-provided description of the endpoint.
420 "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]421 "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]422 "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
423 "A String",
424 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]425 "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]426 },
427 "port": 42, # An optional user-provided port of the service represented by this endpoint.
428 "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
429 "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
430 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
431 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
432 "selfLink": "A String", # [Output Only] Self link for the endpoint.
433 "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
434 }
435
436
437Returns:
438 An object of the form:
439
440 { # An Operation resource, used to manage asynchronous API requests.
441 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]442 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]443 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
444 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]445 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]446 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]447 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]448 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
449 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
450 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
451 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
452 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
453 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
454 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
455 {
456 "message": "A String", # [Output Only] A human-readable description of the warning code.
457 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
458 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
459 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
460 {
461 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]462 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]463 },
464 ],
465 },
466 ],
467 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
468 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
469 "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
470 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]471 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]472 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
473 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
474 {
475 "message": "A String", # [Output Only] An optional, human-readable error message.
476 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]477 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]478 },
479 ],
480 },
481 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
482 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]483 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]484 }</pre>
485</div>
486
487</body></html>