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

replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.

155

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.

156

157

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.

158

159

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

160

161

Returns:

162

An object of the form:

163

164

{ # Represents an Operation resource.

165

#

166

# Google Compute Engine has three Operation resources:

167

#

168

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

169

#

170

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

171

#

172

# Operations can be global, regional or zonal.

173

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

174

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

175

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

176

#

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

{

185

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

186

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

187

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

},

],

},

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

192

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

193

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

194

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

195

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

196

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

197

#

198

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

199

#

200

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

201

#

202

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

203

#

204

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

205

#

206

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

207

#

208

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

209

#

210

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

211

#

212

# Example 4: Pack and unpack a message in Go

213

#

214

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

215

#

216

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

221

#

222

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

223

#

224

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

225

#

226

# 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][]):

227

#

228

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

229

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

230

#

231

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

232

#

233

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

234

#

235

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

236

#

237

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

238

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

239

},

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

{

255

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

256

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

257

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

258

{

259

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

260

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

261

},

262

],

263

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

264

},

265

],

266

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

}</pre>

</div>

<code class="details" id="addRule">addRule(firewallPolicy, body=None, requestId=None)</code>

272

<pre>Inserts a rule into a firewall policy.

273

274

Args:

275

firewallPolicy: string, Name of the firewall policy to update. (required)

276

body: object, The request body.

277

The object takes the form of:

278

279

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

280

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

281

"description": "A String", # An optional description for this resource.

282

"direction": "A String", # The direction in which this rule applies.

283

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

284

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

285

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

286

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

287

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

288

"A String",

289

],

290

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

291

{

292

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

293

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

294

#

295

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

301

"A String",

302

],

303

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

304

"A String",

305

],

306

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

307

{

308

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

309

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

},

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

314

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

315

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

316

"A String",

317

],

318

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

319

"A String",

320

],

321

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

322

{

323

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

324

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

325

},

326

],

327

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

}

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.

333

334

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.

335

336

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

337

338

Returns:

339

An object of the form:

340

341

{ # Represents an Operation resource.

342

#

343

# Google Compute Engine has three Operation resources:

344

#

345

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

346

#

347

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

348

#

349

# Operations can be global, regional or zonal.

350

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

351

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

352

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

353

#

354

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

355

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

356

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

357

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

358

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

359

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

360

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

361

{

362

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

363

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

364

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

},

],

},

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

369

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

370

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

371

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

372

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

373

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

374

#

375

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

376

#

377

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

378

#

379

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

380

#

381

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

382

#

383

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

384

#

385

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

386

#

387

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

388

#

389

# Example 4: Pack and unpack a message in Go

390

#

391

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

392

#

393

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

398

#

399

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

400

#

401

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

402

#

403

# 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][]):

404

#

405

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

406

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

407

#

408

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

409

#

410

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

411

#

412

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

413

#

414

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

415

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

416

},

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

{

432

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

433

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

434

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

435

{

436

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

437

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

438

},

439

],

440

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

441

},

442

],

443

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

}</pre>

</div>

<code class="details" id="cloneRules">cloneRules(firewallPolicy, requestId=None, sourceFirewallPolicy=None)</code>

449

<pre>Copies rules to the specified firewall policy.

450

451

Args:

452

firewallPolicy: string, Name of the firewall policy to update. (required)

453

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.

454

455

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.

456

457

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

458

sourceFirewallPolicy: string, The firewall policy from which to copy rules.

459

460

Returns:

461

An object of the form:

462

463

{ # Represents an Operation resource.

464

#

465

# Google Compute Engine has three Operation resources:

466

#

467

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

468

#

469

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

470

#

471

# Operations can be global, regional or zonal.

472

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

473

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

474

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

475

#

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

{

484

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

485

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

486

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

},

],

},

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

491

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

492

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

493

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

494

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

495

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

496

#

497

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

498

#

499

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

500

#

501

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

502

#

503

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

504

#

505

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

506

#

507

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

508

#

509

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

510

#

511

# Example 4: Pack and unpack a message in Go

512

#

513

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

514

#

515

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

520

#

521

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

522

#

523

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

524

#

525

# 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][]):

526

#

527

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

528

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

529

#

530

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

531

#

532

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

533

#

534

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

535

#

536

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

537

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

538

},

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

{

554

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

555

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

556

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

557

{

558

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

559

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

560

},

561

],

