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

2017-06-06 18:46:08 -0400

[diff] [blame]

119

120

Returns:

121

An object of the form:

122

Bu Sun Kim

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

[diff] [blame]

123

{ # Represents an Operation resource.

124

#

Dan O'Meara

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

[diff] [blame]

125

# Google Compute Engine has three Operation resources:

126

#

127

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

128

#

Bu Sun Kim

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

[diff] [blame]

129

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

130

#

131

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

132

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

133

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

134

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

Bu Sun Kim

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

[diff] [blame]

135

#

Dan O'Meara

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

[diff] [blame]

136

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

137

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

138

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

139

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

140

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

141

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

142

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

143

{

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

146

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

147

},

148

],

149

},

Bu Sun Kim

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

[diff] [blame]

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

{

168

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

169

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

170

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

171

{

172

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

173

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

174

},

175

],

176

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

177

},

178

],

179

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

185

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

186

187

Args:

188

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

189

targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required)

190

191

Returns:

192

An object of the form:

193

Dan O'Meara

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

[diff] [blame]

194

{ # Represents a Target TCP Proxy resource.

Bu Sun Kim

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

[diff] [blame]

195

#

196

# A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)

197

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

198

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

199

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

200

"kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

201

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

202

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

203

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

204

"service": "A String", # URL to the BackendService resource.

205

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

209

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

210

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

211

212

Args:

213

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

Dan O'Meara

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

[diff] [blame]

214

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

215

The object takes the form of:

216

Dan O'Meara

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

[diff] [blame]

217

{ # Represents a Target TCP Proxy resource.

Bu Sun Kim

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

[diff] [blame]

218

#

219

# A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)

220

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

221

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

222

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

223

"kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

224

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

225

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

226

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

227

"service": "A String", # URL to the BackendService resource.

228

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

229

Bu Sun Kim

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

[diff] [blame]

230

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.

231

232

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.

233

234

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

235

236

Returns:

237

An object of the form:

238

Bu Sun Kim

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

[diff] [blame]

239

{ # Represents an Operation resource.

240

#

Dan O'Meara

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

[diff] [blame]

241

# Google Compute Engine has three Operation resources:

242

#

243

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

244

#

Bu Sun Kim

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

[diff] [blame]

245

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

246

#

247

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

248

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

249

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

250

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

Bu Sun Kim

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

[diff] [blame]

251

#

Dan O'Meara

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

[diff] [blame]

252

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

253

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

254

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

255

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

256

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

257

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

258

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

259

{

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

263

},

264

],

265

},

Bu Sun Kim

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

[diff] [blame]

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

{

284

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

285

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

286

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

287

{

288

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

289

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

290

},

291

],

292

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

293

},

294

],

295

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

300

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

301

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

302

303

Args:

304

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

Dan O'Meara

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

[diff] [blame]

305

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

2017-06-06 18:46:08 -0400

[diff] [blame]

306

Dan O'Meara

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

[diff] [blame]

307

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

308

Dan O'Meara

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

[diff] [blame]

309

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

2017-06-06 18:46:08 -0400

[diff] [blame]

310

Bu Sun Kim

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

[diff] [blame]

311

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

312

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

313

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

314

315

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.

316

317

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

318

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

3e17f89

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

[diff] [blame^]

319

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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

320

321

Returns:

322

An object of the form:

323

324

{ # Contains a list of TargetTcpProxy resources.

Bu Sun Kim

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

[diff] [blame]

325

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

326

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

Dan O'Meara

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

[diff] [blame]

327

{ # Represents a Target TCP Proxy resource.

Bu Sun Kim

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

[diff] [blame]

328

#

329

# A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)

330

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

331

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

332

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

333

"kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

334

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

335

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

336

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

337

"service": "A String", # URL to the BackendService resource.

338

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

339

],

Bu Sun Kim

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

[diff] [blame]

340

"kind": "compute#targetTcpProxyList", # Type of resource.

341

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

342

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

343

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

344

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

345

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

346

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

Bu Sun Kim

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

[diff] [blame]

347

{

Bu Sun Kim

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

[diff] [blame]

348

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

349

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

350

},

351

],

Bu Sun Kim

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

[diff] [blame]

352

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

353

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

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

359

<pre>Retrieves the next page of results.

360

361

Args:

362

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

363

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

364

365

Returns:

Bu Sun Kim

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

[diff] [blame]

366

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

367

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]

372

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

373

<pre>Changes the BackendService for TargetTcpProxy.

374

375

Args:

376

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

377

targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required)

Dan O'Meara

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

[diff] [blame]

378

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

379

The object takes the form of:

380

381

{

Bu Sun Kim

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

[diff] [blame]

382

"service": "A String", # The URL of the new BackendService resource for the targetTcpProxy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

383

}

384

Bu Sun Kim

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

[diff] [blame]

385

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.

386

387

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.

388

389

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

390

391

Returns:

392

An object of the form:

393

Bu Sun Kim

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

[diff] [blame]

394

{ # Represents an Operation resource.

395

#

Dan O'Meara

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

[diff] [blame]

396

# Google Compute Engine has three Operation resources:

397

#

398

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

399

#

Bu Sun Kim

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

[diff] [blame]

400

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

401

#

402

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

403

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

404

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

405

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

Bu Sun Kim

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

[diff] [blame]

406

#

Dan O'Meara

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

[diff] [blame]

407

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

408

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

409

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

410

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

411

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

412

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

413

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

414

{

Bu Sun Kim

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

[diff] [blame]

415

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

416

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

417

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

418

},

419

],

420

},

Bu Sun Kim

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

[diff] [blame]

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

{

439

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

440

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

441

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

442

{

443

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

444

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

445

},

446

],

447

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

448

},

449

],

450

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

455

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

456

<pre>Changes the ProxyHeaderType for TargetTcpProxy.

457

458

Args:

459

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

460

targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required)

Dan O'Meara

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

[diff] [blame]

461

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

462

The object takes the form of:

463

464

{

Bu Sun Kim

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

[diff] [blame]

465

"proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

466

}

467

Bu Sun Kim

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

[diff] [blame]

468

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.

469

470

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.

471

472

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

473

474

Returns:

475

An object of the form:

476

Bu Sun Kim

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

[diff] [blame]

477

{ # Represents an Operation resource.

478

#

Dan O'Meara

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

[diff] [blame]

479

# Google Compute Engine has three Operation resources:

480

#

481

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

482

#

Bu Sun Kim

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

[diff] [blame]

483

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

484

#

485

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

486

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

487

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

488

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

Bu Sun Kim

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

[diff] [blame]

489

#

Dan O'Meara

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

[diff] [blame]

490

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

491

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

492

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

493

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

494

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

495

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

496

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

497

{

Bu Sun Kim

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

[diff] [blame]

498

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

499

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

500

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

501

},

502

],

503

},

Bu Sun Kim