• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.targetTcpProxies.html">targetTcpProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(project, targetTcpProxy, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified TargetTcpProxy resource.</p>
80<p class="toc_element">
81  <code><a href="#get">get(project, targetTcpProxy)</a></code></p>
82<p class="firstline">Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
85<p class="firstline">Creates a TargetTcpProxy 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 TargetTcpProxy 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, targetTcpProxy, body, requestId=None)</a></code></p>
94<p class="firstline">Changes the BackendService for TargetTcpProxy.</p>
95<p class="toc_element">
96  <code><a href="#setProxyHeader">setProxyHeader(project, targetTcpProxy, body, requestId=None)</a></code></p>
97<p class="firstline">Changes the ProxyHeaderType for TargetTcpProxy.</p>
98<p class="toc_element">
99  <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="delete">delete(project, targetTcpProxy, requestId=None)</code>
104  <pre>Deletes the specified TargetTcpProxy resource.
105
106Args:
107  project: string, Project ID for this request. (required)
108  targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required)
109  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
110
111For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
112
113The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
114
115Returns:
116  An object of the form:
117
118    { # Represents an Operation resource.
119      #
120      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
121      #
122      # Operations can be global, regional or zonal.
123      # - For global operations, use the globalOperations resource.
124      # - For regional operations, use the regionOperations resource.
125      # - For zonal operations, use the zonalOperations resource.
126      #
127      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
128    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
129    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
130    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
131    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
132    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
133    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
134    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
135    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
136    "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.
137    "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.
138    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
139    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
140    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
141    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
142      {
143        "message": "A String", # [Output Only] A human-readable description of the warning code.
144        "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.
145        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
146            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
147          {
148            "value": "A String", # [Output Only] A warning data value corresponding to the key.
149            "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).
150          },
151        ],
152      },
153    ],
154    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
155    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
156    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
157    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
158    "name": "A String", # [Output Only] Name of the resource.
159    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
160    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
161      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
162        {
163          "message": "A String", # [Output Only] An optional, human-readable error message.
164          "code": "A String", # [Output Only] The error type identifier for this error.
165          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
166        },
167      ],
168    },
169    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
170    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
171    "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.
172  }</pre>
173</div>
174
175<div class="method">
176    <code class="details" id="get">get(project, targetTcpProxy)</code>
177  <pre>Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.
178
179Args:
180  project: string, Project ID for this request. (required)
181  targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required)
182
183Returns:
184  An object of the form:
185
186    { # A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==)
187      "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
188      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
189      "service": "A String", # URL to the BackendService resource.
190      "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.
191      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
192      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
193      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
194      "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.
195    }</pre>
196</div>
197
198<div class="method">
199    <code class="details" id="insert">insert(project, body, requestId=None)</code>
200  <pre>Creates a TargetTcpProxy resource in the specified project using the data included in the request.
201
202Args:
203  project: string, Project ID for this request. (required)
204  body: object, The request body. (required)
205    The object takes the form of:
206
207{ # A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==)
208    "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
209    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
210    "service": "A String", # URL to the BackendService resource.
211    "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.
212    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
213    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
214    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
215    "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.
216  }
217
218  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
219
220For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
221
222The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
223
224Returns:
225  An object of the form:
226
227    { # Represents an Operation resource.
228      #
229      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
230      #
231      # Operations can be global, regional or zonal.
232      # - For global operations, use the globalOperations resource.
233      # - For regional operations, use the regionOperations resource.
234      # - For zonal operations, use the zonalOperations resource.
235      #
236      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
237    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
238    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
239    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
240    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
241    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
242    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
243    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
244    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
245    "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.
246    "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.
247    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
248    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
249    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
250    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
251      {
252        "message": "A String", # [Output Only] A human-readable description of the warning code.
253        "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.
254        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
255            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
256          {
257            "value": "A String", # [Output Only] A warning data value corresponding to the key.
258            "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).
259          },
260        ],
261      },
262    ],
263    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
264    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
265    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
266    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
267    "name": "A String", # [Output Only] Name of the resource.
268    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
269    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
270      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
271        {
272          "message": "A String", # [Output Only] An optional, human-readable error message.
273          "code": "A String", # [Output Only] The error type identifier for this error.
274          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
275        },
276      ],
277    },
278    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
279    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
280    "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.
281  }</pre>
282</div>
283
284<div class="method">
285    <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
286  <pre>Retrieves the list of TargetTcpProxy resources available to the specified project.
287
288Args:
289  project: string, Project ID for this request. (required)
290  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
291
292You 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.
293
294Currently, only sorting by name or creationTimestamp desc is supported.
295  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. Acceptable values are 0 to 500, inclusive. (Default: 500)
296  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.
297  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
298
299For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
300
301You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
302
303To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
304
305Returns:
306  An object of the form:
307
308    { # Contains a list of TargetTcpProxy resources.
309    "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.
310    "kind": "compute#targetTcpProxyList", # Type of resource.
311    "items": [ # A list of TargetTcpProxy resources.
312      { # A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==)
313          "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
314          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
315          "service": "A String", # URL to the BackendService resource.
316          "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.
317          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
318          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
319          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
320          "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.
321        },
322    ],
323    "warning": { # [Output Only] Informational warning message.
324      "message": "A String", # [Output Only] A human-readable description of the warning code.
325      "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.
326      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
327          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
328        {
329          "value": "A String", # [Output Only] A warning data value corresponding to the key.
330          "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).
331        },
332      ],
333    },
334    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
335    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
336  }</pre>
337</div>
338
339<div class="method">
340    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
341  <pre>Retrieves the next page of results.
342
343Args:
344  previous_request: The request for the previous page. (required)
345  previous_response: The response from the request for the previous page. (required)
346
347Returns:
348  A request object that you can call 'execute()' on to request the next
349  page. Returns None if there are no more items in the collection.
350    </pre>
351</div>
352
353<div class="method">
354    <code class="details" id="setBackendService">setBackendService(project, targetTcpProxy, body, requestId=None)</code>
355  <pre>Changes the BackendService for TargetTcpProxy.
356
357Args:
358  project: string, Project ID for this request. (required)
359  targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required)
360  body: object, The request body. (required)
361    The object takes the form of:
362
363{
364    "service": "A String", # The URL of the new BackendService resource for the targetTcpProxy.
365  }
366
367  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
368
369For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
370
371The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
372
373Returns:
374  An object of the form:
375
376    { # Represents an Operation resource.
377      #
378      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
379      #
380      # Operations can be global, regional or zonal.
381      # - For global operations, use the globalOperations resource.
382      # - For regional operations, use the regionOperations resource.
383      # - For zonal operations, use the zonalOperations resource.
384      #
385      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
386    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
387    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
388    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
389    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
390    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
391    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
392    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
393    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
394    "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.
395    "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.
396    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
397    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
398    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
399    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
400      {
401        "message": "A String", # [Output Only] A human-readable description of the warning code.
402        "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.
403        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
404            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
405          {
406            "value": "A String", # [Output Only] A warning data value corresponding to the key.
407            "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).
408          },
409        ],
410      },
411    ],
412    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
413    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
414    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
415    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
416    "name": "A String", # [Output Only] Name of the resource.
417    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
418    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
419      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
420        {
421          "message": "A String", # [Output Only] An optional, human-readable error message.
422          "code": "A String", # [Output Only] The error type identifier for this error.
423          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
424        },
425      ],
426    },
427    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
428    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
429    "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.
430  }</pre>
431</div>
432
433<div class="method">
434    <code class="details" id="setProxyHeader">setProxyHeader(project, targetTcpProxy, body, requestId=None)</code>
435  <pre>Changes the ProxyHeaderType for TargetTcpProxy.
436
437Args:
438  project: string, Project ID for this request. (required)
439  targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required)
440  body: object, The request body. (required)
441    The object takes the form of:
442
443{
444    "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
445  }
446
447  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
448
449For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
450
451The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
452
453Returns:
454  An object of the form:
455
456    { # Represents an Operation resource.
457      #
458      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
459      #
460      # Operations can be global, regional or zonal.
461      # - For global operations, use the globalOperations resource.
462      # - For regional operations, use the regionOperations resource.
463      # - For zonal operations, use the zonalOperations resource.
464      #
465      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
466    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
467    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
468    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
469    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
470    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
471    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
472    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
473    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
474    "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.
475    "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.
476    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
477    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
478    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
479    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
480      {
481        "message": "A String", # [Output Only] A human-readable description of the warning code.
482        "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.
483        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
484            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
485          {
486            "value": "A String", # [Output Only] A warning data value corresponding to the key.
487            "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).
488          },
489        ],
490      },
491    ],
492    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
493    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
494    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
495    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
496    "name": "A String", # [Output Only] Name of the resource.
497    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
498    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
499      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
500        {
501          "message": "A String", # [Output Only] An optional, human-readable error message.
502          "code": "A String", # [Output Only] The error type identifier for this error.
503          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
504        },
505      ],
506    },
507    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
508    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
509    "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.
510  }</pre>
511</div>
512
513<div class="method">
514    <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
515  <pre>Returns permissions that a caller has on the specified resource.
516
517Args:
518  project: string, Project ID for this request. (required)
519  resource: string, Name or id of the resource for this request. (required)
520  body: object, The request body. (required)
521    The object takes the form of:
522
523{
524    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
525      "A String",
526    ],
527  }
528
529
530Returns:
531  An object of the form:
532
533    {
534    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
535      "A String",
536    ],
537  }</pre>
538</div>
539
540</body></html>