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

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.</p>

Sai Cheemalapati

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

[diff] [blame]

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

113

<h3>Method Details</h3>

114

Dmitry Frenkel

3e17f89

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

[diff] [blame]

115

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

116

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

120

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

121

<pre>Deletes the specified interconnect.

122

123

Args:

124

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

125

interconnect: string, Name of the interconnect to delete. (required)

Bu Sun Kim

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

[diff] [blame]

126

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.

127

128

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.

129

130

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

Sai Cheemalapati

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

[diff] [blame]

131

132

Returns:

133

An object of the form:

134

Bu Sun Kim

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

[diff] [blame]

135

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

136

#

137

# Google Compute Engine has three Operation resources:

138

#

139

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

140

#

141

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

142

#

143

# Operations can be global, regional or zonal.

144

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

145

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

146

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

147

#

148

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

149

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

150

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

151

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

152

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

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

{

Yoshi Automation Bot

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

[diff] [blame]

156

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

157

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

158

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

Bu Sun Kim

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

[diff] [blame]

159

},

160

],

Yoshi Automation Bot

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

[diff] [blame]

161

},

162

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

163

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

164

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

165

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

166

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

yoshi-code-bot

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

[diff] [blame^]

167

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

168

#

169

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

170

#

171

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

172

#

173

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

174

#

175

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

176

#

177

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

178

#

179

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

180

#

181

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

182

#

183

# Example 4: Pack and unpack a message in Go

184

#

185

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

186

#

187

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

192

#

193

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

194

#

195

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

196

#

197

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

198

#

199

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

200

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

201

#

202

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

203

#

204

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

205

#

206

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

207

#

208

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

209

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

210

},

Yoshi Automation Bot

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

[diff] [blame]

211

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

yoshi-code-bot

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

[diff] [blame^]

212

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

Yoshi Automation Bot

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

[diff] [blame]

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

{

226

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

227

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

228

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

229

{

230

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

231

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

232

},

233

],

234

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

235

},

236

],

237

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

238

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

243

<pre>Returns the specified interconnect. Get a list of available interconnects by making a list() request.

244

245

Args:

246

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

247

interconnect: string, Name of the interconnect to return. (required)

248

249

Returns:

250

An object of the form:

251

Bu Sun Kim

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

[diff] [blame]

252

{ # Represents an Interconnect resource.

Yoshi Automation Bot

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

[diff] [blame]

253

#

254

# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)

255

"adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

256

"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

257

{ # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.

258

"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.

259

"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.

260

"googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

Bu Sun Kim

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

[diff] [blame]

261

},

Yoshi Automation Bot

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

[diff] [blame]

262

],

263

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

264

"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

265

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

266

"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.

267

{ # Description of a planned outage on this Interconnect.

268

"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

269

"A String",

270

],

271

"description": "A String", # A description about the purpose of the outage.

272

"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).

273

"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:

274

# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.

275

# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.

276

"name": "A String", # Unique identifier for this outage notification.

277

"source": "A String", # The party that generated this notification, which can take the following value:

278

# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

279

"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).

280

"state": "A String", # State of this notification, which can take one of the following values:

281

# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.

282

# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.

283

},

284

],

285

"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

286

"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

287

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

288

"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

289

"A String",

290

],

291

"interconnectType": "A String", # Type of interconnect, which can take one of the following values:

292

# - PARTNER: A partner-managed interconnection shared between customers though a partner.

293

# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

294

"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.

295

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

296

#

297

# To see the latest fingerprint, make a get() request to retrieve an Interconnect.

298

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

299

"a_key": "A String",

300

},

301

"linkType": "A String", # Type of link requested, which can take one of the following values:

302

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

303

# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

304

"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.

305

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

306

"nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.

307

"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:

308

# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.

309

# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.

310

# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

311

"peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.

312

"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.

313

"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.

314

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

315

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

316

"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:

317

# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.

318

# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.

319

# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

320

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

324

<code class="details" id="getDiagnostics">getDiagnostics(project, interconnect)</code>

325

<pre>Returns the interconnectDiagnostics for the specified interconnect.

326

327

Args:

328

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

329

interconnect: string, Name of the interconnect resource to query. (required)

330

331

Returns:

332

An object of the form:

333

334

