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

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

[diff] [blame]

122

123

Returns:

124

An object of the form:

125

Bu Sun Kim

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

[diff] [blame]

126

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

127

#

128

# Google Compute Engine has three Operation resources:

129

#

130

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

131

#

132

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

133

#

134

# Operations can be global, regional or zonal.

135

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

136

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

137

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

138

#

139

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

140

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

141

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

142

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

143

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

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

147

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

148

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

149

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

Bu Sun Kim

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

[diff] [blame]

150

},

151

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

152

},

153

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

154

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

155

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

156

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

157

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

158

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

159

#

160

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

161

#

162

# Example 1: Pack and unpack a message in C++.

163

#

164

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

165

#

166

# Example 2: Pack and unpack a message in Java.

167

#

168

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

169

#

170

# Example 3: Pack and unpack a message in Python.

171

#

172

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

173

#

174

# Example 4: Pack and unpack a message in Go

175

#

176

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

177

#

178

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

183

#

184

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

185

#

186

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

187

#

188

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

189

#

190

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

191

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

192

#

193

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

194

#

195

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

196

#

197

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

198

#

199

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

200

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

201

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

202

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

203

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

204

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

205

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

206

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

207

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

208

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

{

217

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

218

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

219

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

220

{

221

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

222

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

223

},

224

],

225

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

226

},

227

],

228

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

229

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

233

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

Bu Sun Kim

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

[diff] [blame]

234

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

Jon Wayne Parrott

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

[diff] [blame]

235

236

Args:

Sai Cheemalapati

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

[diff] [blame]

237

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

238

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

Jon Wayne Parrott

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

[diff] [blame]

239

240

Returns:

241

An object of the form:

242

Dan O'Meara

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

[diff] [blame]

243

{ # Represents a Target TCP Proxy resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

244

#

245

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

246

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

247

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

248

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

249

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

250

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

251

"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

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

[diff] [blame]

252

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

253

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

254

#

255

# The default is false.

256

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

257

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

258

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

259

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

263

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

Sai Cheemalapati

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

[diff] [blame]

264

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

Jon Wayne Parrott

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

[diff] [blame]

265

266

Args:

Sai Cheemalapati

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

[diff] [blame]

267

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

Dan O'Meara

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

[diff] [blame]

268

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

269

The object takes the form of:

270

Dan O'Meara

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

[diff] [blame]

271

{ # Represents a Target TCP Proxy resource.

Bu Sun Kim

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

[diff] [blame]

272

#

273

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

274

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

275

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

276

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

277

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

278

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

Bu Sun Kim

673ec5c

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

[diff] [blame]

279

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

280

#

281

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

282

#

283

# The default is false.

Bu Sun Kim

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

[diff] [blame]

284

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

285

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

286

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

287

}

Jon Wayne Parrott

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

[diff] [blame]

288

Bu Sun Kim

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

[diff] [blame]

289

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.

290

291

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.

292

293

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

Jon Wayne Parrott

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

[diff] [blame]

294

295

Returns:

296

An object of the form:

297

Bu Sun Kim

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

[diff] [blame]

298

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

299

#

300

# Google Compute Engine has three Operation resources:

301

#

302

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

303

#

304

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

305

#

306

# Operations can be global, regional or zonal.

307

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

308

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

309

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

310

#

311

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

312

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

313

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

314

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

315

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

316

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

317

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

Bu Sun Kim

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

[diff] [blame]

318

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

319

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

320

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

321

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

Bu Sun Kim

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

[diff] [blame]

322

},

323

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

324

},

325

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

326

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

327

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

328

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

329

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

330

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

331

#

332

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

333

#

334

# Example 1: Pack and unpack a message in C++.

335

#

336

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

337

#

338

# Example 2: Pack and unpack a message in Java.

339

#

340

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

341

#

342

# Example 3: Pack and unpack a message in Python.

343

#

344

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

345

#

346

# Example 4: Pack and unpack a message in Go

347

#

348

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

349

#

350

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

355

#

356

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

357

#

358

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

359

#

360

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

361

#

362

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

363

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

364

#

365

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

366

#

367

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

368

#

369

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

370

#

371

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

372

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

373

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

374

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

375

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

376

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

377

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

378

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

379

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

380

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

{

389

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

390

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

391

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

392

{

393

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

394

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

395

},

396

],

397

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

398

},

399

],

400

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

401

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

405

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

Sai Cheemalapati

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

[diff] [blame]

406

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

Jon Wayne Parrott

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

[diff] [blame]

407

408

Args:

Sai Cheemalapati

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

[diff] [blame]

409

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

Dan O'Meara

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

[diff] [blame]

410

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

Jon Wayne Parrott

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

[diff] [blame]

411

Dan O'Meara

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

[diff] [blame]

412

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

Jon Wayne Parrott

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

[diff] [blame]

413

Dan O'Meara

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

[diff] [blame]

414

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]

415

Bu Sun Kim

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

