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

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

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

84

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

85

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

86

87

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

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

89

Dan O'Meara

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

[diff] [blame]

90

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

91

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

92

Bu Sun Kim

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

[diff] [blame]

93

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

94

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

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

Dan O'Meara

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

[diff] [blame]

99

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

103

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

104

<h3>Method Details</h3>

105

Bu Sun Kim

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

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

108

109

Args:

110

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

Dan O'Meara

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

[diff] [blame]

111

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

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

[diff] [blame]

112

Dan O'Meara

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

Dan O'Meara

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

[diff] [blame]

115

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

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

[diff] [blame]

116

Bu Sun Kim

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

[diff] [blame]

117

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]

118

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]

119

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

120

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

121

122

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.

123

124

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

125

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.

Bu Sun Kim

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

[diff] [blame]

126

127

Returns:

128

An object of the form:

129

130

{

Bu Sun Kim

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

[diff] [blame]

131

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

132

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

133

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

134

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

135

{ # Represents a Target HTTP Proxy resource.

136

#

137

# Google Compute Engine has two Target HTTP Proxy resources:

138

#

139

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

140

#

141

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

142

#

143

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

144

#

145

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

146

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

147

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

148

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

149

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

150

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

151

"proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.

152

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

153

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

154

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

155

},

156

],

157

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

158

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

159

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

160

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

Bu Sun Kim

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

[diff] [blame]

161

{

Bu Sun Kim

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

[diff] [blame]

162

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

163

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

164

},

165

],

Bu Sun Kim

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

[diff] [blame]

166

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

167

},

Bu Sun Kim

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

[diff] [blame]

168

},

169

},

Bu Sun Kim

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

[diff] [blame]

170

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

171

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

172

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

173

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

174

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

175

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

176

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

Bu Sun Kim

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

[diff] [blame]

177

{

Bu Sun Kim

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

[diff] [blame]

178

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

179

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

180

},

181

],

Bu Sun Kim

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

[diff] [blame]

182

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

183

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

189

<pre>Retrieves the next page of results.

190

191

Args:

192

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

193

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

194

195

Returns:

Bu Sun Kim

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

[diff] [blame]

196

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

Bu Sun Kim

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

[diff] [blame]

197

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

</pre>

</div>

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

203

<pre>Deletes the specified TargetHttpProxy resource.

204

205

Args:

206

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

207

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

Bu Sun Kim

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

[diff] [blame]

208

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.

209

210

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.

211

212

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

213

214

Returns:

215

An object of the form:

216

Bu Sun Kim

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

[diff] [blame]

217

{ # Represents an Operation resource.

218

#

Dan O'Meara

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

[diff] [blame]

219

# Google Compute Engine has three Operation resources:

220

#

221

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

222

#

Bu Sun Kim

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

[diff] [blame]

223

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

224

#

225

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

226

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

227

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

228

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

Bu Sun Kim

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

[diff] [blame]

229

#

Dan O'Meara

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

[diff] [blame]

230

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

231

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

232

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

233

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

234

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

235

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

236

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

237

{

Bu Sun Kim

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

[diff] [blame]

238

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

239

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

240

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

241

},

242

],

243

},

Bu Sun Kim

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

[diff] [blame]

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

{

262

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

263

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

264

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

265

{

266

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

267

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

268

},

269

],

270

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

271

},

272

],

273

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

Sai Cheemalapati

2016-10-21 13:59:49 -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]

279

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

280

281

Args:

282

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

283

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

284

285

Returns:

286

An object of the form:

287

Dan O'Meara

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

[diff] [blame]

288