{ # Response for the InterconnectsGetDiagnosticsRequest.

Yoshi Automation Bot

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

[diff] [blame]

335

"result": { # Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.

336

"arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.

337

{ # Describing the ARP neighbor entries seen on this link

338

"ipAddress": "A String", # The IP address of this ARP neighbor.

339

"macAddress": "A String", # The MAC address of this ARP neighbor.

340

},

341

],

342

"links": [ # A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.

343

{

344

"arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled

345

{ # Describing the ARP neighbor entries seen on this link

346

"ipAddress": "A String", # The IP address of this ARP neighbor.

347

"macAddress": "A String", # The MAC address of this ARP neighbor.

348

},

349

],

350

"circuitId": "A String", # The unique ID for this link assigned during turn up by Google.

351

"googleDemarc": "A String", # The Demarc address assigned by Google and provided in the LoA.

352

"lacpStatus": {

353

"googleSystemId": "A String", # System ID of the port on Google's side of the LACP exchange.

354

"neighborSystemId": "A String", # System ID of the port on the neighbor's side of the LACP exchange.

355

"state": "A String", # The state of a LACP link, which can take one of the following values:

356

# - ACTIVE: The link is configured and active within the bundle.

357

# - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty.

Bu Sun Kim

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

[diff] [blame]

358

},

Yoshi Automation Bot

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

[diff] [blame]

359

"receivingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.

360

"state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:

361

# - OK: The value has not crossed a warning threshold.

362

# - LOW_WARNING: The value has crossed below the low warning threshold.

363

# - HIGH_WARNING: The value has crossed above the high warning threshold.

364

# - LOW_ALARM: The value has crossed below the low alarm threshold.

365

# - HIGH_ALARM: The value has crossed above the high alarm threshold.

366

"value": 3.14, # Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.

Bu Sun Kim

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

[diff] [blame]

367

},

Yoshi Automation Bot

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

[diff] [blame]

368

"transmittingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.

369

"state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:

370

# - OK: The value has not crossed a warning threshold.

371

# - LOW_WARNING: The value has crossed below the low warning threshold.

372

# - HIGH_WARNING: The value has crossed above the high warning threshold.

373

# - LOW_ALARM: The value has crossed below the low alarm threshold.

374

# - HIGH_ALARM: The value has crossed above the high alarm threshold.

375

"value": 3.14, # Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.

},

},

],

"macAddress": "A String", # The MAC address of the Interconnect's bundle interface.

380

},

381

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

385

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

Bu Sun Kim

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

[diff] [blame]

386

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

387

388

Args:

389

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

390

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

Dan O'Meara

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

[diff] [blame]

391

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

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

[diff] [blame]

392

393

Returns:

394

An object of the form:

395

Dan O'Meara

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

[diff] [blame]

396

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

Yoshi Automation Bot

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

[diff] [blame]

#

#

#

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

401

#

402

# 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

411

#

412

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

413

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

414

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

415

#

416

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

417

#

418

# Example Policy with multiple AuditConfigs:

419

#

420

# { "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" ] } ] } ] }

421

#

422

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

423

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

424

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

Bu Sun Kim

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

[diff] [blame]

425

#

Yoshi Automation Bot

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

[diff] [blame]

426

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

Bu Sun Kim

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

[diff] [blame]

427

#

Yoshi Automation Bot

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

[diff] [blame]

428

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

429

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

430

"A String",

431

],

432

"ignoreChildExemptions": True or False,

433

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

Bu Sun Kim

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

[diff] [blame]

434

},

Yoshi Automation Bot

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

[diff] [blame]

],

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

440

},

441

],

442

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

443

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

444

"bindingId": "A String",

445

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

446

#

447

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

448

#

449

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

450

#

451

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

452

#

453

# Example (Comparison):

454

#

455

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

456

#

457

# Example (Equality):

458

#

459

# 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'"

464

#

465

# Example (Data Manipulation):

466

#

467

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

468

#

469

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

470

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

471

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

472

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

473

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

Bu Sun Kim

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

[diff] [blame]

474

},

Yoshi Automation Bot

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

[diff] [blame]

475

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

476

#

477

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

478

#

479

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

480

#

481

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

486

#

487

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

488

#

489

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

490

#

491

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

492

#

493

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

498

"A String",

499

],

500

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

501

},

502

],

503

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

504

#

505

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

506

"iamOwned": True or False,

507

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

508

{ # A rule to be applied in a Policy.

509

"action": "A String", # Required

510

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

511

{ # A condition to be met.

512

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

513

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

514

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

515

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

516

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

"A String",

],

},

],

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

