Blame - docs/dyn/compute_v1.targetHttpProxies.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

79

<p class="firstline">Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.</p>

80

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

Dmitry Frenkel

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

87

<code><a href="#delete">delete(project, targetHttpProxy, requestId=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

88

<p class="firstline">Deletes the specified TargetHttpProxy resource.</p>

89

90

<code><a href="#get">get(project, targetHttpProxy)</a></code></p>

Bu Sun Kim

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>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

94

<p class="firstline">Creates a TargetHttpProxy resource in the specified project using the data included in the request.</p>

95

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

96

<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

97

<p class="firstline">Retrieves the list of TargetHttpProxy resources available to the specified project.</p>

98

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

Dmitry Frenkel

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

106

<p class="firstline">Changes the URL map for TargetHttpProxy.</p>

107

<h3>Method Details</h3>

108

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

109

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

<pre>Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.

111

112

Args:

113

project: string, Name of the project scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

114

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 `<`.

115

116

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

117

118

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.

119

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

120

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

2020-05-01 07:42:23 -0700

[diff] [blame]

121

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

2020-05-20 12:08:20 -0700

[diff] [blame]

122

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`)

123

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

124

125

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.

126

127

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

128

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

129

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

130

131

Returns:

132

An object of the form:

133

134

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

135

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

136

"items": { # A list of TargetHttpProxiesScopedList resources.

137

"a_key": { # Name of the scope containing this set of TargetHttpProxies.

138

"targetHttpProxies": [ # A list of TargetHttpProxies contained in this scope.

139

{ # Represents a Target HTTP Proxy resource.

140

#

141

# Google Compute Engine has two Target HTTP Proxy resources:

142

#

143

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)

144

#

145

# A target HTTP proxy is a component of GCP HTTP load balancers.

146

#

147

# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.

148

#

149

# 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 ==)

150

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

151

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

152

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

153

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

154

"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

155

"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

2020-11-16 11:05:03 -0700

[diff] [blame^]

156

"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.

157

#

158

# 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.

159

#

160

# The default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

161

"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.

162

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

163

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.

164

},

165

],

166

"warning": { # Informational warning which replaces the list of backend services when the list is empty.

167

"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.

168

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

169

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

170

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

171

"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).

172

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

173

},

174

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

175

"message": "A String", # [Output Only] A human-readable description of the warning code.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

176

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

177

},

178

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

179

"kind": "compute#targetHttpProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.

180

"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.

181

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

182

"unreachables": [ # [Output Only] Unreachable resources.

183

"A String",

184

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

190

<pre>Retrieves the next page of results.

191

192

Args:

193

previous_request: The request for the previous page. (required)

194

previous_response: The response from the request for the previous page. (required)

195

196

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

197

A request object that you can call 'execute()' on to request the next

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

198

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

203

<code class="details" id="close">close()</code>

204

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

208

<code class="details" id="delete">delete(project, targetHttpProxy, requestId=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

209

<pre>Deletes the specified TargetHttpProxy resource.

210

211

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

212

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

213

targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

214

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

215

216

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.

217

218

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

219

220

Returns:

221

An object of the form:

222

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

223

{ # Represents an Operation resource.

224

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

225

# Google Compute Engine has three Operation resources:

226

#

227

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

228

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

229

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

230

#

231

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

232

# - For global operations, use the `globalOperations` resource.

233

# - For regional operations, use the `regionOperations` resource.

234

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

235

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

236

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

237

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

238

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

239

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

240

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

241

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

242

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

243

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

244

"code": "A String", # [Output Only] The error type identifier for this error.

245

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

246

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

247

},

248

],

249

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

250

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

251

"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.

252

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

253

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

254

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

255

"name": "A String", # [Output Only] Name of the operation.

256

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

257

"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.

258

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

259

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

260

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

261

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

262

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

263

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

264

"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.

265

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

266

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

267

{

268

"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.

269

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

270

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

271

{

272

"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).

273

"value": "A String", # [Output Only] A warning data value corresponding to the key.

274

},

275

],

276

"message": "A String", # [Output Only] A human-readable description of the warning code.

277

},

278

],

279

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, targetHttpProxy)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

285

<pre>Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

286

287

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

288

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

289

targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)

290

291

Returns:

292

An object of the form:

293

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

294

{ # Represents a Target HTTP Proxy resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

295

#

296

# Google Compute Engine has two Target HTTP Proxy resources:

297

#

298

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)

299

#

300

# A target HTTP proxy is a component of GCP HTTP load balancers.

301

#

302

# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.

303

#

304

# 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 ==)

305

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

306

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

307

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

309

"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

310

"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

2020-11-16 11:05:03 -0700

[diff] [blame^]

311

"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.

312

#

313

# 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.

314

#

315

# The default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

316

"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.

317

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

318

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.

319

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

323

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

324

<pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.

325

326

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

327

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

328

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

329

The object takes the form of:

330

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

331

{ # Represents a Target HTTP Proxy resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

#

333

# Google Compute Engine has two Target HTTP Proxy resources:

334

#

335

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)

336

#

337

# A target HTTP proxy is a component of GCP HTTP load balancers.

338

#

339

# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.

340

#

341

# 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 ==)

342

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

343

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

344

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

345

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

346

"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

347

"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

2020-11-16 11:05:03 -0700

[diff] [blame^]

348

"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.

349

#

350

# 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.

351

#

352

# The default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

353

"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.

354

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

355

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.

356

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

357

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

358

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.

359

360

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.

361

362

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

363

364

Returns:

365

An object of the form:

366

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

367

{ # Represents an Operation resource.

368

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

369

# Google Compute Engine has three Operation resources:

370

#

371

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

372

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

373

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

374

#

375

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

376

# - For global operations, use the `globalOperations` resource.

377

# - For regional operations, use the `regionOperations` resource.

378

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

379

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

380

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

381

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

382

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

383

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

384

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

385

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

386

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

387

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

"code": "A String", # [Output Only] The error type identifier for this error.

389

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

390

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

391

},

392

],

393

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

394

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

395

"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.

396

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

397

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

398

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

399

"name": "A String", # [Output Only] Name of the operation.

400

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

401

"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.

402

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

403

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

404

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

405

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

406

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

407

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

408

"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.

409

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

410

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

411

{

412

"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.

413

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

414

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

415

{

416

"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).

417

"value": "A String", # [Output Only] A warning data value corresponding to the key.

418

},

419

],

420

"message": "A String", # [Output Only] A human-readable description of the warning code.

421

},

422

],

423

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

428

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

429

<pre>Retrieves the list of TargetHttpProxy resources available to the specified project.

430

431

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

432

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

433

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]

434

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

435

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]

436

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

437

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

2016-02-19 16:02:29 -0800

[diff] [blame]

438

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

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) ```

440

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`)

441

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

442

443

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.

444

445

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

446

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

447

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

448

449

Returns:

450

An object of the form:

451

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

452

{ # A list of TargetHttpProxy resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

453

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

454

"items": [ # A list of TargetHttpProxy resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

455

{ # Represents a Target HTTP Proxy resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

456

#

457

# Google Compute Engine has two Target HTTP Proxy resources:

458

#

459

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)

460

#

461

# A target HTTP proxy is a component of GCP HTTP load balancers.

462

#

463

# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.

464

#

465

# 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 ==)

466

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

467

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

468

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

469

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

470

"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

471

"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

2020-11-16 11:05:03 -0700

[diff] [blame^]

472

"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.

473

#

474

# 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.

475

#

476

# The default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

477

"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.

478

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

479

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.

480

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

481

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

482

"kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.

483

"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.

484

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

485

"warning": { # [Output Only] Informational warning message.

486

"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.

487

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

488

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

489

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

490

"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).

491

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

492

},

493

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

494

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

495

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

501

<pre>Retrieves the next page of results.

502

503

Args:

504

previous_request: The request for the previous page. (required)

505

previous_response: The response from the request for the previous page. (required)

506

507

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

508

A request object that you can call 'execute()' on to request the next

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

509

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

514

<code class="details" id="patch">patch(project, targetHttpProxy, body=None, requestId=None)</code>

515

<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 ==)

516

517

Args:

518

project: string, Project ID for this request. (required)

519

targetHttpProxy: string, Name of the TargetHttpProxy resource to patch. (required)

520

body: object, The request body.

521

The object takes the form of:

522

523

{ # Represents a Target HTTP Proxy resource.

524

#

525

# Google Compute Engine has two Target HTTP Proxy resources:

526

#

527

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)

528

#

529

# A target HTTP proxy is a component of GCP HTTP load balancers.

530

#

531

# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.

532

#

533

# 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 ==)

534

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

535

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

536

"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.

537

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

538

"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

539

"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

2020-11-16 11:05:03 -0700

[diff] [blame^]

540

"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.

541

#

542

# 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.

543

#

544

# The default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

545

"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.

546

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

547

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.

548

}

549

550

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.

551

552

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.

553

554

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

555

556

Returns:

557

An object of the form:

558

559

{ # Represents an Operation resource.

560

#

561

# Google Compute Engine has three Operation resources:

562

#

563

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

564

#

565

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

566

#

567

# Operations can be global, regional or zonal.

568

# - For global operations, use the `globalOperations` resource.

569

# - For regional operations, use the `regionOperations` resource.

570

# - For zonal operations, use the `zonalOperations` resource.

571

#

572

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

573

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

574

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

575

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

576

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

577

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

578

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

579

{

580

"code": "A String", # [Output Only] The error type identifier for this error.

581

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

582

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

587

"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.

588

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

589

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

590

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

591

"name": "A String", # [Output Only] Name of the operation.

592

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

593

"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.

594

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

595

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

596

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

597

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

598

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

599

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

600

"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.

601

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

602

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

603

{

604

"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.

605

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

606

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

607

{

608

"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).

609

"value": "A String", # [Output Only] A warning data value corresponding to the key.

610

},

611

],

612

"message": "A String", # [Output Only] A human-readable description of the warning code.

613

},

614

],

615

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

620

<code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

621

<pre>Changes the URL map for TargetHttpProxy.

622

623

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

624

project: string, Project ID for this request. (required)

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

625

targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

626

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

627

The object takes the form of:

628

629

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

630

"urlMap": "A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

631

}

632

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

633

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.

634

635

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.

636

637

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

638

639

Returns:

640

An object of the form:

641

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

642

{ # Represents an Operation resource.

643

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

644

# Google Compute Engine has three Operation resources:

645

#

646

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

647

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

648

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

649

#

650

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

651

# - For global operations, use the `globalOperations` resource.

652

# - For regional operations, use the `regionOperations` resource.

653

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

654

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

655

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

656

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

657

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

658

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

659

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

660

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

661

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

662

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

663

"code": "A String", # [Output Only] The error type identifier for this error.

664

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

665

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

666

},

667

],

668

},

Bu Sun Kim