{ # Represents a Target HTTP Proxy resource.

Bu Sun Kim

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

[diff] [blame]

289

#

290

# Google Compute Engine has two Target HTTP Proxy resources:

291

#

292

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

293

#

294

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

295

#

296

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

297

#

298

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

299

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

300

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

301

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

302

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

303

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

304

"proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.

305

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

306

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

307

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

308

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

312

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

313

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

314

315

Args:

316

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

Dan O'Meara

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

[diff] [blame]

317

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

318

The object takes the form of:

319

Dan O'Meara

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

[diff] [blame]

320

{ # Represents a Target HTTP Proxy resource.

Bu Sun Kim

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

[diff] [blame]

321

#

322

# Google Compute Engine has two Target HTTP Proxy resources:

323

#

324

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

325

#

326

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

327

#

328

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

329

#

330

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

331

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

332

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

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 loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.

337

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

338

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

339

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

340

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

341

Bu Sun Kim

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

[diff] [blame]

342

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.

343

344

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.

345

346

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

347

348

Returns:

349

An object of the form:

350

Bu Sun Kim

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

[diff] [blame]

351

{ # Represents an Operation resource.

352

#

Dan O'Meara

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

[diff] [blame]

353

# Google Compute Engine has three Operation resources:

354

#

355

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

356

#

Bu Sun Kim

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

[diff] [blame]

357

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

358

#

359

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

360

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

361

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

362

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

Bu Sun Kim

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

[diff] [blame]

363

#

Dan O'Meara

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

[diff] [blame]

364

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

365

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

366

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

367

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

368

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

369

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

370

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

371

{

Bu Sun Kim

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

[diff] [blame]

372

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

373

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

374

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

375

},

376

],

377

},

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

{

396

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

397

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

398

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

399

{

400

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

401

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

402

},

403

],

404

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

405

},

406

],

407

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

412

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

413

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

414

415

Args:

416

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

Dan O'Meara

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

[diff] [blame]

417

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

2016-10-21 13:59:49 -0700

[diff] [blame]

418

Dan O'Meara

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

[diff] [blame]

419

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

420

Dan O'Meara

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

[diff] [blame]

421

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

2016-10-21 13:59:49 -0700

[diff] [blame]

422

Bu Sun Kim

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

[diff] [blame]

423

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

424

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

425

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

426

427

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.

428

429

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

430

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

431

432

Returns:

433

An object of the form:

434

435

{ # A list of TargetHttpProxy resources.

Bu Sun Kim

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

[diff] [blame]

436

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

437

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

Dan O'Meara

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

[diff] [blame]

438

{ # Represents a Target HTTP Proxy resource.

Bu Sun Kim

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

[diff] [blame]

439

#

440

# Google Compute Engine has two Target HTTP Proxy resources:

441

#

442

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

443

#

444

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

445

#

446

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

447

#

448

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

449

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

450

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

451

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

452

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

453

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

454

"proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.

455

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

456

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

457

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

458

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

459

],

Bu Sun Kim

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

[diff] [blame]

460

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

461

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

462

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

463

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

464

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

465

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

466

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

Bu Sun Kim

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

[diff] [blame]

467

{

Bu Sun Kim

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

[diff] [blame]

468

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

469

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

470

},

471

],

Bu Sun Kim

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

[diff] [blame]

472

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

473

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

479

<pre>Retrieves the next page of results.

480

481

Args:

482

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

483

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

484

485

Returns:

Bu Sun Kim

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

[diff] [blame]

486

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

487

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

492

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

493

<pre>Changes the URL map for TargetHttpProxy.

494

495

Args:

496

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

497

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]

498

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

499

The object takes the form of:

500

501

{

Bu Sun Kim

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

[diff] [blame]

502

"urlMap": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

503

}

504

Bu Sun Kim

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

[diff] [blame]

505

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.

506

507

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.

508

509

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

510

511

Returns:

512

An object of the form:

513

Bu Sun Kim

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

[diff] [blame]

514

{ # Represents an Operation resource.

515

#

Dan O'Meara

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

[diff] [blame]

516

# Google Compute Engine has three Operation resources:

517

#

518

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

519

#

Bu Sun Kim

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

[diff] [blame]

520

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

521

#

522

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

523

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

524

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

525

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

Bu Sun Kim

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

[diff] [blame]

526

#

Dan O'Meara

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

[diff] [blame]

527

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

528

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

529

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

530

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

531

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

532

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

533

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

534

{

Bu Sun Kim

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

[diff] [blame]

535

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

536

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

537

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

538

},

539

],

540

},

Bu Sun Kim