| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetHttpProxies.html">targetHttpProxies</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <p class="toc_element"> |
| Dmitry 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"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 87 | <code><a href="#delete">delete(project, targetHttpProxy, requestId=None)</a></code></p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 88 | <p class="firstline">Deletes the specified TargetHttpProxy resource.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#get">get(project, targetHttpProxy)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.</p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [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, body=None, requestId=None)</a></code></p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 94 | <p class="firstline">Creates a TargetHttpProxy resource in the specified project using the data included in the request.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 96 | <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 97 | <p class="firstline">Retrieves the list of TargetHttpProxy resources available to the specified project.</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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 102 | <code><a href="#patch">patch(project, targetHttpProxy, body=None, requestId=None)</a></code></p> |
| 103 | <p class="firstline">Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)</p> |
| 104 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None)</a></code></p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 106 | <p class="firstline">Changes the URL map for TargetHttpProxy.</p> |
| 107 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 109 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 110 | <h3>Method Details</h3> |
| 111 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <pre>Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. |
| 114 | |
| 115 | Args: |
| 116 | project: string, Name of the project scoping this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 117 | 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 `<`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 119 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 121 | 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | 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] | 124 | 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] | 125 | 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`) |
| 126 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 127 | |
| 128 | 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. |
| 129 | |
| 130 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| 131 | 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] | 132 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 133 | |
| 134 | Returns: |
| 135 | An object of the form: |
| 136 | |
| 137 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 138 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 139 | "items": { # A list of TargetHttpProxiesScopedList resources. |
| 140 | "a_key": { # Name of the scope containing this set of TargetHttpProxies. |
| 141 | "targetHttpProxies": [ # A list of TargetHttpProxies contained in this scope. |
| 142 | { # Represents a Target HTTP Proxy resource. |
| 143 | # |
| 144 | # Google Compute Engine has two Target HTTP Proxy resources: |
| 145 | # |
| 146 | # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies) |
| 147 | # |
| 148 | # A target HTTP proxy is a component of GCP HTTP load balancers. |
| 149 | # |
| 150 | # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. |
| 151 | # |
| 152 | # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) |
| 153 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 154 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 155 | "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. |
| 156 | "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. |
| 157 | # httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. |
| 158 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 159 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 160 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 161 | "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. |
| 162 | "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. |
| 163 | "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. |
| 164 | # |
| 165 | # When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. |
| 166 | # |
| 167 | # The default is false. |
| 168 | "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. |
| 169 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 170 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 171 | "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 172 | }, |
| 173 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 174 | "warning": { # Informational warning which replaces the list of backend services when the list is empty. |
| 175 | "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. |
| 176 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 177 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 178 | { |
| 179 | "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). |
| 180 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 181 | }, |
| 182 | ], |
| 183 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 184 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 186 | }, |
| 187 | "kind": "compute#targetHttpProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. |
| 188 | "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. |
| 189 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 190 | "unreachables": [ # [Output Only] Unreachable resources. |
| 191 | "A String", |
| 192 | ], |
| 193 | "warning": { # [Output Only] Informational warning message. |
| 194 | "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. |
| 195 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 196 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 197 | { |
| 198 | "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). |
| 199 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 200 | }, |
| 201 | ], |
| 202 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 203 | }, |
| 204 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 205 | </div> |
| 206 | |
| 207 | <div class="method"> |
| 208 | <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> |
| 209 | <pre>Retrieves the next page of results. |
| 210 | |
| 211 | Args: |
| 212 | previous_request: The request for the previous page. (required) |
| 213 | previous_response: The response from the request for the previous page. (required) |
| 214 | |
| 215 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 216 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 217 | page. Returns None if there are no more items in the collection. |
| 218 | </pre> |
| 219 | </div> |
| 220 | |
| 221 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 222 | <code class="details" id="close">close()</code> |
| 223 | <pre>Close httplib2 connections.</pre> |
| 224 | </div> |
| 225 | |
| 226 | <div class="method"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 227 | <code class="details" id="delete">delete(project, targetHttpProxy, requestId=None)</code> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 228 | <pre>Deletes the specified TargetHttpProxy resource. |
| 229 | |
| 230 | Args: |
| 231 | project: string, Project ID for this request. (required) |
| 232 | targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 233 | 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. |
| 234 | |
| 235 | 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. |
| 236 | |
| 237 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 238 | |
| 239 | Returns: |
| 240 | An object of the form: |
| 241 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 242 | { # Represents an Operation resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 243 | # |
| 244 | # Google Compute Engine has three Operation resources: |
| 245 | # |
| 246 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 247 | # |
| 248 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 249 | # |
| 250 | # Operations can be global, regional or zonal. |
| 251 | # - For global operations, use the `globalOperations` resource. |
| 252 | # - For regional operations, use the `regionOperations` resource. |
| 253 | # - For zonal operations, use the `zonalOperations` resource. |
| 254 | # |
| 255 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 256 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 257 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 258 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 259 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 260 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 261 | "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] | 262 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 263 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 264 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 265 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | }, |
| 267 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 268 | }, |
| 269 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 270 | "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. |
| 271 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 272 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 273 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 274 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 275 | "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] | 276 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 277 | "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. |
| 278 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 279 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 280 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 281 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 282 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 283 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 284 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 285 | "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. |
| 286 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 287 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 288 | { |
| 289 | "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. |
| 290 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 291 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 292 | { |
| 293 | "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). |
| 294 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 295 | }, |
| 296 | ], |
| 297 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 298 | }, |
| 299 | ], |
| 300 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 301 | }</pre> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 302 | </div> |
| 303 | |
| 304 | <div class="method"> |
| 305 | <code class="details" id="get">get(project, targetHttpProxy)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 306 | <pre>Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 307 | |
| 308 | Args: |
| 309 | project: string, Project ID for this request. (required) |
| 310 | targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required) |
| 311 | |
| 312 | Returns: |
| 313 | An object of the form: |
| 314 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 315 | { # Represents a Target HTTP Proxy resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 316 | # |
| 317 | # Google Compute Engine has two Target HTTP Proxy resources: |
| 318 | # |
| 319 | # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies) |
| 320 | # |
| 321 | # A target HTTP proxy is a component of GCP HTTP load balancers. |
| 322 | # |
| 323 | # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. |
| 324 | # |
| 325 | # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) |
| 326 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 327 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 328 | "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. |
| 329 | "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. |
| 330 | # httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. |
| 331 | "A String", |
| 332 | ], |
| 333 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 334 | "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. |
| 335 | "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. |
| 336 | "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 337 | # |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 338 | # When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 339 | # |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 340 | # The default is false. |
| 341 | "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. |
| 342 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 343 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 344 | "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. |
| 345 | }</pre> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 346 | </div> |
| 347 | |
| 348 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 349 | <code class="details" id="insert">insert(project, body=None, requestId=None)</code> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 350 | <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request. |
| 351 | |
| 352 | Args: |
| 353 | project: string, Project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 354 | body: object, The request body. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 355 | The object takes the form of: |
| 356 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 357 | { # Represents a Target HTTP Proxy resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | # |
| 359 | # Google Compute Engine has two Target HTTP Proxy resources: |
| 360 | # |
| 361 | # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies) |
| 362 | # |
| 363 | # A target HTTP proxy is a component of GCP HTTP load balancers. |
| 364 | # |
| 365 | # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. |
| 366 | # |
| 367 | # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) |
| 368 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 369 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 370 | "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. |
| 371 | "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | # httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. |
| 373 | "A String", |
| 374 | ], |
| 375 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 376 | "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. |
| 377 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 378 | "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. |
| 379 | # |
| 380 | # When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. |
| 381 | # |
| 382 | # The default is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 383 | "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. |
| 384 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 385 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 386 | "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. |
| 387 | } |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 388 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 389 | 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. |
| 390 | |
| 391 | 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. |
| 392 | |
| 393 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 394 | |
| 395 | Returns: |
| 396 | An object of the form: |
| 397 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 398 | { # Represents an Operation resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 399 | # |
| 400 | # Google Compute Engine has three Operation resources: |
| 401 | # |
| 402 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 403 | # |
| 404 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 405 | # |
| 406 | # Operations can be global, regional or zonal. |
| 407 | # - For global operations, use the `globalOperations` resource. |
| 408 | # - For regional operations, use the `regionOperations` resource. |
| 409 | # - For zonal operations, use the `zonalOperations` resource. |
| 410 | # |
| 411 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 412 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 413 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 414 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 415 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 416 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 417 | "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] | 418 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 419 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 420 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 421 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 422 | }, |
| 423 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 424 | }, |
| 425 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 426 | "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. |
| 427 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 428 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 429 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 430 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 431 | "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] | 432 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 433 | "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. |
| 434 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 435 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 436 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 437 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 438 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 439 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 440 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 441 | "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. |
| 442 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 443 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 444 | { |
| 445 | "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. |
| 446 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 447 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 448 | { |
| 449 | "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). |
| 450 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 451 | }, |
| 452 | ], |
| 453 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 454 | }, |
| 455 | ], |
| 456 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 457 | }</pre> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 458 | </div> |
| 459 | |
| 460 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 462 | <pre>Retrieves the list of TargetHttpProxy resources available to the specified project. |
| 463 | |
| 464 | Args: |
| 465 | project: string, Project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 466 | 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 `<`. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 467 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 468 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 469 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 470 | 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. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 471 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 472 | 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) ``` |
| 473 | 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`) |
| 474 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 475 | |
| 476 | 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. |
| 477 | |
| 478 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| 479 | 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] | 480 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 481 | |
| 482 | Returns: |
| 483 | An object of the form: |
| 484 | |
| 485 | { # A list of TargetHttpProxy resources. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 486 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 487 | "items": [ # A list of TargetHttpProxy resources. |
| 488 | { # Represents a Target HTTP Proxy resource. |
| 489 | # |
| 490 | # Google Compute Engine has two Target HTTP Proxy resources: |
| 491 | # |
| 492 | # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies) |
| 493 | # |
| 494 | # A target HTTP proxy is a component of GCP HTTP load balancers. |
| 495 | # |
| 496 | # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. |
| 497 | # |
| 498 | # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) |
| 499 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 500 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 501 | "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. |
| 502 | "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. |
| 503 | # httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. |
| 504 | "A String", |
| 505 | ], |
| 506 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 507 | "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. |
| 508 | "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. |
| 509 | "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 510 | # |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 511 | # When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 512 | # |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 513 | # The default is false. |
| 514 | "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. |
| 515 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 516 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 517 | "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. |
| 518 | }, |
| 519 | ], |
| 520 | "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. |
| 521 | "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. |
| 522 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 523 | "warning": { # [Output Only] Informational warning message. |
| 524 | "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. |
| 525 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 526 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 527 | { |
| 528 | "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). |
| 529 | "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] | 530 | }, |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 531 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 532 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 533 | }, |
| 534 | }</pre> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 535 | </div> |
| 536 | |
| 537 | <div class="method"> |
| 538 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 539 | <pre>Retrieves the next page of results. |
| 540 | |
| 541 | Args: |
| 542 | previous_request: The request for the previous page. (required) |
| 543 | previous_response: The response from the request for the previous page. (required) |
| 544 | |
| 545 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 546 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 547 | page. Returns None if there are no more items in the collection. |
| 548 | </pre> |
| 549 | </div> |
| 550 | |
| 551 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 552 | <code class="details" id="patch">patch(project, targetHttpProxy, body=None, requestId=None)</code> |
| 553 | <pre>Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) |
| 554 | |
| 555 | Args: |
| 556 | project: string, Project ID for this request. (required) |
| 557 | targetHttpProxy: string, Name of the TargetHttpProxy resource to patch. (required) |
| 558 | body: object, The request body. |
| 559 | The object takes the form of: |
| 560 | |
| 561 | { # Represents a Target HTTP Proxy resource. |
| 562 | # |
| 563 | # Google Compute Engine has two Target HTTP Proxy resources: |
| 564 | # |
| 565 | # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies) |
| 566 | # |
| 567 | # A target HTTP proxy is a component of GCP HTTP load balancers. |
| 568 | # |
| 569 | # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. |
| 570 | # |
| 571 | # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) |
| 572 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 573 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 574 | "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. |
| 575 | "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. |
| 576 | # httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. |
| 577 | "A String", |
| 578 | ], |
| 579 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 580 | "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. |
| 581 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 582 | "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. |
| 583 | # |
| 584 | # When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. |
| 585 | # |
| 586 | # The default is false. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 587 | "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. |
| 588 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 589 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 590 | "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. |
| 591 | } |
| 592 | |
| 593 | 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. |
| 594 | |
| 595 | 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. |
| 596 | |
| 597 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 598 | |
| 599 | Returns: |
| 600 | An object of the form: |
| 601 | |
| 602 | { # Represents an Operation resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 603 | # |
| 604 | # Google Compute Engine has three Operation resources: |
| 605 | # |
| 606 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 607 | # |
| 608 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 609 | # |
| 610 | # Operations can be global, regional or zonal. |
| 611 | # - For global operations, use the `globalOperations` resource. |
| 612 | # - For regional operations, use the `regionOperations` resource. |
| 613 | # - For zonal operations, use the `zonalOperations` resource. |
| 614 | # |
| 615 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 616 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 617 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 618 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 619 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 620 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 621 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 622 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 623 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 624 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 625 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 626 | }, |
| 627 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 628 | }, |
| 629 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 630 | "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. |
| 631 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 632 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 633 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 634 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 635 | "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] | 636 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 637 | "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. |
| 638 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 639 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 640 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 641 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 642 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 643 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 644 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 645 | "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. |
| 646 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 647 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 648 | { |
| 649 | "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. |
| 650 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 651 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 652 | { |
| 653 | "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). |
| 654 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 655 | }, |
| 656 | ], |
| 657 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 658 | }, |
| 659 | ], |
| 660 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 661 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 662 | </div> |
| 663 | |
| 664 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 665 | <code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None)</code> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 666 | <pre>Changes the URL map for TargetHttpProxy. |
| 667 | |
| 668 | Args: |
| 669 | project: string, Project ID for this request. (required) |
| 670 | targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 671 | body: object, The request body. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 672 | The object takes the form of: |
| 673 | |
| 674 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 675 | "urlMap": "A String", |
| 676 | } |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 677 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 678 | 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. |
| 679 | |
| 680 | 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. |
| 681 | |
| 682 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 683 | |
| 684 | Returns: |
| 685 | An object of the form: |
| 686 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 687 | { # Represents an Operation resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 688 | # |
| 689 | # Google Compute Engine has three Operation resources: |
| 690 | # |
| 691 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 692 | # |
| 693 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 694 | # |
| 695 | # Operations can be global, regional or zonal. |
| 696 | # - For global operations, use the `globalOperations` resource. |
| 697 | # - For regional operations, use the `regionOperations` resource. |
| 698 | # - For zonal operations, use the `zonalOperations` resource. |
| 699 | # |
| 700 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 701 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 702 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 703 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 704 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 705 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 706 | "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] | 707 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 708 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 709 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 710 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 711 | }, |
| 712 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 713 | }, |
| 714 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 715 | "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. |
| 716 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 717 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 718 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 719 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 720 | "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] | 721 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 722 | "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. |
| 723 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 724 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 725 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 726 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 727 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 728 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 729 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 730 | "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. |
| 731 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 732 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 733 | { |
| 734 | "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. |
| 735 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 736 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 737 | { |
| 738 | "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). |
| 739 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 740 | }, |
| 741 | ], |
| 742 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 743 | }, |
| 744 | ], |
| 745 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 746 | }</pre> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 747 | </div> |
| 748 | |
| 749 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 750 | <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 751 | <pre>Returns permissions that a caller has on the specified resource. |
| 752 | |
| 753 | Args: |
| 754 | project: string, Project ID for this request. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 755 | resource: string, Name or id of the resource for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 756 | body: object, The request body. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 757 | The object takes the form of: |
| 758 | |
| 759 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 760 | "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| 761 | "A String", |
| 762 | ], |
| 763 | } |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 764 | |
| 765 | |
| 766 | Returns: |
| 767 | An object of the form: |
| 768 | |
| 769 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 770 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 771 | "A String", |
| 772 | ], |
| 773 | }</pre> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 774 | </div> |
| 775 | |
| 776 | </body></html> |