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