562

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

563

},

564

],

565

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

}</pre>

</div>

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

571

<pre>Close httplib2 connections.</pre>

</div>

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

576

<pre>Deletes the specified policy.

577

578

Args:

579

firewallPolicy: string, Name of the firewall policy to delete. (required)

580

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.

581

582

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.

583

584

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

585

586

Returns:

587

An object of the form:

588

589

{ # Represents an Operation resource.

590

#

591

# Google Compute Engine has three Operation resources:

592

#

593

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

594

#

595

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

596

#

597

# Operations can be global, regional or zonal.

598

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

599

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

600

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

601

#

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

{

610

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

611

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

612

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

},

],

},

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

617

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

618

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

619

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

620

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

621

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

622

#

623

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

624

#

625

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

626

#

627

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

628

#

629

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

630

#

631

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

632

#

633

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

634

#

635

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

636

#

637

# Example 4: Pack and unpack a message in Go

638

#

639

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

640

#

641

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

646

#

647

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

648

#

649

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

650

#

651

# 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][]):

652

#

653

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

654

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

655

#

656

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

657

#

658

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

659

#

660

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

661

#

662

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

663

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

664

},

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

{

680

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

681

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

682

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

683

{

684

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

685

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

686

},

687

],

688

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

689

},

690

],

691

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

}</pre>

</div>

<code class="details" id="get">get(firewallPolicy)</code>

697

<pre>Returns the specified firewall policy.

698

699

Args:

700

firewallPolicy: string, Name of the firewall policy to get. (required)

701

702

Returns:

703

An object of the form:

704

705

{ # Represents a Firewall Policy resource. (== resource_for {$api_version}.firewallPolicies ==)

706

"associations": [ # A list of associations that belong to this firewall policy.

707

{

708

"attachmentTarget": "A String", # The target that the firewall policy is attached to.

709

"displayName": "A String", # [Output Only] The display name of the firewall policy of the association.

710

"firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.

711

"name": "A String", # The name for an association.

712

},

713

],

714

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

715

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

716

"displayName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy 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.

717

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

718

#

719

# To see the latest fingerprint, make get() request to the firewall policy.

720

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

721

"kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

722

"name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy.

723

"parent": "A String", # [Output Only] The parent of the firewall policy.

724

"ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

725

"rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

726

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

727

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

728

"description": "A String", # An optional description for this resource.

729

"direction": "A String", # The direction in which this rule applies.

730

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

731

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

732

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

733

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

734

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

735

"A String",

736

],

737

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

738

{

739

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

740

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

741

#

742

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

748

"A String",

749

],

750

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

751

"A String",

752

],

753

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

754

{

755

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

756

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

},

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

761

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

762

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

763

"A String",

764

],

765

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

766

"A String",

767

],

768

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

769

{

770

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

771

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

772

},

773

],

774

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

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

780

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

}</pre>

</div>

<code class="details" id="getAssociation">getAssociation(firewallPolicy, name=None)</code>

786

<pre>Gets an association with the specified name.

787

788

Args:

789

firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)

790

name: string, The name of the association to get from the firewall policy.

791

792

Returns:

793

An object of the form:

794

795

{

796

"attachmentTarget": "A String", # The target that the firewall policy is attached to.

797

"displayName": "A String", # [Output Only] The display name of the firewall policy of the association.

798

"firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.

799

"name": "A String", # The name for an association.

}</pre>

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource, optionsRequestedPolicyVersion=None)</code>

805

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

806

807

Args:

808

resource: string, Name or id of the resource for this request. (required)

809

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

810

811

Returns:

812

An object of the form:

813

814

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

819

#

820

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

829

#

830

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

831

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

832

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

833

#

834

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

835

#

836

# Example Policy with multiple AuditConfigs:

837

#

838

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

839

#

840

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

841

"auditLogConfigs": [ # The configuration for logging of each type of permission.

842

{ # Provides the configuration for logging a type of permissions. Example:

843

#

844

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

845

#

846

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

847

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

848

"A String",

849

],

850

"ignoreChildExemptions": True or False,

851

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

858

},

859

],

860

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

861

{ # Associates `members` with a `role`.

862

"bindingId": "A String",

863

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

864

#

865

# If the condition evaluates to `true`, then this binding applies to the current request.

866

#

867

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

868

#

869

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

870

#

871

# Example (Comparison):

872

#

873

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

874

#

875

# Example (Equality):

876

#

877

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

882

#

883

# Example (Data Manipulation):

884

#

885

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

886

#

887

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

888

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

889

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

890

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

891

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

892

},

893

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

894

#

895

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

896

#

897

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

898

#

899

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

904

#

905

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

906

#

907

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

908

#

909

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

910

#

911

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

916

"A String",

917

],

918

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

919

},

920

],

921

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

922

#

923

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

924

"iamOwned": True or False,

925

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

926

{ # A rule to be applied in a Policy.

927

"action": "A String", # Required

928

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

929

{ # A condition to be met.

930

"iam": "A String", # Trusted attributes supplied by the IAM system.

931

"op": "A String", # An operator to apply the subject with.

932

"svc": "A String", # Trusted attributes discharged by the service.

933

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

934

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

940

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

941

"A String",

942

],

943

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

944

{ # Specifies what kind of log the caller must write

945

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

946

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

947

"permissionType": "A String", # The type of the permission that was checked.

948

},

949

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

950

},

951

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

952

#

953

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

954

#

955

# Field names correspond to IAM request parameters and field values are their respective values.

956

#

957

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

958

#

959

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

960

"customFields": [ # Custom fields.

961

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

962

"name": "A String", # Name is the field name.

963

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

964

},

965

],

966

"field": "A String", # The field value to attribute.

967

"metric": "A String", # The metric to update.

968

},

969

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

970

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

975

"A String",

976

],

977

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

983

#

984

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

985

#

986

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

987

#

988

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

989

#

990

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

991

#

992

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

993

#

994

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

}</pre>

</div>

<code class="details" id="getRule">getRule(firewallPolicy, priority=None)</code>

1000

<pre>Gets a rule of the specified priority.

1001

1002

Args:

1003

firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)

1004

priority: integer, The priority of the rule to get from the firewall policy.

1005

1006

Returns:

1007

An object of the form:

1008

1009

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

1010

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

1011

"description": "A String", # An optional description for this resource.

1012

"direction": "A String", # The direction in which this rule applies.

1013

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

1014

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

1015

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

1016

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

1017

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1018

"A String",

1019

],

1020

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1021

{

1022

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

1023

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1024

#

1025

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1031

"A String",

1032

],

1033

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

1034

"A String",

1035

],

1036

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

1037

{

1038

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1039

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

},

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

1044

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

1045

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

1046

"A String",

1047

],

1048

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

1049

"A String",

1050

],

1051

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

1052

{

1053

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1054

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

1055

},

1056

],

1057

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

}</pre>

</div>

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

1065

<pre>Creates a new policy in the specified project using the data included in the request.

1066

1067

Args:

1068

body: object, The request body.

1069

The object takes the form of:

1070

1071

{ # Represents a Firewall Policy resource. (== resource_for {$api_version}.firewallPolicies ==)

1072

"associations": [ # A list of associations that belong to this firewall policy.

1073

{

1074

"attachmentTarget": "A String", # The target that the firewall policy is attached to.

1075

"displayName": "A String", # [Output Only] The display name of the firewall policy of the association.

1076

"firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.

1077

"name": "A String", # The name for an association.

1078

},

1079

],

1080

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

1081

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

1082

"displayName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy 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.

1083

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

1084

#

1085

# To see the latest fingerprint, make get() request to the firewall policy.

1086

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

1087

"kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

1088

"name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy.

1089

"parent": "A String", # [Output Only] The parent of the firewall policy.

1090

"ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

1091

"rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

1092

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

1093

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

1094

"description": "A String", # An optional description for this resource.

1095

"direction": "A String", # The direction in which this rule applies.

1096

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

1097

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

1098

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

1099

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

1100

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1101

"A String",

1102

],

1103

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1104

{

1105

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

1106

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1107

#

1108

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1114

"A String",

1115

],

1116

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

1117

"A String",

1118

],

1119

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

1120

{

1121

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1122

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

},

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

1127

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

1128

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

1129

"A String",

1130

],

1131

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

1132

"A String",

1133

],

1134

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

1135

{

1136

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1137

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

1138

},

1139

],

1140

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

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

1146

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

1147

}

1148

1149

parentId: string, Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.

1150

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.

1151

1152

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.

1153

1154

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

1155

1156

Returns:

1157

An object of the form:

