Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / compute_beta.targetInstances.html
blob: d2782e55d7e0a10b3948166dca11ee13d530329c [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.targetInstances.html">targetInstances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Retrieves an aggregated list of target instances.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]84 <code><a href="#close">close()</a></code></p>
85<p class="firstline">Close httplib2 connections.</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87 <code><a href="#delete">delete(project, zone, targetInstance, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88<p class="firstline">Deletes the specified TargetInstance resource.</p>
89<p class="toc_element">
90 <code><a href="#get">get(project, zone, targetInstance)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94<p class="firstline">Creates a TargetInstance resource in the specified project and zone using the data included in the request.</p>
95<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]96 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]97<p class="firstline">Retrieves a list of TargetInstance resources available to the specified project and zone.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]106 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]107 <pre>Retrieves an aggregated list of target instances.
108
109Args:
110 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]112
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]113For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]114
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]116
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 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`)
120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
121
122You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
123
124Currently, only sorting by `name` or `creationTimestamp desc` is supported.
125 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]126 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]127
128Returns:
129 An object of the form:
130
131 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
133 &quot;items&quot;: { # A list of TargetInstance resources.
134 &quot;a_key&quot;: { # Name of the scope containing this set of target instances.
135 &quot;targetInstances&quot;: [ # A list of target instances contained in this scope.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 { # Represents a Target Instance resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 #
138 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
139 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
140 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
141 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
142 &quot;instance&quot;: &quot;A String&quot;, # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
143 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
144 # - projects/project/zones/zone/instances/instance
145 # - zones/zone/instances/instance
146 &quot;kind&quot;: &quot;compute#targetInstance&quot;, # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
147 &quot;name&quot;: &quot;A String&quot;, # 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.
148 &quot;natPolicy&quot;: &quot;A String&quot;, # NAT option controlling how IPs are NAT&#x27;ed to the instance. Currently only NO_NAT (default value) is supported.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]149 &quot;network&quot;: &quot;A String&quot;, # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
151 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
152 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]153 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &quot;warning&quot;: { # Informational warning which replaces the list of addresses when the list is empty.
155 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
156 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
157 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]158 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;key&quot;: &quot;A String&quot;, # [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).
160 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]161 },
162 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]164 },
165 },
166 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 &quot;kind&quot;: &quot;compute#targetInstanceAggregatedList&quot;, # Type of resource.
168 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
169 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]170 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
171 &quot;A String&quot;,
172 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &quot;warning&quot;: { # [Output Only] Informational warning message.
174 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
175 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
176 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 &quot;key&quot;: &quot;A String&quot;, # [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).
179 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 },
181 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]184 }</pre>
185</div>
186
187<div class="method">
188 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
189 <pre>Retrieves the next page of results.
190
191Args:
192 previous_request: The request for the previous page. (required)
193 previous_response: The response from the request for the previous page. (required)
194
195Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]196 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]197 page. Returns None if there are no more items in the collection.
198 </pre>
199</div>
200
201<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]202 <code class="details" id="close">close()</code>
203 <pre>Close httplib2 connections.</pre>
204</div>
205
206<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 <code class="details" id="delete">delete(project, zone, targetInstance, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]208 <pre>Deletes the specified TargetInstance resource.
209
210Args:
211 project: string, Project ID for this request. (required)
212 zone: string, Name of the zone scoping this request. (required)
213 targetInstance: string, Name of the TargetInstance resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
215
216For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
217
218The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]219
220Returns:
221 An object of the form:
222
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 { # Represents an Operation resource.
224 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]225 # Google Compute Engine has three Operation resources:
226 #
227 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
228 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
230 #
231 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]232 # - For global operations, use the `globalOperations` resource.
233 # - For regional operations, use the `regionOperations` resource.
234 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]236 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]237 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
238 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
239 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
240 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
241 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
242 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]243 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]244 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
245 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
246 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]247 },
248 ],
249 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
251 &quot;httpErrorStatusCode&quot;: 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.
252 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
253 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
254 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
255 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
256 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
257 &quot;progress&quot;: 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.
258 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
259 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
260 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
261 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
262 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
263 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
264 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
265 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
266 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
267 {
268 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
269 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
270 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
271 {
272 &quot;key&quot;: &quot;A String&quot;, # [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).
273 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
274 },
275 ],
276 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
277 },
278 ],
279 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]280 }</pre>
281</div>
282
283<div class="method">
284 <code class="details" id="get">get(project, zone, targetInstance)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 <pre>Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]286
287Args:
288 project: string, Project ID for this request. (required)
289 zone: string, Name of the zone scoping this request. (required)
290 targetInstance: string, Name of the TargetInstance resource to return. (required)
291
292Returns:
293 An object of the form:
294
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 { # Represents a Target Instance resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 #
297 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
298 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
299 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
300 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
301 &quot;instance&quot;: &quot;A String&quot;, # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
302 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
303 # - projects/project/zones/zone/instances/instance
304 # - zones/zone/instances/instance
305 &quot;kind&quot;: &quot;compute#targetInstance&quot;, # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
306 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
307 &quot;natPolicy&quot;: &quot;A String&quot;, # NAT option controlling how IPs are NAT&#x27;ed to the instance. Currently only NO_NAT (default value) is supported.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]308 &quot;network&quot;: &quot;A String&quot;, # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]309 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
310 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
311 }</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]312</div>
313
314<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]315 <code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]316 <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
317
318Args:
319 project: string, Project ID for this request. (required)
320 zone: string, Name of the zone scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]321 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]322 The object takes the form of:
323
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324{ # Represents a Target Instance resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]325 #
326 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
327 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
328 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
329 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
330 &quot;instance&quot;: &quot;A String&quot;, # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
331 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
332 # - projects/project/zones/zone/instances/instance
333 # - zones/zone/instances/instance
334 &quot;kind&quot;: &quot;compute#targetInstance&quot;, # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
335 &quot;name&quot;: &quot;A String&quot;, # 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.
336 &quot;natPolicy&quot;: &quot;A String&quot;, # NAT option controlling how IPs are NAT&#x27;ed to the instance. Currently only NO_NAT (default value) is supported.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]337 &quot;network&quot;: &quot;A String&quot;, # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
339 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
340}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]341
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]342 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
343
344For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
345
346The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]347
348Returns:
349 An object of the form:
350
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351 { # Represents an Operation resource.
352 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]353 # Google Compute Engine has three Operation resources:
354 #
355 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
356 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
358 #
359 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]360 # - For global operations, use the `globalOperations` resource.
361 # - For regional operations, use the `regionOperations` resource.
362 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]364 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]365 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
366 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
367 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
368 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
369 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
370 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]371 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]372 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
373 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
374 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]375 },
376 ],
377 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]378 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
379 &quot;httpErrorStatusCode&quot;: 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.
380 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
381 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
382 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
383 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
384 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
385 &quot;progress&quot;: 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.
386 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
387 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
388 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
389 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
390 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
391 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
392 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
393 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
394 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
395 {
396 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
397 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
398 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
399 {
400 &quot;key&quot;: &quot;A String&quot;, # [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).
401 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
402 },
403 ],
404 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
405 },
406 ],
407 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]408 }</pre>
409</div>
410
411<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]412 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]413 <pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
414
415Args:
416 project: string, Project ID for this request. (required)
417 zone: string, Name of the zone scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]418 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]419
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]420For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]421
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]422You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]423
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]424To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
425 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`)
426 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
427
428You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
429
430Currently, only sorting by `name` or `creationTimestamp desc` is supported.
431 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]432 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]433
434Returns:
435 An object of the form:
436
437 { # Contains a list of TargetInstance resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]438 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
439 &quot;items&quot;: [ # A list of TargetInstance resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 { # Represents a Target Instance resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]441 #
442 # You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
443 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
444 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
445 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
446 &quot;instance&quot;: &quot;A String&quot;, # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
447 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
448 # - projects/project/zones/zone/instances/instance
449 # - zones/zone/instances/instance
450 &quot;kind&quot;: &quot;compute#targetInstance&quot;, # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
451 &quot;name&quot;: &quot;A String&quot;, # 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.
452 &quot;natPolicy&quot;: &quot;A String&quot;, # NAT option controlling how IPs are NAT&#x27;ed to the instance. Currently only NO_NAT (default value) is supported.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]453 &quot;network&quot;: &quot;A String&quot;, # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]454 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
455 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
456 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]457 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]458 &quot;kind&quot;: &quot;compute#targetInstanceList&quot;, # Type of resource.
459 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
460 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
461 &quot;warning&quot;: { # [Output Only] Informational warning message.
462 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
463 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
464 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]466 &quot;key&quot;: &quot;A String&quot;, # [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).
467 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]468 },
469 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]470 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]472 }</pre>
473</div>
474
475<div class="method">
476 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
477 <pre>Retrieves the next page of results.
478
479Args:
480 previous_request: The request for the previous page. (required)
481 previous_response: The response from the request for the previous page. (required)
482
483Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]484 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]485 page. Returns None if there are no more items in the collection.
486 </pre>
487</div>
488
489<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]490 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]491 <pre>Returns permissions that a caller has on the specified resource.
492
493Args:
494 project: string, Project ID for this request. (required)
495 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]497 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]498 The object takes the form of:
499
500{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]501 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
502 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]503 ],
504 }
505
506
507Returns:
508 An object of the form:
509
510 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]511 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
512 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]513 ],
514 }</pre>
515</div>
516
517</body></html>