522

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

523

"A String",

524

],

525

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

526

{ # Specifies what kind of log the caller must write

527

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

528

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

529

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

530

},

531

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

Bu Sun Kim

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

[diff] [blame]

532

},

Yoshi Automation Bot

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

[diff] [blame]

533

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

534

#

535

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

536

#

537

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

538

#

539

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

540

#

541

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

542

"customFields": [ # Custom fields.

543

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

544

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

545

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

Bu Sun Kim

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

[diff] [blame]

546

},

Yoshi Automation Bot

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

[diff] [blame]

547

],

548

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

549

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

Bu Sun Kim

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

[diff] [blame]

550

},

Yoshi Automation Bot

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

[diff] [blame]

551

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

552

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

557

"A String",

558

],

559

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

565

#

566

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

567

#

568

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

569

#

570

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

571

#

572

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

573

#

574

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

575

#

576

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

577

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

581

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

Sai Cheemalapati

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

[diff] [blame]

582

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

583

584

Args:

585

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

Dan O'Meara

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

[diff] [blame]

586

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

587

The object takes the form of:

588

Bu Sun Kim

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

[diff] [blame]

589

{ # Represents an Interconnect resource.

Bu Sun Kim

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

[diff] [blame]

590

#

591

# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)

592

"adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

593

"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

594

{ # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.

Bu Sun Kim

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

[diff] [blame]

595

"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.

596

"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.

597

"googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

Bu Sun Kim

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

[diff] [blame]

598

},

Bu Sun Kim

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

[diff] [blame]

599

],

600

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

601

"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

602

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

603

"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

604

{ # Description of a planned outage on this Interconnect.

Bu Sun Kim

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

[diff] [blame]

605

"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

606

"A String",

607

],

608

"description": "A String", # A description about the purpose of the outage.

609

"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).

610

"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:

611

# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.

612

# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.

613

"name": "A String", # Unique identifier for this outage notification.

614

"source": "A String", # The party that generated this notification, which can take the following value:

615

# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

616

"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).

617

"state": "A String", # State of this notification, which can take one of the following values:

618

# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.

619

# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.

620

},

621

],

622

"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

623

"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

624

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

625

"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

626

"A String",

627

],

628

"interconnectType": "A String", # Type of interconnect, which can take one of the following values:

629

# - PARTNER: A partner-managed interconnection shared between customers though a partner.

630

# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

631

"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.

632

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

633

#

634

# To see the latest fingerprint, make a get() request to retrieve an Interconnect.

635

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

636

"a_key": "A String",

637

},

638

"linkType": "A String", # Type of link requested, which can take one of the following values:

639

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

640

# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

641

"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.

642

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

643

"nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.

644

"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:

645

# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.

646

# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.

647

# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

648

"peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.

649

"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.

650

"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.

651

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

652

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

653

"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:

654

# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.

655

# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.

656

# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

657

}

Sai Cheemalapati

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

[diff] [blame]

658

Bu Sun Kim

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

[diff] [blame]

659

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.

660

661

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.

662

663

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

Sai Cheemalapati

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

[diff] [blame]

664

665

Returns:

666

An object of the form:

667

Bu Sun Kim

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

[diff] [blame]

668

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

669

#

670

# Google Compute Engine has three Operation resources:

671

#

672

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

673

#

674

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

675

#

676

# Operations can be global, regional or zonal.

677

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

678

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

679

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

680

#

681

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

682

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

683

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

684

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

685

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

686

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

687

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

Bu Sun Kim

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

[diff] [blame]

688

{

Yoshi Automation Bot

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

[diff] [blame]

689

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

690

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

691

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

Bu Sun Kim

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

[diff] [blame]

692

},

693

],

Yoshi Automation Bot

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

[diff] [blame]

694

},

695

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

696

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

697

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

698

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

699

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

yoshi-code-bot

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

[diff] [blame^]

700

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

701

#

702

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

703

#

704

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

705

#

706

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

707

#

708

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

709

#

710

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

711

#

712

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

713

#

714

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

715

#

716

# Example 4: Pack and unpack a message in Go

717

#

718

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

719

#

720

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

725

#

726

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

727

#

728

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

729

#

730

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

731

#

732

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

733

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

734

#

735

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

736

#

737

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

738

#

739

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

740

#

741

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

742

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

743

},