[diff] [blame]

416

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

417

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

418

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

419

420

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.

421

422

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

423

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

424

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Jon Wayne Parrott

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

[diff] [blame]

425

426

Returns:

427

An object of the form:

428

Sai Cheemalapati

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

[diff] [blame]

429

{ # Contains a list of TargetTcpProxy resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

430

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

431

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

432

{ # Represents a Target TCP Proxy resource.

433

#

434

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

435

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

436

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

437

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

438

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

439

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

440

"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

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

[diff] [blame]

441

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

442

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

443

#

444

# The default is false.

445

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

446

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

447

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

448

},

449

],

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

{

458

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

459

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

Bu Sun Kim

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

[diff] [blame]

460

},

Jon Wayne Parrott

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

[diff] [blame]

461

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

462

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

463

},

464

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

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

469

<pre>Retrieves the next page of results.

470

471

Args:

472

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

473

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

474

475

Returns:

Bu Sun Kim

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

[diff] [blame]

476

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

Jon Wayne Parrott

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

[diff] [blame]

477

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]

482

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

Sai Cheemalapati

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

[diff] [blame]

483

<pre>Changes the BackendService for TargetTcpProxy.

Jon Wayne Parrott

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

[diff] [blame]

484

485

Args:

Sai Cheemalapati

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

[diff] [blame]

486

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

487

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]

488

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

489

The object takes the form of:

490

Sai Cheemalapati

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

[diff] [blame]

491

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

492

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

493

}

Jon Wayne Parrott

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

[diff] [blame]

494

Bu Sun Kim

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

[diff] [blame]

495

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.

496

497

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.

498

499

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

Jon Wayne Parrott

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

[diff] [blame]

500

501

Returns:

502

An object of the form:

503

Bu Sun Kim

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

[diff] [blame]

504

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

505

#

506

# Google Compute Engine has three Operation resources:

507

#

508

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

509

#

510

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

511

#

512

# Operations can be global, regional or zonal.

513

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

514

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

515

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

516

#

517

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

518

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

519

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

520

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

521

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

522

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

523

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

Bu Sun Kim

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

[diff] [blame]

524

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

525

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

526

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

527

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

Bu Sun Kim

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

[diff] [blame]

528

},

529

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

530

},

531

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

532

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

533

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

534

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

535

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

536

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

537

#

538

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

539

#

540

# Example 1: Pack and unpack a message in C++.

541

#

542

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

543

#

544

# Example 2: Pack and unpack a message in Java.

545

#

546

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

547

#

548

# Example 3: Pack and unpack a message in Python.

549

#

550

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

551

#

552

# Example 4: Pack and unpack a message in Go

553

#

554

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

555

#

556

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

561

#

562

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

563

#

564

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

565

#

566

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

567

#

568

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

569

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

570

#

571

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

572

#

573

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

574

#

575

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

576

#

577

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

578

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

579

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

580

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

581

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

582

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

583

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

584

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

585

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

586

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

{

595

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

596

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

597

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

598

{

599

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

600

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

601

},

602

],

603

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

604

},

605

],

606

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

607

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

611

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

Sai Cheemalapati

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

[diff] [blame]

612

<pre>Changes the ProxyHeaderType for TargetTcpProxy.

Jon Wayne Parrott

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

[diff] [blame]

613

614

Args:

Sai Cheemalapati

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

[diff] [blame]

615

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

616

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]

617

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

618

The object takes the form of:

619

Sai Cheemalapati

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

[diff] [blame]

620

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

621

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

622

}

Jon Wayne Parrott

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

[diff] [blame]

623

Bu Sun Kim

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

[diff] [blame]

624

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.

625

626

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.

627

628

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

Jon Wayne Parrott

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

[diff] [blame]

629

630

Returns:

631

An object of the form:

632

Bu Sun Kim

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

[diff] [blame]

633

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

634

#

635

# Google Compute Engine has three Operation resources:

636

#

637

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

638

#

639

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

640

#

641

# Operations can be global, regional or zonal.

642

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

643

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

644

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

645

#

646

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

647

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

648

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

649

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

650

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

651

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

652

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

Bu Sun Kim

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

[diff] [blame]

653

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

654

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

655

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

656

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

Bu Sun Kim

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

[diff] [blame]

657

},

658

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

659

},

660

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

661

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

662

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

663

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

664

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

665

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

666

#

667

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

668

#

669

# Example 1: Pack and unpack a message in C++.

670

#

671

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

672

#

673

# Example 2: Pack and unpack a message in Java.

674

#

675

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

676

#

677

# Example 3: Pack and unpack a message in Python.

678

#

679

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

680

#

681

# Example 4: Pack and unpack a message in Go

682

#

683

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

684

#

685

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

690

#

691

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

692

#

693

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

694

#

695

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

696

#

697

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

698

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

699

#

700

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

701

#

702

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

703

#

704

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

705

#

706

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

707

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

708

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

709

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

710

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot