Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / compute_beta.targetSslProxies.html
blob: 37b501925fc669bbf42d202aa2c22e9f623dfca0 [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_beta.html">Compute Engine API</a> . <a href="compute_beta.targetSslProxies.html">targetSslProxies</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, targetSslProxy)</a></code></p>
79<p class="firstline">Deletes the specified TargetSslProxy 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, 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>
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 TargetSslProxy 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 TargetSslProxy 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, targetSslProxy, body)</a></code></p>
94<p class="firstline">Changes the BackendService for TargetSslProxy.</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, 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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]104<h3>Method Details</h3>
105<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]106 <code class="details" id="delete">delete(project, targetSslProxy)</code>
107 <pre>Deletes the specified TargetSslProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108
109Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]110 project: string, Project ID for this request. (required)
111 targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]118 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]119 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]120 "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]121 "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]122 "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]123 "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]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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]145 "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]146 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147 "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]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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]153 "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]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]160 }</pre>
161</div>
162
163<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]166
167Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]168 project: string, Project ID for this request. (required)
169 targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170
171Returns:
172 An object of the form:
173
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]174 { # A TargetSslProxy resource. This resource defines an SSL proxy.
175 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
176 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
177 "service": "A String", # URL to the BackendService resource.
178 "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.
179 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
180 "A String",
181 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]182 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]183 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
184 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
185 "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]186 }</pre>
187</div>
188
189<div class="method">
190 <code class="details" id="insert">insert(project, body)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]191 <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]192
193Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]194 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]195 body: object, The request body. (required)
196 The object takes the form of:
197
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198{ # A TargetSslProxy resource. This resource defines an SSL proxy.
199 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
200 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
201 "service": "A String", # URL to the BackendService resource.
202 "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.
203 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
204 "A String",
205 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]206 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]207 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
208 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
209 "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]210 }
211
212
213Returns:
214 An object of the form:
215
216 { # An Operation resource, used to manage asynchronous API requests.
217 "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]218 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]219 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 "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]221 "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]222 "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]223 "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]224 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
225 "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.
226 "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.
227 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
228 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
229 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
230 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
231 {
232 "message": "A String", # [Output Only] A human-readable description of the warning code.
233 "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.
234 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
235 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
236 {
237 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]238 "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]239 },
240 ],
241 },
242 ],
243 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
244 "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]245 "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]246 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]247 "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]248 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
249 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
250 {
251 "message": "A String", # [Output Only] An optional, human-readable error message.
252 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]253 "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]254 },
255 ],
256 },
257 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
258 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]259 "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]260 }</pre>
261</div>
262
263<div class="method">
264 <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]265 <pre>Retrieves the list of TargetSslProxy resources available to the specified project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]266
267Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]268 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]269 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
270
271You 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.
272
273Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]274 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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]275 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.
276 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.
277
278The 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.
279
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]280For 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]281
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]282You 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]283
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]284To 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]285
286Returns:
287 An object of the form:
288
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]289 { # Contains a list of TargetSslProxy resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]290 "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]291 "items": [ # A list of TargetSslProxy resources.
292 { # A TargetSslProxy resource. This resource defines an SSL proxy.
293 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
294 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
295 "service": "A String", # URL to the BackendService resource.
296 "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.
297 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
298 "A String",
299 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]300 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]301 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
302 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
303 "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]304 },
305 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]306 "kind": "compute#targetSslProxyList", # Type of resource.
307 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
308 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]309 }</pre>
310</div>
311
312<div class="method">
313 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
314 <pre>Retrieves the next page of results.
315
316Args:
317 previous_request: The request for the previous page. (required)
318 previous_response: The response from the request for the previous page. (required)
319
320Returns:
321 A request object that you can call 'execute()' on to request the next
322 page. Returns None if there are no more items in the collection.
323 </pre>
324</div>
325
326<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]327 <code class="details" id="setBackendService">setBackendService(project, targetSslProxy, body)</code>
328 <pre>Changes the BackendService for TargetSslProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]329
330Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]331 project: string, Project ID for this request. (required)
332 targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]333 body: object, The request body. (required)
334 The object takes the form of:
335
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]336{
337 "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]338 }
339
340
341Returns:
342 An object of the form:
343
344 { # An Operation resource, used to manage asynchronous API requests.
345 "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]346 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]347 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]348 "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]349 "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]350 "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]351 "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]352 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
353 "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.
354 "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.
355 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
356 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
357 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
358 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
359 {
360 "message": "A String", # [Output Only] A human-readable description of the warning code.
361 "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.
362 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
363 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
364 {
365 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]366 "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]367 },
368 ],
369 },
370 ],
371 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
372 "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]373 "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]374 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]375 "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]376 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
377 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
378 {
379 "message": "A String", # [Output Only] An optional, human-readable error message.
380 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]381 "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]382 },
383 ],
384 },
385 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
386 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]387 "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]388 }</pre>
389</div>
390
391<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]392 <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body)</code>
393 <pre>Changes the ProxyHeaderType for TargetSslProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]394
395Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]396 project: string, Project ID for this request. (required)
397 targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]398 body: object, The request body. (required)
399 The object takes the form of:
400
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]401{
402 "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]403 }
404
405
406Returns:
407 An object of the form:
408
409 { # An Operation resource, used to manage asynchronous API requests.
410 "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]411 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]412 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]413 "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]414 "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]415 "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]416 "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]417 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
418 "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.
419 "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.
420 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
421 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
422 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
423 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
424 {
425 "message": "A String", # [Output Only] A human-readable description of the warning code.
426 "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.
427 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
428 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
429 {
430 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]431 "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]432 },
433 ],
434 },
435 ],
436 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
437 "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]438 "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]439 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]440 "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]441 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
442 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
443 {
444 "message": "A String", # [Output Only] An optional, human-readable error message.
445 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]446 "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]447 },
448 ],
449 },
450 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
451 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]452 "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]453 }</pre>
454</div>
455
456<div class="method">
457 <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body)</code>
458 <pre>Changes SslCertificates for TargetSslProxy.
459
460Args:
461 project: string, Project ID for this request. (required)
462 targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
463 body: object, The request body. (required)
464 The object takes the form of:
465
466{
467 "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
468 "A String",
469 ],
470 }
471
472
473Returns:
474 An object of the form:
475
476 { # An Operation resource, used to manage asynchronous API requests.
477 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
478 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]479 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]480 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
481 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
482 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
483 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
484 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
485 "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.
486 "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.
487 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
488 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
489 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
490 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
491 {
492 "message": "A String", # [Output Only] A human-readable description of the warning code.
493 "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.
494 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
495 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
496 {
497 "value": "A String", # [Output Only] A warning data value corresponding to the key.
498 "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).
499 },
500 ],
501 },
502 ],
503 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
504 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
505 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
506 "name": "A String", # [Output Only] Name of the resource.
507 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
508 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
509 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
510 {
511 "message": "A String", # [Output Only] An optional, human-readable error message.
512 "code": "A String", # [Output Only] The error type identifier for this error.
513 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
514 },
515 ],
516 },
517 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
518 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]519 "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]520 }</pre>
521</div>
522
523<div class="method">
524 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
525 <pre>Returns permissions that a caller has on the specified resource.
526
527Args:
528 project: string, Project ID for this request. (required)
529 resource: string, Name of the resource for this request. (required)
530 body: object, The request body. (required)
531 The object takes the form of:
532
533{
534 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
535 "A String",
536 ],
537 }
538
539
540Returns:
541 An object of the form:
542
543 {
544 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
545 "A String",
546 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]547 }</pre>
548</div>
549
550</body></html>