1158

1159

{ # Represents an Operation resource.

1160

#

1161

# Google Compute Engine has three Operation resources:

1162

#

1163

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

1164

#

1165

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

1166

#

1167

# Operations can be global, regional or zonal.

1168

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

1169

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

1170

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

1171

#

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

{

1180

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

1181

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

1182

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

},

],

},

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

1187

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

1188

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

1189

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

1190

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

1191

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

1192

#

1193

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

1194

#

1195

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

1196

#

1197

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

1198

#

1199

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

1200

#

1201

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

1202

#

1203

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

1204

#

1205

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

1206

#

1207

# Example 4: Pack and unpack a message in Go

1208

#

1209

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

1210

#

1211

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

1216

#

1217

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

1218

#

1219

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

1220

#

1221

# 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][]):

1222

#

1223

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

1224

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

1225

#

1226

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

1227

#

1228

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

1229

#

1230

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

1231

#

1232

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

1233

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

1234

},

1235

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

1236

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

1237

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

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

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

1249

{

1250

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

1251

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

1252

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

1253

{

1254

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

1255

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

1256

},

1257

],

1258

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

1259

},

1260

],

1261

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

}</pre>

</div>

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

1267

<pre>Lists all the policies that have been configured for the specified project.

1268

1269

Args:

1270

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

1271

1272

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

1273

1274

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.

1275

1276

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

1277

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

1278

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

1279

1280

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.

1281

1282

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

1283

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.

1284

parentId: string, Parent ID for this request.

1285

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

1286

1287

Returns:

1288

An object of the form:

1289

1290

{

1291

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

1292

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

1293

{ # Represents a Firewall Policy resource. (== resource_for {$api_version}.firewallPolicies ==)

1294

"associations": [ # A list of associations that belong to this firewall policy.

1295

{

1296

"attachmentTarget": "A String", # The target that the firewall policy is attached to.

1297

"displayName": "A String", # [Output Only] The display name of the firewall policy of the association.

1298

"firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.

1299

"name": "A String", # The name for an association.

1300

},

1301

],

1302

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

1303

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

1304

"displayName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy 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.

1305

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

1306

#

1307

# To see the latest fingerprint, make get() request to the firewall policy.

1308

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

1309

"kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

1310

"name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy.

1311

"parent": "A String", # [Output Only] The parent of the firewall policy.

1312

"ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

1313

"rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

1314

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

1315

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

1316

"description": "A String", # An optional description for this resource.

1317

"direction": "A String", # The direction in which this rule applies.

1318

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

1319

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

1320

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

1321

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

1322

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1323

"A String",

1324

],

1325

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1326

{

1327

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

1328

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1329

#

1330

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1336

"A String",

1337

],

1338

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

1339

"A String",

1340

],

1341

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

1342

{

1343

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1344

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

},

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

1349

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

1350

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

1351

"A String",

1352

],

1353

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

1354

"A String",

1355

],

1356

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

1357

{

1358

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1359

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

1360

},

1361

],

1362

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

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

1368

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

1369

},

1370

],

1371

"kind": "compute#firewallPolicyList", # [Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies

1372

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

1373

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

1374

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

1375

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

1376

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

1377

{

1378

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

1379

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

1380

},

1381

],

1382

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

},

}</pre>

</div>

<code class="details" id="listAssociations">listAssociations(targetResource=None)</code>

1389

<pre>Lists associations of a specified target, i.e., organization or folder.

1390

1391

Args:

1392

targetResource: string, The target resource to list associations. It is an organization, or a folder.

1393

1394

Returns:

1395

An object of the form:

1396

1397

{

1398

"associations": [ # A list of associations.

1399

{

1400

"attachmentTarget": "A String", # The target that the firewall policy is attached to.

1401

"displayName": "A String", # [Output Only] The display name of the firewall policy of the association.

1402

"firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.

1403

"name": "A String", # The name for an association.

1404

},

1405

],

1406

"kind": "compute#firewallPoliciesListAssociationsResponse", # [Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations.

}</pre>

</div>

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

1412

<pre>Retrieves the next page of results.

1413

1414

Args:

1415

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

1416

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

1417

1418

Returns:

1419

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

1420

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

</pre>

</div>

<code class="details" id="move">move(firewallPolicy, parentId=None, requestId=None)</code>

1426

<pre>Moves the specified firewall policy.