Yoshi Automation Bot

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

[diff] [blame]

744

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

yoshi-code-bot

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

[diff] [blame^]

745

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

Yoshi Automation Bot

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

[diff] [blame]

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

{

759

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

760

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

761

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

762

{

763

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

764

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

765

},

766

],

767

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

768

},

769

],

770

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

771

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

775

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

Sai Cheemalapati

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

[diff] [blame]

776

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

777

778

Args:

779

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

Dan O'Meara

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

[diff] [blame]

780

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

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

[diff] [blame]

781

Dan O'Meara

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

[diff] [blame]

782

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

Sai Cheemalapati

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

[diff] [blame]

783

Dan O'Meara

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

[diff] [blame]

784

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

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

[diff] [blame]

785

Bu Sun Kim

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

[diff] [blame]

786

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

787

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

788

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

789

790

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.

791

792

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

793

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

yoshi-code-bot

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

[diff] [blame^]

794

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

Sai Cheemalapati

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

[diff] [blame]

795

796

Returns:

797

An object of the form:

798

799

{ # Response to the list request, and contains a list of interconnects.

Yoshi Automation Bot

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

[diff] [blame]

800

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

801

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

802

{ # Represents an Interconnect resource.

803

#

804

# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)

805

"adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

806

"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

807

{ # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.

808

"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.

809

"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.

810

"googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

Bu Sun Kim

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

[diff] [blame]

811

},

812

],

Yoshi Automation Bot

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

[diff] [blame]

813

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

814

"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

815

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

816

"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.

817

{ # Description of a planned outage on this Interconnect.

818

"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

819

"A String",

820

],

821

"description": "A String", # A description about the purpose of the outage.

822

"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).

823

"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:

824

# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.

825

# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.

826

"name": "A String", # Unique identifier for this outage notification.

827

"source": "A String", # The party that generated this notification, which can take the following value:

828

# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

829

"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).

830

"state": "A String", # State of this notification, which can take one of the following values:

831

# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.

832

# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.

833

},

834

],

835

"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

836

"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

837

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

838

"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

839

"A String",

840

],

841

"interconnectType": "A String", # Type of interconnect, which can take one of the following values:

842

# - PARTNER: A partner-managed interconnection shared between customers though a partner.

843

# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

844

"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.

845

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

846

#

847

# To see the latest fingerprint, make a get() request to retrieve an Interconnect.

848

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

849

"a_key": "A String",

850

},

851

"linkType": "A String", # Type of link requested, which can take one of the following values:

852

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

853

# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

854

"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.

855

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

856

"nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.

857

"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:

858

# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.

859

# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.

860

# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

861

"peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.

862

"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.

863

"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.

864

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

865

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

866

"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:

867

# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.

868

# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.

869

# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

Bu Sun Kim

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

[diff] [blame]

870

},

Yoshi Automation Bot

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

[diff] [blame]

871

],

872

"kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.

873

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

874

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

875

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

876

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

877

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

878

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

879

{

880

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

881

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

882

},

883

],

884

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

885

},

886

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

891

<pre>Retrieves the next page of results.

892

893

Args:

894

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

895

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

896

897

Returns:

Bu Sun Kim

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

[diff] [blame]

898

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

Sai Cheemalapati

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

[diff] [blame]

899

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

904

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

Bu Sun Kim

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

[diff] [blame]

905

<pre>Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sai Cheemalapati

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

[diff] [blame]

906

907

Args:

908

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

909

interconnect: string, Name of the interconnect to update. (required)

Dan O'Meara

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

[diff] [blame]

910

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

911

The object takes the form of:

912

Bu Sun Kim

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

[diff] [blame]

913

{ # Represents an Interconnect resource.

Bu Sun Kim

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

[diff] [blame]

914

#

915

# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)

916

"adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

917

"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

918

{ # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.

Bu Sun Kim

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

[diff] [blame]

919

"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.

920

"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.

921

"googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

Bu Sun Kim

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

[diff] [blame]

922

},

Bu Sun Kim

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

[diff] [blame]

923

],

924

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

925

"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

926

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

927

"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

928

{ # Description of a planned outage on this Interconnect.

Bu Sun Kim

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

[diff] [blame]

929

"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

930

"A String",

931

],

932

"description": "A String", # A description about the purpose of the outage.

933

"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).

934

"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:

935

# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.

936

# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.

937

