Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / compute_alpha.targetSslProxies.html
blob: 6568e02b5e7f4b0b35deeda7c4a9d16db3c07be1 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetSslProxies.html">targetSslProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, targetSslProxy)</a></code></p>
79<p class="firstline">Deletes the specified TargetSslProxy resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, targetSslProxy)</a></code></p>
82<p class="firstline">Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a TargetSslProxy resource in the specified project using the data included in the request.</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">Retrieves the list of TargetSslProxy resources available to the specified 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="#setBackendService">setBackendService(project, targetSslProxy, body)</a></code></p>
94<p class="firstline">Changes the BackendService for TargetSslProxy.</p>
95<p class="toc_element">
96 <code><a href="#setProxyHeader">setProxyHeader(project, targetSslProxy, body)</a></code></p>
97<p class="firstline">Changes the ProxyHeaderType for TargetSslProxy.</p>
98<p class="toc_element">
99 <code><a href="#setSslCertificates">setSslCertificates(project, targetSslProxy, body)</a></code></p>
100<p class="firstline">Changes SslCertificates for TargetSslProxy.</p>
101<p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="delete">delete(project, targetSslProxy)</code>
107 <pre>Deletes the specified TargetSslProxy resource.
108
109Args:
110 project: string, Project ID for this request. (required)
111 targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)
112
113Returns:
114 An object of the form:
115
116 { # An Operation resource, used to manage asynchronous API requests.
117 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
118 "clientOperationId": "A String", # [Output Only] Reserved for future use.
119 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
120 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
121 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
122 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
123 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
124 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
125 "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.
126 "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.
127 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
128 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
129 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
130 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
131 {
132 "message": "A String", # [Output Only] A human-readable description of the warning code.
133 "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.
134 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
135 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
136 {
137 "value": "A String", # [Output Only] A warning data value corresponding to the key.
138 "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).
139 },
140 ],
141 },
142 ],
143 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
144 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
145 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
146 "name": "A String", # [Output Only] Name of the resource.
147 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
148 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
149 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
150 {
151 "message": "A String", # [Output Only] An optional, human-readable error message.
152 "code": "A String", # [Output Only] The error type identifier for this error.
153 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
154 },
155 ],
156 },
157 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
158 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]159 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]160 }</pre>
161</div>
162
163<div class="method">
164 <code class="details" id="get">get(project, targetSslProxy)</code>
165 <pre>Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.
166
167Args:
168 project: string, Project ID for this request. (required)
169 targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)
170
171Returns:
172 An object of the form:
173
174 { # A TargetSslProxy resource. This resource defines an SSL proxy.
175 "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
176 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
177 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
178 "service": "A String", # URL to the BackendService resource.
179 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
180 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
181 "A String",
182 ],
183 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
184 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
185 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
186 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and 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.
187 }</pre>
188</div>
189
190<div class="method">
191 <code class="details" id="insert">insert(project, body)</code>
192 <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request.
193
194Args:
195 project: string, Project ID for this request. (required)
196 body: object, The request body. (required)
197 The object takes the form of:
198
199{ # A TargetSslProxy resource. This resource defines an SSL proxy.
200 "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
201 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
202 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
203 "service": "A String", # URL to the BackendService resource.
204 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
205 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
206 "A String",
207 ],
208 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
209 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
210 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
211 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and 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.
220 "clientOperationId": "A String", # [Output Only] Reserved for future use.
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.
223 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
224 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
225 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
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.
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).
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": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
248 "name": "A String", # [Output Only] Name of the resource.
249 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
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.
255 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
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 Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]261 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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>Retrieves the list of TargetSslProxy resources available to the specified project.
268
269Args:
270 project: string, 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.
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.
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
282For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
283
284You can 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.
285
286To filter on multiple expressions, provide 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.
287
288Returns:
289 An object of the form:
290
291 { # Contains a list of TargetSslProxy resources.
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 "items": [ # A list of TargetSslProxy resources.
294 { # A TargetSslProxy resource. This resource defines an SSL proxy.
295 "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
296 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
297 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
298 "service": "A String", # URL to the BackendService resource.
299 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
300 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
301 "A String",
302 ],
303 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
304 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
305 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
306 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and 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.
307 },
308 ],
309 "kind": "compute#targetSslProxyList", # Type of resource.
310 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
311 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
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="setBackendService">setBackendService(project, targetSslProxy, body)</code>
331 <pre>Changes the BackendService for TargetSslProxy.
332
333Args:
334 project: string, Project ID for this request. (required)
335 targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
336 body: object, The request body. (required)
337 The object takes the form of:
338
339{
340 "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
341 }
342
343
344Returns:
345 An object of the form:
346
347 { # An Operation resource, used to manage asynchronous API requests.
348 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
349 "clientOperationId": "A String", # [Output Only] Reserved for future use.
350 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
351 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
352 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
353 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
354 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
355 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
356 "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.
357 "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.
358 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
359 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
360 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
361 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
362 {
363 "message": "A String", # [Output Only] A human-readable description of the warning code.
364 "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.
365 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
366 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
367 {
368 "value": "A String", # [Output Only] A warning data value corresponding to the key.
369 "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).
370 },
371 ],
372 },
373 ],
374 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
375 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
376 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
377 "name": "A String", # [Output Only] Name of the resource.
378 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
379 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
380 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
381 {
382 "message": "A String", # [Output Only] An optional, human-readable error message.
383 "code": "A String", # [Output Only] The error type identifier for this error.
384 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
385 },
386 ],
387 },
388 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
389 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]390 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]391 }</pre>
392</div>
393
394<div class="method">
395 <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body)</code>
396 <pre>Changes the ProxyHeaderType for TargetSslProxy.
397
398Args:
399 project: string, Project ID for this request. (required)
400 targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
401 body: object, The request body. (required)
402 The object takes the form of:
403
404{
405 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
406 }
407
408
409Returns:
410 An object of the form:
411
412 { # An Operation resource, used to manage asynchronous API requests.
413 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
414 "clientOperationId": "A String", # [Output Only] Reserved for future use.
415 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
416 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
417 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
418 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
419 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
420 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
421 "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.
422 "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.
423 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
424 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
425 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
426 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
427 {
428 "message": "A String", # [Output Only] A human-readable description of the warning code.
429 "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.
430 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
431 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
432 {
433 "value": "A String", # [Output Only] A warning data value corresponding to the key.
434 "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).
435 },
436 ],
437 },
438 ],
439 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
440 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
441 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
442 "name": "A String", # [Output Only] Name of the resource.
443 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
444 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
445 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
446 {
447 "message": "A String", # [Output Only] An optional, human-readable error message.
448 "code": "A String", # [Output Only] The error type identifier for this error.
449 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
450 },
451 ],
452 },
453 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
454 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]455 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]456 }</pre>
457</div>
458
459<div class="method">
460 <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body)</code>
461 <pre>Changes SslCertificates for TargetSslProxy.
462
463Args:
464 project: string, Project ID for this request. (required)
465 targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
466 body: object, The request body. (required)
467 The object takes the form of:
468
469{
470 "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
471 "A String",
472 ],
473 }
474
475
476Returns:
477 An object of the form:
478
479 { # An Operation resource, used to manage asynchronous API requests.
480 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
481 "clientOperationId": "A String", # [Output Only] Reserved for future use.
482 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
483 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
484 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
485 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
486 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
487 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
488 "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.
489 "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.
490 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
491 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
492 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
493 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
494 {
495 "message": "A String", # [Output Only] A human-readable description of the warning code.
496 "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.
497 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
498 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
499 {
500 "value": "A String", # [Output Only] A warning data value corresponding to the key.
501 "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).
502 },
503 ],
504 },
505 ],
506 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
507 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
508 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
509 "name": "A String", # [Output Only] Name of the resource.
510 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
511 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
512 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
513 {
514 "message": "A String", # [Output Only] An optional, human-readable error message.
515 "code": "A String", # [Output Only] The error type identifier for this error.
516 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
517 },
518 ],
519 },
520 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
521 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]522 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]523 }</pre>
524</div>
525
526<div class="method">
527 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
528 <pre>Returns permissions that a caller has on the specified resource.
529
530Args:
531 project: string, Project ID for this request. (required)
532 resource: string, Name of the resource for this request. (required)
533 body: object, The request body. (required)
534 The object takes the form of:
535
536{
537 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
538 "A String",
539 ],
540 }
541
542
543Returns:
544 An object of the form:
545
546 {
547 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
548 "A String",
549 ],
550 }</pre>
551</div>
552
553</body></html>