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