"name": "A String", # Unique identifier for this outage notification.

938

"source": "A String", # The party that generated this notification, which can take the following value:

939

# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

940

"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).

941

"state": "A String", # State of this notification, which can take one of the following values:

942

# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.

943

# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.

944

},

945

],

946

"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

947

"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

948

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

949

"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

950

"A String",

951

],

952

"interconnectType": "A String", # Type of interconnect, which can take one of the following values:

953

# - PARTNER: A partner-managed interconnection shared between customers though a partner.

954

# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

955

"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.

956

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

957

#

958

# To see the latest fingerprint, make a get() request to retrieve an Interconnect.

959

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

960

"a_key": "A String",

961

},

962

"linkType": "A String", # Type of link requested, which can take one of the following values:

963

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

964

# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

965

"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.

966

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

967

"nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.

968

"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:

969

# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.

970

# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.

971

# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

972

"peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.

973

"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.

974

"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.

975

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

976

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

977

"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:

978

# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.

979

# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.

980

# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

981

}

Sai Cheemalapati

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

[diff] [blame]

982

Bu Sun Kim

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

[diff] [blame]

983

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.

984

985

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.

986

987

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

Sai Cheemalapati

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

[diff] [blame]

988

989

Returns:

990

An object of the form:

991

Bu Sun Kim

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

[diff] [blame]

992

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

993

#

994

# Google Compute Engine has three Operation resources:

995

#

996

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

997

#

998

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

999

#

1000

# Operations can be global, regional or zonal.

1001

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

1002

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

1003

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

1004

#

1005

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

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

Bu Sun Kim

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

[diff] [blame]

1012

{

Yoshi Automation Bot

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

[diff] [blame]

1013

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

1014

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

1015

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

Bu Sun Kim

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

[diff] [blame]

1016

},

1017

],

Yoshi Automation Bot

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

[diff] [blame]

1018

},

1019

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

1020

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

1021

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

1022

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

1023

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

yoshi-code-bot

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

[diff] [blame^]

1024

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

1025

#

1026

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

1027

#

1028

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

1029

#

1030

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

1031

#

1032

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

1033

#

1034

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

1035

#

1036

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

1037

#

1038

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

1039

#

1040

# Example 4: Pack and unpack a message in Go

1041

#

1042

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

1043

#

1044

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

1049

#

1050

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

1051

#

1052

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

1053

#

1054

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

1055

#

1056

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

1057

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

1058

#

1059

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

1060

#

1061

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

1062

#

1063

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

1064

#

1065

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

1066

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

1067

},

Yoshi Automation Bot

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

[diff] [blame]

1068

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

yoshi-code-bot

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

[diff] [blame^]

1069

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

Yoshi Automation Bot

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

[diff] [blame]

1070

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

1071

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

{

1083

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

1084

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

1085

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

1086

{

1087

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

1088

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

1089

},

1090

],

1091

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

1092

},

1093

],

1094

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

1095

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1099

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>

Bu Sun Kim

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

[diff] [blame]

1100

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

1101

1102

Args:

1103

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

1104

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

Dan O'Meara

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

[diff] [blame]

1105

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1106

The object takes the form of:

1107

1108

{

Yoshi Automation Bot

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

[diff] [blame]

1109

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1110

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

1111

"bindingId": "A String",

1112

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

Bu Sun Kim

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

[diff] [blame]

1113

#

Yoshi Automation Bot

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

[diff] [blame]

1114

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

Bu Sun Kim

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

[diff] [blame]

1115

#

Yoshi Automation Bot

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

[diff] [blame]

1116

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

Bu Sun Kim

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

[diff] [blame]

1117

#

1118

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

Yoshi Automation Bot

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

[diff] [blame]

1119

#

1120

# Example (Comparison):

1121

#

1122

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

1123

#

1124

# Example (Equality):

1125

#

1126

# 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'"

1131

#

1132

# Example (Data Manipulation):

1133

#

1134

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

1135

#

1136

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

1137

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

1138

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

1139

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

1140

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

1141

},

1142

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

1143

#

1144

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

1145

#

1146

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

1147

#

1148

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

1153

#

1154

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

1155

#

1156

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

1157

#

1158

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

1159

#

1160

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

1165

"A String",

1166

],

1167

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

Bu Sun Kim

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

[diff] [blame]

1168

},

Yoshi Automation Bot

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

[diff] [blame]

1169

],

1170

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1171

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

