Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 860a6378c538d8e2e424c7be150b41ba28120387 / . / docs / dyn / compute_alpha.targetTcpProxies.html
blob: 6b2b031e2d47506279b37f40903576c04a5a9d12 [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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetTcpProxies.html">targetTcpProxies</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]78 <code><a href="#delete">delete(project, targetTcpProxy)</a></code></p>
79<p class="firstline">Deletes the specified TargetTcpProxy resource.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]80<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]81 <code><a href="#get">get(project, targetTcpProxy)</a></code></p>
82<p class="firstline">Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Creates a TargetTcpProxy resource in the specified project using the data included in the request.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88<p class="firstline">Retrieves the list of TargetTcpProxy resources available to the specified project.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]93 <code><a href="#setBackendService">setBackendService(project, targetTcpProxy, body)</a></code></p>
94<p class="firstline">Changes the BackendService for TargetTcpProxy.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]95<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]96 <code><a href="#setProxyHeader">setProxyHeader(project, targetTcpProxy, body)</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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103 <code class="details" id="delete">delete(project, targetTcpProxy)</code>
104 <pre>Deletes the specified TargetTcpProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105
106Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]107 project: string, Project ID for this request. (required)
108 targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]109
110Returns:
111 An object of the form:
112
113 { # An Operation resource, used to manage asynchronous API requests.
114 "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]115 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]116 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
117 "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]118 "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]119 "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]120 "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]121 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
122 "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.
123 "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.
124 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
125 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
126 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
127 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
128 {
129 "message": "A String", # [Output Only] A human-readable description of the warning code.
130 "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.
131 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
132 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
133 {
134 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]135 "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]136 },
137 ],
138 },
139 ],
140 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
141 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]142 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]143 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]144 "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]145 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
146 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
147 {
148 "message": "A String", # [Output Only] An optional, human-readable error message.
149 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]150 "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]151 },
152 ],
153 },
154 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
155 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]156 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]157 }</pre>
158</div>
159
160<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]161 <code class="details" id="get">get(project, targetTcpProxy)</code>
162 <pre>Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163
164Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]165 project: string, Project ID for this request. (required)
166 targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]167
168Returns:
169 An object of the form:
170
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]171 { # A TargetTcpProxy resource. This resource defines a TCP proxy.
172 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
173 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
174 "service": "A String", # URL to the BackendService resource.
175 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]177 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
178 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
179 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]180 }</pre>
181</div>
182
183<div class="method">
184 <code class="details" id="insert">insert(project, body)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]185 <pre>Creates a TargetTcpProxy resource in the specified project using the data included in the request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]186
187Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]188 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]189 body: object, The request body. (required)
190 The object takes the form of:
191
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]192{ # A TargetTcpProxy resource. This resource defines a TCP proxy.
193 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
194 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
195 "service": "A String", # URL to the BackendService resource.
196 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
199 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
200 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]201 }
202
203
204Returns:
205 An object of the form:
206
207 { # An Operation resource, used to manage asynchronous API requests.
208 "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]209 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]210 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
211 "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]212 "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]213 "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]214 "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]215 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
216 "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.
217 "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.
218 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
219 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
220 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
221 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
222 {
223 "message": "A String", # [Output Only] A human-readable description of the warning code.
224 "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.
225 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
226 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
227 {
228 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]229 "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]230 },
231 ],
232 },
233 ],
234 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
235 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]236 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]237 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]238 "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]239 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
240 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
241 {
242 "message": "A String", # [Output Only] An optional, human-readable error message.
243 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]244 "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]245 },
246 ],
247 },
248 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
249 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]250 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]251 }</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]256 <pre>Retrieves the list of TargetTcpProxy resources available to the specified project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]257
258Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]259 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]260 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
261
262You 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.
263
264Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]265 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]266 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.
267 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.
268
269The 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.
270
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]271For 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]272
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]273You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]274
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]275To 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]276
277Returns:
278 An object of the form:
279
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]280 { # Contains a list of TargetTcpProxy resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]281 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]282 "items": [ # A list of TargetTcpProxy resources.
283 { # A TargetTcpProxy resource. This resource defines a TCP proxy.
284 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
285 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
286 "service": "A String", # URL to the BackendService resource.
287 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]288 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]289 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
290 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
291 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]292 },
293 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]294 "kind": "compute#targetTcpProxyList", # Type of resource.
295 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
296 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]297 }</pre>
298</div>
299
300<div class="method">
301 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
302 <pre>Retrieves the next page of results.
303
304Args:
305 previous_request: The request for the previous page. (required)
306 previous_response: The response from the request for the previous page. (required)
307
308Returns:
309 A request object that you can call 'execute()' on to request the next
310 page. Returns None if there are no more items in the collection.
311 </pre>
312</div>
313
314<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]315 <code class="details" id="setBackendService">setBackendService(project, targetTcpProxy, body)</code>
316 <pre>Changes the BackendService for TargetTcpProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]317
318Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]319 project: string, Project ID for this request. (required)
320 targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]321 body: object, The request body. (required)
322 The object takes the form of:
323
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]324{
325 "service": "A String", # The URL of the new BackendService resource for the targetTcpProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]326 }
327
328
329Returns:
330 An object of the form:
331
332 { # An Operation resource, used to manage asynchronous API requests.
333 "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]334 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]335 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
336 "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]337 "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]338 "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]339 "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]340 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
341 "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.
342 "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.
343 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
344 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
345 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
346 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
347 {
348 "message": "A String", # [Output Only] A human-readable description of the warning code.
349 "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.
350 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
351 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
352 {
353 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]354 "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]355 },
356 ],
357 },
358 ],
359 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
360 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]361 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]362 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]363 "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]364 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
365 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
366 {
367 "message": "A String", # [Output Only] An optional, human-readable error message.
368 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]369 "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]370 },
371 ],
372 },
373 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
374 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]375 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]376 }</pre>
377</div>
378
379<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]380 <code class="details" id="setProxyHeader">setProxyHeader(project, targetTcpProxy, body)</code>
381 <pre>Changes the ProxyHeaderType for TargetTcpProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]382
383Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]384 project: string, Project ID for this request. (required)
385 targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]386 body: object, The request body. (required)
387 The object takes the form of:
388
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]389{
390 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]391 }
392
393
394Returns:
395 An object of the form:
396
397 { # An Operation resource, used to manage asynchronous API requests.
398 "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]399 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]400 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
401 "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]402 "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]403 "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]404 "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]405 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
406 "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.
407 "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.
408 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
409 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
410 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
411 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
412 {
413 "message": "A String", # [Output Only] A human-readable description of the warning code.
414 "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.
415 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
416 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
417 {
418 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]419 "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]420 },
421 ],
422 },
423 ],
424 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
425 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]426 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]427 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]428 "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]429 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
430 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
431 {
432 "message": "A String", # [Output Only] An optional, human-readable error message.
433 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]434 "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]435 },
436 ],
437 },
438 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
439 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]440 "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]441 }</pre>
442</div>
443
444<div class="method">
445 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
446 <pre>Returns permissions that a caller has on the specified resource.
447
448Args:
449 project: string, Project ID for this request. (required)
450 resource: string, Name of the resource for this request. (required)
451 body: object, The request body. (required)
452 The object takes the form of:
453
454{
455 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
456 "A String",
457 ],
458 }
459
460
461Returns:
462 An object of the form:
463
464 {
465 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
466 "A String",
467 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]468 }</pre>
469</div>
470
471</body></html>