1427

1428

Args:

1429

firewallPolicy: string, Name of the firewall policy to update. (required)

1430

parentId: string, The new parent of the firewall policy.

1431

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.

1432

1433

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.

1434

1435

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

1436

1437

Returns:

1438

An object of the form:

1439

1440

{ # Represents an Operation resource.

1441

#

1442

# Google Compute Engine has three Operation resources:

1443

#

1444

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

1445

#

1446

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

1447

#

1448

# Operations can be global, regional or zonal.

1449

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

1450

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

1451

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

1452

#

1453

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

1454

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

1455

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

1456

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

1457

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

1458

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

1459

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

1460

{

1461

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

1462

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

1463

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

},

],

},

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

1468

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

1469

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

1470

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

1471

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

1472

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

1473

#

1474

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

1475

#

1476

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

1477

#

1478

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

1479

#

1480

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

1481

#

1482

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

1483

#

1484

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

1485

#

1486

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

1487

#

1488

# Example 4: Pack and unpack a message in Go

1489

#

1490

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

1491

#

1492

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

1497

#

1498

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

1499

#

1500

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

1501

#

1502

# 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][]):

1503

#

1504

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

1505

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

1506

#

1507

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

1508

#

1509

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

1510

#

1511

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

1512

#

1513

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

1514

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

1515

},

1516

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

1517

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

1518

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

1519

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

1520

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

1521

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

1522

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

1523

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

1524

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

1525

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

1526

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

1527

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

1528

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

1529

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

1530

{

1531

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

1532

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

1533

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

1534

{

1535

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

1536

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

1537

},

1538

],

1539

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

1540

},

1541

],

1542

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

}</pre>

</div>

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

1548

<pre>Patches the specified policy with the data included in the request.

1549

1550

Args:

1551

firewallPolicy: string, Name of the firewall policy to update. (required)

1552

body: object, The request body.

1553

The object takes the form of:

1554

1555

{ # Represents a Firewall Policy resource. (== resource_for {$api_version}.firewallPolicies ==)

1556

"associations": [ # A list of associations that belong to this firewall policy.

1557

{

1558

"attachmentTarget": "A String", # The target that the firewall policy is attached to.

1559

"displayName": "A String", # [Output Only] The display name of the firewall policy of the association.

1560

"firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.

1561

"name": "A String", # The name for an association.

1562

},

1563

],

1564

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

1565

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

1566

"displayName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy 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.

1567

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

1568

#

1569

# To see the latest fingerprint, make get() request to the firewall policy.

1570

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

1571

"kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

1572

"name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy.

1573

"parent": "A String", # [Output Only] The parent of the firewall policy.

1574

"ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

1575

"rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

1576

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

1577

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

1578

"description": "A String", # An optional description for this resource.

1579

"direction": "A String", # The direction in which this rule applies.

1580

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

1581

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

1582

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

1583

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

1584

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1585

"A String",

1586

],

1587

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1588

{

1589

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

1590

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1591

#

1592

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1598

"A String",

1599

],

1600

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

1601

"A String",

1602

],

1603

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

1604

{

1605

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1606

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

},

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

1611

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

1612

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

1613

"A String",

1614

],

1615

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

1616

"A String",

1617

],

1618

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

1619

{

1620

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1621

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

1622

},

1623

],

1624

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

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

1630

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

1631

}

1632

1633

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.

1634

1635

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.

1636

1637

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

1638

1639

Returns:

1640

An object of the form:

1641

1642

{ # Represents an Operation resource.

1643

#

1644

# Google Compute Engine has three Operation resources:

1645

#

1646

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

1647

#

1648

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

1649

#

1650

# Operations can be global, regional or zonal.

1651

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

1652

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

1653

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

1654

#

1655

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

1656

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

1657

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

1658

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

1659

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

1660

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

1661

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

1662

{

1663

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

1664

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

1665

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

},

],

},

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

1670

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

1671

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

1672

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

1673

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

1674

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

1675

#

1676

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

1677

#

1678

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

1679

#

1680

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

1681

#

1682

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

1683

#

1684

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

1685

#

1686

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

1687

#

1688

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

1689

#

1690

# Example 4: Pack and unpack a message in Go

1691

#

1692

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

1693

#

1694

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

1699

#

1700

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

1701

#

1702

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

1703

#

1704

# 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][]):

1705

#