Bu Sun Kim

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

[diff] [blame]

1172

#

1173

#

1174

#

Dan O'Meara

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

[diff] [blame]

1175

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

Bu Sun Kim

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

[diff] [blame]

1176

#

Bu Sun Kim

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

[diff] [blame]

1177

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

Bu Sun Kim

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

[diff] [blame]

1178

#

Dan O'Meara

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

[diff] [blame]

1179

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1180

#

Bu Sun Kim

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

[diff] [blame]

1181

# { "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 }

Bu Sun Kim

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

[diff] [blame]

1182

#

Dan O'Meara

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

[diff] [blame]

1183

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1184

#

Bu Sun Kim

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

[diff] [blame]

1185

# 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

Bu Sun Kim

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

[diff] [blame]

1186

#

Dan O'Meara

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

[diff] [blame]

1187

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

Bu Sun Kim

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

[diff] [blame]

1188

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

Bu Sun Kim

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

[diff] [blame]

1189

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

1190

#

1191

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

1192

#

1193

# Example Policy with multiple AuditConfigs:

1194

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1195

# { "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" ] } ] } ] }

Bu Sun Kim

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

[diff] [blame]

1196

#

Dan O'Meara

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

[diff] [blame]

1197

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

Bu Sun Kim

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

[diff] [blame]

1198

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

Bu Sun Kim

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

[diff] [blame]

1199

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

1200

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1201

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

Bu Sun Kim

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

[diff] [blame]

1202

#

Bu Sun Kim

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

[diff] [blame]

1203

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

1204

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

1205

"A String",

Bu Sun Kim

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

[diff] [blame]

1206

],

Bu Sun Kim

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

[diff] [blame]

1207

"ignoreChildExemptions": True or False,

1208

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

Bu Sun Kim

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

[diff] [blame]

1209

},

1210

],

Bu Sun Kim

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

[diff] [blame]

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

Bu Sun Kim

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

[diff] [blame]

1215

},

1216

],

Bu Sun Kim

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

[diff] [blame]

1217

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

Bu Sun Kim

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

[diff] [blame]

1218

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

1219

"bindingId": "A String",

Bu Sun Kim

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

[diff] [blame]

1220

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

1221

#

1222

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

1223

#

1224

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

1225

#

1226

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

1227

#

1228

# Example (Comparison):

1229

#

1230

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

1231

#

1232

# Example (Equality):

1233

#

1234

# 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'"

1239

#

1240

# Example (Data Manipulation):

1241

#

1242

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

1243

#

1244

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

1245

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

1246

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

1247

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

1248

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

1249

},

1250

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

Bu Sun Kim

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

[diff] [blame]

1251

#

1252

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

1253

#

1254

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

1255

#

Dan O'Meara

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

[diff] [blame]

1256

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

Bu Sun Kim

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

[diff] [blame]

#

#

#

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

1261

#

1262

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

1263

#

Dan O'Meara

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

[diff] [blame]

1264

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

1265

#

1266

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

1267

#

1268

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

1269

#

Bu Sun Kim

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

[diff] [blame]

1270

#

1271

#

1272

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

Bu Sun Kim

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

[diff] [blame]

1273

"A String",

Bu Sun Kim

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

[diff] [blame]

1274

],

Bu Sun Kim

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

[diff] [blame]

1275

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

Bu Sun Kim

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

[diff] [blame]

1276

},

1277

],

Bu Sun Kim

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

[diff] [blame]

1278

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

1279

#

1280

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

1281

"iamOwned": True or False,

1282

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

1283

{ # A rule to be applied in a Policy.

1284

"action": "A String", # Required

1285

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

1286

{ # A condition to be met.

1287

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

1288

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

1289

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

1290

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

1291

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

"A String",

],

},

],

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

1297

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

1298

"A String",

1299

],

1300

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

1301

{ # Specifies what kind of log the caller must write

1302

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

1303

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

1304

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

1305

},

1306

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

1307

},

1308

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

1309

#

1310

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

1311

#

1312

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

1313

#

1314

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

1315

#

1316

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

1317

"customFields": [ # Custom fields.

1318

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

1319

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

1320

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

1321

},

1322

],

1323

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

1324

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

1325

},

1326

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

1327

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

1332

"A String",

1333

],

1334

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

1340

#

1341

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

1342

#

1343

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

1344

#

1345

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

1346

#

1347

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

1348

#

