| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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_v1.html">Compute Engine API</a> . <a href="compute_v1.targetInstances.html">targetInstances</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-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> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 79 | <p class="firstline">Retrieves an aggregated list of target instances.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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 Frenkel | 3e17f89 | 2020-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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 87 | <code><a href="#delete">delete(project, zone, targetInstance, requestId=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [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 Kim | 715bd7f | 2019-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> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [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 Frenkel | 3e17f89 | 2020-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> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 97 | <p class="firstline">Retrieves a list of TargetInstance resources available to the specified project and zone.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 104 | <pre>Retrieves an aggregated list of target instances. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | |
| 106 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 107 | project: string, Project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | 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 `<`. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 109 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 111 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | 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. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 113 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | 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) ``` |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | 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`) |
| 117 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 118 | |
| 119 | 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. |
| 120 | |
| 121 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| 122 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 123 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 124 | |
| 125 | Returns: |
| 126 | An object of the form: |
| 127 | |
| 128 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 129 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 130 | "items": { # A list of TargetInstance resources. |
| 131 | "a_key": { # Name of the scope containing this set of target instances. |
| 132 | "targetInstances": [ # A list of target instances contained in this scope. |
| 133 | { # Represents a Target Instance resource. |
| 134 | # |
| 135 | # 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 ==) |
| 136 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 137 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 138 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 139 | "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: |
| 140 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance |
| 141 | # - projects/project/zones/zone/instances/instance |
| 142 | # - zones/zone/instances/instance |
| 143 | "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. |
| 144 | "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. |
| 145 | "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. |
| 146 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 147 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 148 | }, |
| 149 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 150 | "warning": { # Informational warning which replaces the list of addresses when the list is empty. |
| 151 | "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. |
| 152 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 153 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 154 | { |
| 155 | "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). |
| 156 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 157 | }, |
| 158 | ], |
| 159 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 160 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 161 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 162 | }, |
| 163 | "kind": "compute#targetInstanceAggregatedList", # Type of resource. |
| 164 | "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. |
| 165 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 166 | "unreachables": [ # [Output Only] Unreachable resources. |
| 167 | "A String", |
| 168 | ], |
| 169 | "warning": { # [Output Only] Informational warning message. |
| 170 | "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. |
| 171 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 172 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 173 | { |
| 174 | "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). |
| 175 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 176 | }, |
| 177 | ], |
| 178 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 179 | }, |
| 180 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 181 | </div> |
| 182 | |
| 183 | <div class="method"> |
| 184 | <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> |
| 185 | <pre>Retrieves the next page of results. |
| 186 | |
| 187 | Args: |
| 188 | previous_request: The request for the previous page. (required) |
| 189 | previous_response: The response from the request for the previous page. (required) |
| 190 | |
| 191 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 193 | page. Returns None if there are no more items in the collection. |
| 194 | </pre> |
| 195 | </div> |
| 196 | |
| 197 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 198 | <code class="details" id="close">close()</code> |
| 199 | <pre>Close httplib2 connections.</pre> |
| 200 | </div> |
| 201 | |
| 202 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 203 | <code class="details" id="delete">delete(project, zone, targetInstance, requestId=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 204 | <pre>Deletes the specified TargetInstance resource. |
| 205 | |
| 206 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 207 | project: string, Project ID for this request. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 208 | zone: string, Name of the zone scoping this request. (required) |
| 209 | targetInstance: string, Name of the TargetInstance resource to delete. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 210 | 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. |
| 211 | |
| 212 | 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. |
| 213 | |
| 214 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 215 | |
| 216 | Returns: |
| 217 | An object of the form: |
| 218 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 219 | { # Represents an Operation resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 220 | # |
| 221 | # Google Compute Engine has three Operation resources: |
| 222 | # |
| 223 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 224 | # |
| 225 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 226 | # |
| 227 | # Operations can be global, regional or zonal. |
| 228 | # - For global operations, use the `globalOperations` resource. |
| 229 | # - For regional operations, use the `regionOperations` resource. |
| 230 | # - For zonal operations, use the `zonalOperations` resource. |
| 231 | # |
| 232 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 233 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 234 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 235 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 236 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 237 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 238 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 239 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 240 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 241 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 242 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | }, |
| 244 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 245 | }, |
| 246 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 247 | "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. |
| 248 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 249 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 250 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 251 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 252 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 253 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 254 | "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. |
| 255 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 256 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 257 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 258 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 259 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 260 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 261 | "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. |
| 262 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 263 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 264 | { |
| 265 | "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. |
| 266 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 267 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 268 | { |
| 269 | "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). |
| 270 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 271 | }, |
| 272 | ], |
| 273 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 274 | }, |
| 275 | ], |
| 276 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 277 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 278 | </div> |
| 279 | |
| 280 | <div class="method"> |
| 281 | <code class="details" id="get">get(project, zone, targetInstance)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 282 | <pre>Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 283 | |
| 284 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 285 | project: string, Project ID for this request. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 286 | zone: string, Name of the zone scoping this request. (required) |
| 287 | targetInstance: string, Name of the TargetInstance resource to return. (required) |
| 288 | |
| 289 | Returns: |
| 290 | An object of the form: |
| 291 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 292 | { # Represents a Target Instance resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 293 | # |
| 294 | # 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 ==) |
| 295 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 296 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 297 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 298 | "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: |
| 299 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance |
| 300 | # - projects/project/zones/zone/instances/instance |
| 301 | # - 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 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 306 | "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. |
| 307 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 308 | </div> |
| 309 | |
| 310 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 311 | <code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 312 | <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request. |
| 313 | |
| 314 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 315 | project: string, Project ID for this request. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 316 | zone: string, Name of the zone scoping this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 317 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 318 | The object takes the form of: |
| 319 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 320 | { # Represents a Target Instance resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 321 | # |
| 322 | # 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 ==) |
| 323 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 324 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 325 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 326 | "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: |
| 327 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance |
| 328 | # - projects/project/zones/zone/instances/instance |
| 329 | # - zones/zone/instances/instance |
| 330 | "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. |
| 331 | "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. |
| 332 | "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. |
| 333 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 334 | "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. |
| 335 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 336 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 337 | 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. |
| 338 | |
| 339 | 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. |
| 340 | |
| 341 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 342 | |
| 343 | Returns: |
| 344 | An object of the form: |
| 345 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 346 | { # Represents an Operation resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 347 | # |
| 348 | # Google Compute Engine has three Operation resources: |
| 349 | # |
| 350 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 351 | # |
| 352 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 353 | # |
| 354 | # Operations can be global, regional or zonal. |
| 355 | # - For global operations, use the `globalOperations` resource. |
| 356 | # - For regional operations, use the `regionOperations` resource. |
| 357 | # - For zonal operations, use the `zonalOperations` resource. |
| 358 | # |
| 359 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 360 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 361 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 362 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 363 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 364 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 365 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 366 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 367 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 368 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 369 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 370 | }, |
| 371 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 372 | }, |
| 373 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 374 | "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. |
| 375 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 376 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 377 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 378 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 379 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 380 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 381 | "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. |
| 382 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 383 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 384 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 385 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 386 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 387 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 390 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 391 | { |
| 392 | "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. |
| 393 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 394 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 395 | { |
| 396 | "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). |
| 397 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 398 | }, |
| 399 | ], |
| 400 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 401 | }, |
| 402 | ], |
| 403 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 404 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 405 | </div> |
| 406 | |
| 407 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 408 | <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 409 | <pre>Retrieves a list of TargetInstance resources available to the specified project and zone. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 410 | |
| 411 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 412 | project: string, Project ID for this request. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 413 | zone: string, Name of the zone scoping this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 414 | 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 `<`. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 415 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 416 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 417 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 418 | 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. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 419 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 420 | 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) ``` |
| 421 | 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`) |
| 422 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 423 | |
| 424 | 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. |
| 425 | |
| 426 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| 427 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 428 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 429 | |
| 430 | Returns: |
| 431 | An object of the form: |
| 432 | |
| 433 | { # Contains a list of TargetInstance resources. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 434 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 435 | "items": [ # A list of TargetInstance resources. |
| 436 | { # Represents a Target Instance resource. |
| 437 | # |
| 438 | # 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 ==) |
| 439 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 440 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 441 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 442 | "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: |
| 443 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance |
| 444 | # - projects/project/zones/zone/instances/instance |
| 445 | # - zones/zone/instances/instance |
| 446 | "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. |
| 447 | "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. |
| 448 | "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. |
| 449 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 450 | "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. |
| 451 | }, |
| 452 | ], |
| 453 | "kind": "compute#targetInstanceList", # Type of resource. |
| 454 | "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. |
| 455 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 456 | "warning": { # [Output Only] Informational warning message. |
| 457 | "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. |
| 458 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 459 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 460 | { |
| 461 | "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). |
| 462 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 463 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 464 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 465 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 466 | }, |
| 467 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 468 | </div> |
| 469 | |
| 470 | <div class="method"> |
| 471 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 472 | <pre>Retrieves the next page of results. |
| 473 | |
| 474 | Args: |
| 475 | previous_request: The request for the previous page. (required) |
| 476 | previous_response: The response from the request for the previous page. (required) |
| 477 | |
| 478 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 479 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 480 | page. Returns None if there are no more items in the collection. |
| 481 | </pre> |
| 482 | </div> |
| 483 | |
| 484 | </body></html> |