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"> 78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 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"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(project, zone, targetInstance, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified TargetInstance resource.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, zone, targetInstance, x__xgafv=None)</a></code></p> 91<p class="firstline">Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p> 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"> 96 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 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"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 107 <pre>Retrieves an aggregated list of target instances. 108 109Args: 110 project: string, Project ID for this request. (required) 111 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 112 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. 113 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`) 114 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 115 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. 116 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 117 x__xgafv: string, V1 error format. 118 Allowed values 119 1 - v1 error format 120 2 - v2 error format 121 122Returns: 123 An object of the form: 124 125 { 126 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 127 "items": { # A list of TargetInstance resources. 128 "a_key": { # Name of the scope containing this set of target instances. 129 "targetInstances": [ # A list of target instances contained in this scope. 130 { # Represents a Target Instance resource. 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. 131 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 132 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 133 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 134 "instance": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance 135 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. 136 "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. 137 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. 138 "network": "A String", # 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. 139 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 140 "zone": "A String", # [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. 141 }, 142 ], 143 "warning": { # Informational warning which replaces the list of addresses when the list is empty. 144 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 145 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 146 { 147 "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). 148 "value": "A String", # [Output Only] A warning data value corresponding to the key. 149 }, 150 ], 151 "message": "A String", # [Output Only] A human-readable description of the warning code. 152 }, 153 }, 154 }, 155 "kind": "compute#targetInstanceAggregatedList", # Type of resource. 156 "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. 157 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 158 "unreachables": [ # [Output Only] Unreachable resources. 159 "A String", 160 ], 161 "warning": { # [Output Only] Informational warning message. 162 "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. 163 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 164 { 165 "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). 166 "value": "A String", # [Output Only] A warning data value corresponding to the key. 167 }, 168 ], 169 "message": "A String", # [Output Only] A human-readable description of the warning code. 170 }, 171}</pre> 172</div> 173 174<div class="method"> 175 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 176 <pre>Retrieves the next page of results. 177 178Args: 179 previous_request: The request for the previous page. (required) 180 previous_response: The response from the request for the previous page. (required) 181 182Returns: 183 A request object that you can call 'execute()' on to request the next 184 page. Returns None if there are no more items in the collection. 185 </pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="close">close()</code> 190 <pre>Close httplib2 connections.</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="delete">delete(project, zone, targetInstance, requestId=None, x__xgafv=None)</code> 195 <pre>Deletes the specified TargetInstance resource. 196 197Args: 198 project: string, Project ID for this request. (required) 199 zone: string, Name of the zone scoping this request. (required) 200 targetInstance: string, Name of the TargetInstance resource to delete. (required) 201 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 202 x__xgafv: string, V1 error format. 203 Allowed values 204 1 - v1 error format 205 2 - v2 error format 206 207Returns: 208 An object of the form: 209 210 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 211 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 212 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 213 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 214 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 215 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 216 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 217 { 218 "code": "A String", # [Output Only] The error type identifier for this error. 219 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 220 "message": "A String", # [Output Only] An optional, human-readable error message. 221 }, 222 ], 223 }, 224 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 225 "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. 226 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 227 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 228 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 229 "name": "A String", # [Output Only] Name of the operation. 230 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 231 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 232 "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. 233 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 234 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 235 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 236 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 237 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 238 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 239 "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. 240 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 241 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 242 { 243 "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. 244 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 245 { 246 "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). 247 "value": "A String", # [Output Only] A warning data value corresponding to the key. 248 }, 249 ], 250 "message": "A String", # [Output Only] A human-readable description of the warning code. 251 }, 252 ], 253 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 254}</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="get">get(project, zone, targetInstance, x__xgafv=None)</code> 259 <pre>Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. 260 261Args: 262 project: string, Project ID for this request. (required) 263 zone: string, Name of the zone scoping this request. (required) 264 targetInstance: string, Name of the TargetInstance resource to return. (required) 265 x__xgafv: string, V1 error format. 266 Allowed values 267 1 - v1 error format 268 2 - v2 error format 269 270Returns: 271 An object of the form: 272 273 { # Represents a Target Instance resource. 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. 274 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 275 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 276 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 277 "instance": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance 278 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. 279 "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. 280 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. 281 "network": "A String", # 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. 282 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 283 "zone": "A String", # [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. 284}</pre> 285</div> 286 287<div class="method"> 288 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code> 289 <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request. 290 291Args: 292 project: string, Project ID for this request. (required) 293 zone: string, Name of the zone scoping this request. (required) 294 body: object, The request body. 295 The object takes the form of: 296 297{ # Represents a Target Instance resource. 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. 298 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 299 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 300 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 301 "instance": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance 302 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. 303 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 304 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. 305 "network": "A String", # 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. 306 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 307 "zone": "A String", # [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. 308} 309 310 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 311 x__xgafv: string, V1 error format. 312 Allowed values 313 1 - v1 error format 314 2 - v2 error format 315 316Returns: 317 An object of the form: 318 319 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 320 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 321 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 322 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 323 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 324 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 325 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 326 { 327 "code": "A String", # [Output Only] The error type identifier for this error. 328 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 329 "message": "A String", # [Output Only] An optional, human-readable error message. 330 }, 331 ], 332 }, 333 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 334 "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. 335 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 336 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 337 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 338 "name": "A String", # [Output Only] Name of the operation. 339 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 340 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 341 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 342 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 343 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 344 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 345 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 346 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 347 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 348 "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. 349 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 350 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 351 { 352 "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. 353 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 354 { 355 "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). 356 "value": "A String", # [Output Only] A warning data value corresponding to the key. 357 }, 358 ], 359 "message": "A String", # [Output Only] A human-readable description of the warning code. 360 }, 361 ], 362 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 363}</pre> 364</div> 365 366<div class="method"> 367 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 368 <pre>Retrieves a list of TargetInstance resources available to the specified project and zone. 369 370Args: 371 project: string, Project ID for this request. (required) 372 zone: string, Name of the zone scoping this request. (required) 373 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 374 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`) 375 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 376 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. 377 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 378 x__xgafv: string, V1 error format. 379 Allowed values 380 1 - v1 error format 381 2 - v2 error format 382 383Returns: 384 An object of the form: 385 386 { # Contains a list of TargetInstance resources. 387 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 388 "items": [ # A list of TargetInstance resources. 389 { # Represents a Target Instance resource. 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. 390 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 391 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 392 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 393 "instance": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance 394 "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. 395 "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. 396 "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. 397 "network": "A String", # 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. 398 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 399 "zone": "A String", # [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. 400 }, 401 ], 402 "kind": "compute#targetInstanceList", # Type of resource. 403 "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. 404 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 405 "warning": { # [Output Only] Informational warning message. 406 "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. 407 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 408 { 409 "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). 410 "value": "A String", # [Output Only] A warning data value corresponding to the key. 411 }, 412 ], 413 "message": "A String", # [Output Only] A human-readable description of the warning code. 414 }, 415}</pre> 416</div> 417 418<div class="method"> 419 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 420 <pre>Retrieves the next page of results. 421 422Args: 423 previous_request: The request for the previous page. (required) 424 previous_response: The response from the request for the previous page. (required) 425 426Returns: 427 A request object that you can call 'execute()' on to request the next 428 page. Returns None if there are no more items in the collection. 429 </pre> 430</div> 431 432<div class="method"> 433 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code> 434 <pre>Returns permissions that a caller has on the specified resource. 435 436Args: 437 project: string, Project ID for this request. (required) 438 zone: string, The name of the zone for this request. (required) 439 resource: string, Name or id of the resource for this request. (required) 440 body: object, The request body. 441 The object takes the form of: 442 443{ 444 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 445 "A String", 446 ], 447} 448 449 x__xgafv: string, V1 error format. 450 Allowed values 451 1 - v1 error format 452 2 - v2 error format 453 454Returns: 455 An object of the form: 456 457 { 458 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 459 "A String", 460 ], 461}</pre> 462</div> 463 464</body></html>