1349

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

1350

#

1351

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

Yoshi Automation Bot

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

[diff] [blame]

},

}

Returns:

An object of the form:

1358

1359

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

1364

#

1365

# 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

1374

#

1375

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

1376

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

1377

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

1378

#

1379

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

1380

#

1381

# Example Policy with multiple AuditConfigs:

1382

#

1383

# { "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" ] } ] } ] }

1384

#

1385

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

1386

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

1387

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

1388

#

1389

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

1390

#

1391

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

1392

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

1393

"A String",

1394

],

1395

"ignoreChildExemptions": True or False,

1396

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

1403

},

1404

],

1405

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

1406

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

1407

"bindingId": "A String",

1408

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

1409

#

1410

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

1411

#

1412

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

1413

#

1414

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

1415

#

1416

# Example (Comparison):

1417

#

1418

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

1419

#

1420

# Example (Equality):

1421

#

1422

# 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'"

1427

#

1428

# Example (Data Manipulation):

1429

#

1430

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

1431

#

1432

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

1433

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

1434

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

1435

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

1436

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

1437

},

1438

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

1439

#

1440

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

1441

#

1442

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

1443

#

1444

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

1449

#

1450

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

1451

#

1452

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

1453

#

1454

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

1455

#

1456

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

1461

"A String",

1462

],

1463

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

1464

},

1465

],

1466

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

1467

#

1468

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

1469

"iamOwned": True or False,

1470

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

1471

{ # A rule to be applied in a Policy.

1472

"action": "A String", # Required

1473

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

1474

{ # A condition to be met.

1475

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

1476

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

1477

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

1478

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

1479

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

"A String",

],

},

],

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

1485

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

1486

"A String",

1487

],

1488

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

1489

{ # Specifies what kind of log the caller must write

1490

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

1491

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

1492

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

1493

},

1494

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

1495

},

1496

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

1497

#

1498

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

1499

#

1500

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

1501

#

1502

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

1503

#

1504

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

1505

"customFields": [ # Custom fields.

1506

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

1507

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

1508

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

1509

},

1510

],

1511

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

1512

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

1513

},

1514

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

1515

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

1520

"A String",

1521

],

1522

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

1528

#

1529

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

1530

#

1531

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

1532

#

1533

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

1534

#

1535

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

1536

#

1537

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

1538

#

1539

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

1540

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1544

<code class="details" id="setLabels">setLabels(project, resource, body=None)</code>

Bu Sun Kim

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

[diff] [blame]

1545

<pre>Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

1546

1547

Args:

1548

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

1549

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

Dan O'Meara

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

[diff] [blame]

1550

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1551

The object takes the form of:

1552

1553

{

Yoshi Automation Bot

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

[diff] [blame]

1554

"labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.

1555

"labels": { # A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").

1556

"a_key": "A String",

1557

},

1558

}

Bu Sun Kim

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

[diff] [blame]

Returns:

An object of the form:

1563

1564

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1565

#

1566

# Google Compute Engine has three Operation resources:

1567

#

1568

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

1569

#

1570

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

1571

#

1572

# Operations can be global, regional or zonal.

1573

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

1574

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

1575

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

1576

#

1577

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

1578

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

1579

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

1580

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

1581

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

1582

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

1583

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

Bu Sun Kim

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

[diff] [blame]

1584

{

Yoshi Automation Bot

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

[diff] [blame]

1585

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

1586

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

1587

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

Bu Sun Kim

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

[diff] [blame]

1588

},

1589

],

Yoshi Automation Bot

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

[diff] [blame]

1590

},

1591

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

1592

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

1593

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

1594

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

1595

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

yoshi-code-bot

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

[diff] [blame^]

1596

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

1597

#

1598

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

1599

#

1600

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

1601

#

1602

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

1603

#

1604

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

1605

#

1606

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

1607

#

1608

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

1609

#

1610

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

1611

#

1612

# Example 4: Pack and unpack a message in Go

1613

#

1614

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

1615

#

1616

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

1621

#

1622

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

1623

#

1624

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

1625

#

1626

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

1627

#

1628

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

1629

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

1630

#

1631

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

1632

#

1633

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

1634

#

1635

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

1636

#

1637

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

1638

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

1639

},

Yoshi Automation Bot

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

[diff] [blame]

1640

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

yoshi-code-bot

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

[diff] [blame^]

1641

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

Yoshi Automation Bot