1706

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

1707

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

1708

#

1709

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

1710

#

1711

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

1712

#

1713

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

1714

#

1715

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

1716

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

1717

},

1718

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

1719

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

1720

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

1721

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

1722

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

1723

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

1724

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

1725

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

1726

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

1727

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

1728

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

1729

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

1730

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

1731

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

1732

{

1733

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

1734

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

1735

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

1736

{

1737

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

1738

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

1739

},

1740

],

1741

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

1742

},

1743

],

1744

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

}</pre>

</div>

<code class="details" id="patchRule">patchRule(firewallPolicy, body=None, priority=None, requestId=None)</code>

1750

<pre>Patches a rule of the specified priority.

1751

1752

Args:

1753

firewallPolicy: string, Name of the firewall policy to update. (required)

1754

body: object, The request body.

1755

The object takes the form of:

1756

1757

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

1758

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

1759

"description": "A String", # An optional description for this resource.

1760

"direction": "A String", # The direction in which this rule applies.

1761

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

1762

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

1763

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

1764

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

1765

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1766

"A String",

1767

],

1768

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1769

{

1770

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

1771

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1772

#

1773

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1779

"A String",

1780

],

1781

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

1782

"A String",

1783

],

1784

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

1785

{

1786

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1787

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

},

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

1792

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

1793

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

1794

"A String",

1795

],

1796

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

1797

"A String",

1798

],

1799

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

1800

{

1801

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

1802

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

1803

},

1804

],

1805

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

}

priority: integer, The priority of the rule to patch.

1811

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.

1812

1813

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.

1814

1815

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

1816

1817

Returns:

1818

An object of the form:

1819

1820

{ # Represents an Operation resource.

1821

#

1822

# Google Compute Engine has three Operation resources:

1823

#

1824

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

1825

#

1826

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

1827

#

1828

# Operations can be global, regional or zonal.

1829

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

1830

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

1831

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

1832

#

1833

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

1834

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

1835

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

1836

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

1837

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

1838

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

1839

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

1840

{

1841

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

1842

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

1843

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

},

],

},

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

1848

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

1849

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

1850

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

1851

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

1852

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

1853

#

1854

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

1855

#

1856

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

1857

#

1858

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

1859

#

1860

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

1861

#

1862

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

1863

#

1864

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

1865

#

1866

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

1867

#

1868

# Example 4: Pack and unpack a message in Go

1869

#

1870

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

1871

#

1872

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

1877

#

1878

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

1879

#

1880

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

1881

#

1882

# 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][]):

1883

#

1884

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

1885

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

1886

#

1887

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

1888

#

1889

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

1890

#

1891

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

1892

#

1893

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

1894

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

1895

},

1896

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

1897

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

1898

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

1899

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

1900

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

1901

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

1902

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

1903

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

1904

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

1905

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

1906

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

1907

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

1908

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

1909

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

1910

{

1911

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

1912

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

1913

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

1914

{

1915

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

1916

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

1917

},

1918

],

1919

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

1920

},

1921

],

1922

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

}</pre>

</div>

<code class="details" id="removeAssociation">removeAssociation(firewallPolicy, name=None, requestId=None)</code>

1928

<pre>Removes an association for the specified firewall policy.

1929

1930

Args:

1931

firewallPolicy: string, Name of the firewall policy to update. (required)

1932

name: string, Name for the attachment that will be removed.

1933

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.

1934

1935

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.

1936

1937

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

1938

1939

Returns:

1940

An object of the form:

1941

1942

{ # Represents an Operation resource.

1943

#

1944

# Google Compute Engine has three Operation resources:

1945

#

1946

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

1947

#

1948

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

1949

#

1950

# Operations can be global, regional or zonal.

1951

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

1952

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

1953

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

1954

#

1955

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

1956

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

1957

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

1958

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

1959

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

1960

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

1961

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

1962

{

1963

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

1964

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

1965

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

},

],

},

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

1970

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

1971

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

1972

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

1973

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

1974

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

1975

#

1976

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

1977

#

1978

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

1979

#

1980

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

1981

#

1982

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

1983

#

1984

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

1985

#

1986

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

1987

#

1988

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

1989

#

1990

# Example 4: Pack and unpack a message in Go

1991

#

1992

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

1993

#

1994

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

1999

#

2000

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

2001

#

2002

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

2003

#

2004

# 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][]):

2005

#

2006

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

2007

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

2008

#

2009

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

2010

#

2011

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

2012

#

2013

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

2014

#

2015

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

2016

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

2017

},

2018

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

2019

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

2020

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

2021

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

2022

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

2023

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

2024

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

2025

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

2026

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

2027

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

2028

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

2029

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

2030

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

2031

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

2032

{

2033

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

2034

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

2035

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

2036

{

2037

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

2038

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

2039

},

2040

],

2041

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

2042

},

2043

],

2044

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

}</pre>

</div>

<code class="details" id="removeRule">removeRule(firewallPolicy, priority=None, requestId=None)</code>

2050

<pre>Deletes a rule of the specified priority.

2051

2052

Args:

2053

firewallPolicy: string, Name of the firewall policy to update. (required)

2054

priority: integer, The priority of the rule to remove from the firewall policy.

2055

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.

2056

2057

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.

2058

2059

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

2060

2061

Returns:

2062

An object of the form:

2063

2064

{ # Represents an Operation resource.

2065

#

2066

# Google Compute Engine has three Operation resources:

2067

#

2068

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

2069

#

2070

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

2071

#

2072

# Operations can be global, regional or zonal.

2073

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

2074

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

2075

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

2076

#

2077

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

2078

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

2079

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

2080

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

2081

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

2082

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

2083

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

2084

{

2085

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

2086

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

2087

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

},

],

},

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

2092

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

2093

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

2094

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

2095

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

2096

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

2097

#

2098

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

2099

#

2100

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

2101

#

2102

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

2103

#

2104

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

2105

#

2106

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

2107

#

2108

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

2109

#

2110

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

2111

#

2112

# Example 4: Pack and unpack a message in Go

2113

#

2114

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

2115

#

2116

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

2121

#

2122

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

2123

#

2124

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

2125

#

2126

# 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][]):

2127

#

2128

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

2129

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

2130

#

2131

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

2132

#

2133

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

2134

#

2135

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

2136

#

2137

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

2138

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

2139

},

2140

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

2141

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

2142

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

2143

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

2144

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

2145

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

2146

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

2147

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

2148

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

2149

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

2150

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

2151

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

2152

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

2153

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

2154

{

2155

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

2156

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

2157

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

2158

{

2159

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

2160

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

2161

},

2162

],

2163

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

2164

},

2165

],

2166

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

}</pre>

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None)</code>

2172

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

2173

2174

Args:

2175

resource: string, Name or id of the resource for this request. (required)

2176

body: object, The request body.

2177

The object takes the form of:

2178

2179

{

2180

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

2181

{ # Associates `members` with a `role`.

2182

"bindingId": "A String",

2183

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

2184

#

2185

# If the condition evaluates to `true`, then this binding applies to the current request.

2186

#

2187

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

2188

#

2189

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2190

#

2191

# Example (Comparison):

2192

#

2193

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2194

#

2195

# Example (Equality):

2196

#

2197

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

2202

#

2203

# Example (Data Manipulation):

2204

#

2205

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2206

#

2207

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

2208

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

2209

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2210

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

2211

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

2212

},

2213

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

2214

#

2215

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

2216

#

2217

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2218

#

2219

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

2224

#

2225

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2226

#

2227

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

2228

#

2229

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

2230

#

2231

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

2236

"A String",

2237

],

2238

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2239

},

2240

],

2241

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

2242

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

2247

#

2248

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

2257

#

2258

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

2259

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2260

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

2261

#

2262

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

2263

#

2264

# Example Policy with multiple AuditConfigs:

2265

#

2266

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

2267

#

2268

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

2269

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2270

{ # Provides the configuration for logging a type of permissions. Example:

2271

#

2272

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

2273

#

2274

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

2275

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

2276

"A String",

2277

],

2278

"ignoreChildExemptions": True or False,

2279

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

2286

},

2287

],

2288

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

2289

{ # Associates `members` with a `role`.

2290

"bindingId": "A String",

2291

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

2292

#

2293

# If the condition evaluates to `true`, then this binding applies to the current request.

2294

#

2295

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

2296

#

2297

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2298

#

2299

# Example (Comparison):

2300

#

2301

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2302

#

2303

# Example (Equality):

2304

#

2305

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

2310

#

2311

# Example (Data Manipulation):

2312

#

2313

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2314

#

2315

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

2316

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

2317

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2318

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

2319

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

2320

},

2321

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

2322

#

2323

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

2324

#

2325

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2326

#

2327

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

2332

#

2333

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2334

#

2335

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

2336

#

2337

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

2338

#

2339

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

2344

"A String",

2345

],

2346

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2347

},

2348

],

2349

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

2350

#

2351

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2352

"iamOwned": True or False,

2353

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

2354

{ # A rule to be applied in a Policy.

2355

"action": "A String", # Required

2356

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

2357

{ # A condition to be met.

2358

"iam": "A String", # Trusted attributes supplied by the IAM system.

2359

"op": "A String", # An operator to apply the subject with.

2360

"svc": "A String", # Trusted attributes discharged by the service.

2361

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

2362

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

2368

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2369

"A String",

2370

],

2371

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

2372

{ # Specifies what kind of log the caller must write

2373

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

2374

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

2375

"permissionType": "A String", # The type of the permission that was checked.

2376

},

2377

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

2378

},

2379

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

2380

#

2381

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

2382

#

2383

# Field names correspond to IAM request parameters and field values are their respective values.

2384

#

2385

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

2386

#

2387

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

2388

"customFields": [ # Custom fields.

2389

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2390

"name": "A String", # Name is the field name.

2391

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

2392

},

2393

],

2394

"field": "A String", # The field value to attribute.

2395

"metric": "A String", # The metric to update.

2396

},

2397

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2398

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2403

"A String",

2404

],

2405

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2411

#

2412

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2413

#

2414

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2415

#

2416

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

2417

#

2418

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2419

#

2420

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2421

#

2422

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

},

}

Returns:

An object of the form:

2429

2430

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

2435

#

2436

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

2445

#

2446

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

2447

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2448

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

2449

#

2450

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

2451

#

2452

# Example Policy with multiple AuditConfigs:

2453

#

2454

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

2455

#

2456

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

2457

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2458

{ # Provides the configuration for logging a type of permissions. Example:

2459

#

2460

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

2461

#

2462

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

2463

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

2464

"A String",

2465

],

2466

"ignoreChildExemptions": True or False,

2467

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

2474

},

2475

],

2476

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

2477

{ # Associates `members` with a `role`.

2478

"bindingId": "A String",

2479

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

2480

#

2481

# If the condition evaluates to `true`, then this binding applies to the current request.

2482

#

2483

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

2484

#

2485

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2486

#

2487

# Example (Comparison):

2488

#

2489

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2490

#

2491

# Example (Equality):

2492

#

2493

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

2498

#

2499

# Example (Data Manipulation):

2500

#

2501

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2502

#

2503

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

2504

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

2505

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2506

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

2507

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

2508

},

2509

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

2510

#

2511

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

2512

#

2513

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2514

#

2515

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

2520

#

2521

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2522

#

2523

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

2524

#

2525

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

2526

#

2527

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

2532

"A String",

2533

],

2534

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2535

},

2536

],

2537

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

2538

#

2539

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2540

"iamOwned": True or False,

2541

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

2542

{ # A rule to be applied in a Policy.

2543

"action": "A String", # Required

2544

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

2545

{ # A condition to be met.

2546

"iam": "A String", # Trusted attributes supplied by the IAM system.

2547

"op": "A String", # An operator to apply the subject with.

2548

"svc": "A String", # Trusted attributes discharged by the service.

2549

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

2550

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

2556

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2557

"A String",

2558

],

2559

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

2560

{ # Specifies what kind of log the caller must write

2561

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

2562

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

2563

"permissionType": "A String", # The type of the permission that was checked.

2564

},

2565

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

2566

},

2567

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

2568

#

2569

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

2570

#

2571

# Field names correspond to IAM request parameters and field values are their respective values.

2572

#

2573

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

2574

#

2575

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

2576

"customFields": [ # Custom fields.

2577

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2578

"name": "A String", # Name is the field name.

2579

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

2580

},

2581

],

2582

"field": "A String", # The field value to attribute.

2583

"metric": "A String", # The metric to update.

2584

},

2585

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2586

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2591

"A String",

2592

],

2593

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2599

#

2600

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2601

#

2602

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2603

#

2604

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

2605

#

2606

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2607

#

2608

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2609

#

2610

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None)</code>

2616

<pre>Returns permissions that a caller has on the specified resource.

2617

2618