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

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

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of interconnect attachments.</p>

80

81

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

82

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

83

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

Sai Cheemalapati

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

[diff] [blame]

87

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

88

<p class="firstline">Deletes the specified interconnect attachment.</p>

89

90

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

91

<p class="firstline">Returns the specified interconnect attachment.</p>

92

Dan O'Meara

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

[diff] [blame]

93

<code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

94

<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>

95

Dan O'Meara

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

<p class="firstline">Creates an InterconnectAttachment in the specified project using the data included in the request.</p>

98

Bu Sun Kim

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

[diff] [blame]

99

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

Sai Cheemalapati

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

[diff] [blame]

100

<p class="firstline">Retrieves the list of interconnect attachments contained within the specified region.</p>

101

102

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

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<p class="firstline">Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

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

116

<h3>Method Details</h3>

117

Bu Sun Kim

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

[diff] [blame]

118

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

Sai Cheemalapati

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

[diff] [blame]

119

<pre>Retrieves an aggregated list of interconnect attachments.

120

121

Args:

122

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

Dan O'Meara

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

[diff] [blame]

123

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]

124

Dan O'Meara

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

[diff] [blame]

125

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]

126

Dan O'Meara

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

[diff] [blame]

127

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]

128

Bu Sun Kim

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

[diff] [blame]

129

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

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

[diff] [blame]

130

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

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

[diff] [blame]

131

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

132

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

133

134

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.

135

136

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

137

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]

138

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]

139

140

Returns:

141

An object of the form:

142

143

{

Yoshi Automation Bot

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

[diff] [blame]

144

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

145

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

146

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

147

"interconnectAttachments": [ # A list of interconnect attachments contained in this scope.

148

{ # Represents an Interconnect Attachment (VLAN) resource.

149

#

150

# You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)

151

"adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

152

"bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:

153

# - BPS_50M: 50 Mbit/s

154

# - BPS_100M: 100 Mbit/s

155

# - BPS_200M: 200 Mbit/s

156

# - BPS_300M: 300 Mbit/s

157

# - BPS_400M: 400 Mbit/s

158

# - BPS_500M: 500 Mbit/s

# - BPS_1G: 1 Gbit/s

# - BPS_2G: 2 Gbit/s

# - BPS_5G: 5 Gbit/s

# - BPS_10G: 10 Gbit/s

163

# - BPS_20G: 20 Gbit/s

164

# - BPS_50G: 50 Gbit/s

165

"candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

166

"A String",

Sai Cheemalapati

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

[diff] [blame]

167

],

Yoshi Automation Bot

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

[diff] [blame]

168

"cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

169

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

170

"customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

171

"dataplaneVersion": 42, # [Output Only] Dataplane version for this InterconnectAttachment.

172

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

173

"edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

174

# - AVAILABILITY_DOMAIN_ANY

175

# - AVAILABILITY_DOMAIN_1

176

# - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.

177

"encryption": "A String", # Indicates the user-supplied encryption option of this interconnect attachment:

178

# - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

179

# - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.

Yoshi Automation Bot

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

[diff] [blame]

180

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

181

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

182

"interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.

183

"ipsecInternalAddresses": [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway's IP address will be allocated from regional external IP address pool.

184

"A String",

185

],

186

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

187

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, 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.

188

#

189

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

190

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

191

"a_key": "A String",

192

},

193

"mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

194

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

195

"operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:

196

# - OS_ACTIVE: The attachment has been turned up and is ready to use.

197

# - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

198

"pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

199

"partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

200

"partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

201

"interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.

202

"partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

203

"portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.

204

},

205

"privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

206

"tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

207

},

208

"region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

209

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

210

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

211

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

212

"state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:

213

# - ACTIVE: The attachment has been turned up and is ready to use.

214

# - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

215

# - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.

216

# - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.

217

# - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.

218

# - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.

219

"type": "A String", # The type of interconnect attachment this is, which can take one of the following values:

220

# - DEDICATED: an attachment to a Dedicated Interconnect.

221

# - PARTNER: an attachment to a Partner Interconnect, created by the customer.

222

# - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.

223

"vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.

Bu Sun Kim

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

[diff] [blame]

224

},

225

],

Yoshi Automation Bot

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

[diff] [blame]

226

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

227

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

228

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

229

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

230

{

231

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

232

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

233

},

234

],

235

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

236

},

Bu Sun Kim

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

[diff] [blame]

237

},

Yoshi Automation Bot

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

[diff] [blame]

238

},

239

"kind": "compute#interconnectAttachmentAggregatedList", # [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.

240

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

241

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

242

"unreachables": [ # [Output Only] Unreachable resources.

243

"A String",

244

],

245

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

246

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

247

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

248

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

249

{

250

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

251

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

252

},

253

],

254

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

255

},

256

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

261

<pre>Retrieves the next page of results.

262

263

Args:

264

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

265

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

266

267

Returns:

Bu Sun Kim

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

[diff] [blame]

268

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

Sai Cheemalapati

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

[diff] [blame]

269

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

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

274

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

275

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

279

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

280

<pre>Deletes the specified interconnect attachment.

281

282

Args:

283

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

284

region: string, Name of the region for this request. (required)

285

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

Bu Sun Kim

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

[diff] [blame]

286

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.

287

288

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.

289

290

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]

291

292

Returns:

293

An object of the form:

294

Bu Sun Kim

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

[diff] [blame]

295

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

296

#

297

# Google Compute Engine has three Operation resources:

298

#

299

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

300

#

301

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

302

#

303

# Operations can be global, regional or zonal.

304

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

305

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

306

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

307

#

308

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

309

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

310

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

311

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

312

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

313

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

314

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

Bu Sun Kim

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

[diff] [blame]

315

{

Yoshi Automation Bot

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

[diff] [blame]

316

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

317

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

318

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

Bu Sun Kim

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

[diff] [blame]

319

},

320

],

Yoshi Automation Bot

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

[diff] [blame]

321

},

322

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

323

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

324

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

325

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

326

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

327

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

328

#

329

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

330

#

331

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

332

#

333

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

334

#

335

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

336

#

337

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

338

#

339

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

340

#

341

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

342

#

343

# Example 4: Pack and unpack a message in Go

344

#

345

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

346

#

347

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

352

#

353

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

354

#

355

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

356

#

357

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

358

#

359

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

360

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

361

#

362

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

363

#

364

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

365

#

366

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

367

#

368

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

369

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

370

},

Yoshi Automation Bot

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

[diff] [blame]

371

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

yoshi-code-bot

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

[diff] [blame]

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

{

386

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

387

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

388

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

389

{

390

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

391

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

392

},

393

],

394

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

395

},

396

],

397

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

398

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

403

<pre>Returns the specified interconnect attachment.

404

405

Args:

406

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

407

region: string, Name of the region for this request. (required)

408

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

409

410

Returns:

411

An object of the form:

412

Bu Sun Kim

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

[diff] [blame]

413

{ # Represents an Interconnect Attachment (VLAN) resource.

Yoshi Automation Bot

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

[diff] [blame]

414

#

415

# You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)

416

"adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

417

"bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:

418

# - BPS_50M: 50 Mbit/s

419

# - BPS_100M: 100 Mbit/s

420

# - BPS_200M: 200 Mbit/s

421

# - BPS_300M: 300 Mbit/s

422

# - BPS_400M: 400 Mbit/s

423

# - BPS_500M: 500 Mbit/s

# - BPS_1G: 1 Gbit/s

# - BPS_2G: 2 Gbit/s

# - BPS_5G: 5 Gbit/s

# - BPS_10G: 10 Gbit/s

428

# - BPS_20G: 20 Gbit/s

429

# - BPS_50G: 50 Gbit/s

430

"candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

431

"A String",

432

],

433

"cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

434

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

435

"customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

436

"dataplaneVersion": 42, # [Output Only] Dataplane version for this InterconnectAttachment.

437

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

438

"edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

439

# - AVAILABILITY_DOMAIN_ANY

440

# - AVAILABILITY_DOMAIN_1

441

# - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.

442

"encryption": "A String", # Indicates the user-supplied encryption option of this interconnect attachment:

443

# - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

444

# - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.

Yoshi Automation Bot

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

[diff] [blame]

445

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

446

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

447

"interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.

448

"ipsecInternalAddresses": [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway's IP address will be allocated from regional external IP address pool.

449

"A String",

450

],

451

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

452

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, 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.

Bu Sun Kim

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

[diff] [blame]

453

#

Yoshi Automation Bot

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

[diff] [blame]

454

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

455

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

456

"a_key": "A String",

457

},

458

"mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

459

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

460

"operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:

461

# - OS_ACTIVE: The attachment has been turned up and is ready to use.

462

# - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

463

"pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

464

"partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

465

"partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

466

"interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.

467

"partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

468

"portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.

469

},

470

"privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

471

"tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

472

},

473

"region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

474

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

475

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

476

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

477

"state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:

478

# - ACTIVE: The attachment has been turned up and is ready to use.

479

# - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

480

# - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.

481

# - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.

482

# - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.

483

# - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.

484

"type": "A String", # The type of interconnect attachment this is, which can take one of the following values:

485

# - DEDICATED: an attachment to a Dedicated Interconnect.

486

# - PARTNER: an attachment to a Partner Interconnect, created by the customer.

487

# - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.

488

"vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.

489

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

493

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

Sai Cheemalapati

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

[diff] [blame]

494

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

495

496

Args:

497

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

498

region: string, The name of the region for this request. (required)

Bu Sun Kim

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

[diff] [blame]

499

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

Dan O'Meara

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

[diff] [blame]

500

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

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

[diff] [blame]

501

502

Returns:

503

An object of the form:

504

Dan O'Meara

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

[diff] [blame]

505

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

510

#

511

# 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

520

#

521

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

522

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

523

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

524

#

525

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

526

#

527

# Example Policy with multiple AuditConfigs:

528

#

529

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

530

#

531

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

532

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

533

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

Bu Sun Kim

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

[diff] [blame]

534

#

Yoshi Automation Bot

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

[diff] [blame]

535

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

536

#

Yoshi Automation Bot

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

[diff] [blame]

537

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

538

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

539

"A String",

540

],

541

"ignoreChildExemptions": True or False,

542

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

Bu Sun Kim

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

[diff] [blame]

543

},

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.

549

},

550

],

551

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

552

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

553

"bindingId": "A String",

554

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

555

#

556

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

557

#

558

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

559

#

560

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

561

#

562

# Example (Comparison):

563

#

564

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

565

#

566

# Example (Equality):

567

#

568

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

573

#

574

# Example (Data Manipulation):

575

#

576

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

577

#

578

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

579

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

580

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

581

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

582

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

Sai Cheemalapati

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

[diff] [blame]

583

},

Yoshi Automation Bot

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

[diff] [blame]

584

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

585

#

586

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

587

#

588

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

589

#

590

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

595

#

596

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

597

#

598

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

599

#

600

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

601

#

602

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

607

"A String",

608

],

609

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

610

},

611

],

612

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

613

#

614

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

615

"iamOwned": True or False,

616

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

617

{ # A rule to be applied in a Policy.

618

"action": "A String", # Required

619

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

620

{ # A condition to be met.

621

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

622

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

623

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

624

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

625

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

"A String",

],

},

],

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

631

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

632

"A String",

633

],

634

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

635

{ # Specifies what kind of log the caller must write

636

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

637

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

638

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

639

},

640

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

641

},

Yoshi Automation Bot

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

[diff] [blame]

642

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

643

#

644

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

645

#

646

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

647

#

648

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

649

#

650

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

651

"customFields": [ # Custom fields.

652

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

653

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

654

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

655

},

Yoshi Automation Bot

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

[diff] [blame]

656

],

657

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

658

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

Bu Sun Kim

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

[diff] [blame]

659

},

Yoshi Automation Bot

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

[diff] [blame]

660

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

661

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

666

"A String",

667

],

668

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

674

#

675

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

676

#

677

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

678

#

679

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

680

#

681

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

682

#

683

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

684

#

685

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

686

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

690

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

Sai Cheemalapati

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

[diff] [blame]

691

<pre>Creates an InterconnectAttachment in the specified project using the data included in the request.

692

693

Args:

694

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

695

region: string, Name of the region for this request. (required)

Dan O'Meara

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

[diff] [blame]

696

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

697

The object takes the form of:

698

Bu Sun Kim

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

[diff] [blame]

699

{ # Represents an Interconnect Attachment (VLAN) resource.

Bu Sun Kim

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

[diff] [blame]

700

#

701

# You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)

702

"adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

703

"bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:

704

# - BPS_50M: 50 Mbit/s

705

# - BPS_100M: 100 Mbit/s

706

# - BPS_200M: 200 Mbit/s

707

# - BPS_300M: 300 Mbit/s

708

# - BPS_400M: 400 Mbit/s

709

# - BPS_500M: 500 Mbit/s

# - BPS_1G: 1 Gbit/s

# - BPS_2G: 2 Gbit/s

# - BPS_5G: 5 Gbit/s

# - BPS_10G: 10 Gbit/s

714

# - BPS_20G: 20 Gbit/s

715

# - BPS_50G: 50 Gbit/s

716

"candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

717

"A String",

718

],

719

"cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

720

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

721

"customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

Bu Sun Kim

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

[diff] [blame]

722

"dataplaneVersion": 42, # [Output Only] Dataplane version for this InterconnectAttachment.

Bu Sun Kim

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

[diff] [blame]

723

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

724

"edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

725

# - AVAILABILITY_DOMAIN_ANY

726

# - AVAILABILITY_DOMAIN_1

727

# - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.

Bu Sun Kim

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

[diff] [blame]

728

"encryption": "A String", # Indicates the user-supplied encryption option of this interconnect attachment:

729

# - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

730

# - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.

Bu Sun Kim

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

[diff] [blame]

731

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

732

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

733

"interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

734

"ipsecInternalAddresses": [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway's IP address will be allocated from regional external IP address pool.

735

"A String",

736

],

Bu Sun Kim

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

[diff] [blame]

737

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

738

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, 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.

Bu Sun Kim

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

[diff] [blame]

739

#

Bu Sun Kim

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

[diff] [blame]

740

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

741

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

742

"a_key": "A String",

743

},

744

"mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

745

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

746

"operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:

747

# - OS_ACTIVE: The attachment has been turned up and is ready to use.

748

# - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

749

"pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

750

"partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

751

"partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

752

"interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.

753

"partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

754

"portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.

755

},

756

"privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

757

"tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

758

},

759

"region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

760

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

761

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

762

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

763

"state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:

764

# - ACTIVE: The attachment has been turned up and is ready to use.

765

# - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

766

# - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.

767

# - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.

768

# - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.

769

# - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.

770

"type": "A String", # The type of interconnect attachment this is, which can take one of the following values:

771

# - DEDICATED: an attachment to a Dedicated Interconnect.

772

# - PARTNER: an attachment to a Partner Interconnect, created by the customer.

773

# - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.

774

"vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.

775

}

Sai Cheemalapati

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

[diff] [blame]

776

Bu Sun Kim

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

[diff] [blame]

777

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.

778

779

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.

780

781

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

782

validateOnly: boolean, If true, the request will not be committed.

Sai Cheemalapati

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

[diff] [blame]

783

784

Returns:

785

An object of the form:

786

Bu Sun Kim

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

[diff] [blame]

787

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

788

#

789

# Google Compute Engine has three Operation resources:

790

#

791

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

792

#

793

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

794

#

795

# Operations can be global, regional or zonal.

796

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

797

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

798

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

799

#

800

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

801

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

802

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

803

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

804

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

805

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

806

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

Bu Sun Kim

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

[diff] [blame]

807

{

Yoshi Automation Bot

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

[diff] [blame]

808

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

809

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

810

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

Bu Sun Kim

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

[diff] [blame]

811

},

812

],

Yoshi Automation Bot

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

[diff] [blame]

813

},

814

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

815

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

816

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

817

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

818

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

819

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

820

#

821

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

822

#

823

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

824

#

825

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

826

#

827

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

828

#

829

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

830

#

831

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

832

#

833

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

834

#

835

# Example 4: Pack and unpack a message in Go

836

#

837

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

838

#

839

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

844

#

845

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

846

#

847

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

848

#

849

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

850

#

851

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

852

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

853

#

854

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

855

#

856

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

857

#

858

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

859

#

860

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

861

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

862

},

Yoshi Automation Bot

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

[diff] [blame]

863

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

yoshi-code-bot

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

[diff] [blame]

864

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

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

{

878

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

879

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

880

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

881

{

882

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

883

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

884

},

885

],

886

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

887

},

888

],

889

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

890

}</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]

894

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

Sai Cheemalapati

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

[diff] [blame]

895

<pre>Retrieves the list of interconnect attachments contained within the specified region.

896

897

Args:

898

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

899

region: string, Name of the region for this request. (required)

Dan O'Meara

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

[diff] [blame]

900

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]

901

Dan O'Meara

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

[diff] [blame]

902

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]

903

Dan O'Meara

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

[diff] [blame]

904

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]

905

Bu Sun Kim

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

[diff] [blame]

906

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

907

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

908

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

909

910

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.

911

912

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

913

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]

914

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]

915

916

Returns:

917

An object of the form:

918

919

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

Yoshi Automation Bot

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

[diff] [blame]

920

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

921

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

922

{ # Represents an Interconnect Attachment (VLAN) resource.

923

#

924

# You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)

925

"adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

926

"bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:

927

# - BPS_50M: 50 Mbit/s

928

# - BPS_100M: 100 Mbit/s

929

# - BPS_200M: 200 Mbit/s

930

# - BPS_300M: 300 Mbit/s

931

# - BPS_400M: 400 Mbit/s

932

# - BPS_500M: 500 Mbit/s

# - BPS_1G: 1 Gbit/s

# - BPS_2G: 2 Gbit/s

# - BPS_5G: 5 Gbit/s

# - BPS_10G: 10 Gbit/s

937

# - BPS_20G: 20 Gbit/s

938

# - BPS_50G: 50 Gbit/s

939

"candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

940

"A String",

941

],

942

"cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

943

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

944

"customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

945

"dataplaneVersion": 42, # [Output Only] Dataplane version for this InterconnectAttachment.

946

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

947

"edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

948

# - AVAILABILITY_DOMAIN_ANY

949

# - AVAILABILITY_DOMAIN_1

950

# - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.

951

"encryption": "A String", # Indicates the user-supplied encryption option of this interconnect attachment:

952

# - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

953

# - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.

Yoshi Automation Bot

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

[diff] [blame]

954

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

955

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

956

"interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.

957

"ipsecInternalAddresses": [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway's IP address will be allocated from regional external IP address pool.

958

"A String",

959

],

960

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

961

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, 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.

Bu Sun Kim

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

[diff] [blame]

962

#

Yoshi Automation Bot

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

[diff] [blame]

963

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

964

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

965

"a_key": "A String",

966

},

967

"mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

968

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

969

"operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:

970

# - OS_ACTIVE: The attachment has been turned up and is ready to use.

971

# - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

972

"pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

973

"partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

974

"partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

975

"interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.

976

"partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

977

"portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.

978

},

979

"privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

980

"tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

981

},

982

"region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

983

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

984

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

985

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

986

"state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:

987

# - ACTIVE: The attachment has been turned up and is ready to use.

988

# - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

989

# - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.

990

# - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.

991

# - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.

992

# - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.

993

"type": "A String", # The type of interconnect attachment this is, which can take one of the following values:

994

# - DEDICATED: an attachment to a Dedicated Interconnect.

995

# - PARTNER: an attachment to a Partner Interconnect, created by the customer.

996

# - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.

997

"vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.

998

},

999

],

1000

"kind": "compute#interconnectAttachmentList", # [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.

1001

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

1002

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

1003

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

1004

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

1005

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

1006

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

1007

{

1008

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

1009

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

Bu Sun Kim

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

[diff] [blame]

1010

},

Sai Cheemalapati

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

[diff] [blame]

1011

],

Yoshi Automation Bot

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

[diff] [blame]

1012

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

1013

},

1014

}</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>

1019

<pre>Retrieves the next page of results.

1020

1021

Args:

1022

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

1023

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

1024

1025

Returns:

Bu Sun Kim

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

[diff] [blame]

1026

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

Sai Cheemalapati

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

[diff] [blame]

1027

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]

1032

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

Bu Sun Kim

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

[diff] [blame]

1033

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

1034

1035

Args:

1036

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

1037

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

1038

interconnectAttachment: string, Name of the interconnect attachment to patch. (required)

Dan O'Meara

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

[diff] [blame]

1039

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1040

The object takes the form of:

1041

1042

{ # Represents an Interconnect Attachment (VLAN) resource.

Bu Sun Kim

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

[diff] [blame]

1043

#

1044

# You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)

1045

"adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

1046

"bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:

1047

# - BPS_50M: 50 Mbit/s

1048

# - BPS_100M: 100 Mbit/s

1049

# - BPS_200M: 200 Mbit/s

1050

# - BPS_300M: 300 Mbit/s

1051

# - BPS_400M: 400 Mbit/s

1052

# - BPS_500M: 500 Mbit/s

# - BPS_1G: 1 Gbit/s

# - BPS_2G: 2 Gbit/s

# - BPS_5G: 5 Gbit/s

# - BPS_10G: 10 Gbit/s

1057

# - BPS_20G: 20 Gbit/s

1058

# - BPS_50G: 50 Gbit/s

1059

"candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

1060

"A String",

1061

],

1062

"cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

1063

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

1064

"customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

Bu Sun Kim

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

[diff] [blame]

1065

"dataplaneVersion": 42, # [Output Only] Dataplane version for this InterconnectAttachment.

Bu Sun Kim

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

[diff] [blame]

1066

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

1067

"edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

1068

# - AVAILABILITY_DOMAIN_ANY

1069

# - AVAILABILITY_DOMAIN_1

1070

# - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.

Bu Sun Kim

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

[diff] [blame]

1071

"encryption": "A String", # Indicates the user-supplied encryption option of this interconnect attachment:

1072

# - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

1073

# - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.

Bu Sun Kim

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

[diff] [blame]

1074

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

1075

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

1076

"interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

1077

"ipsecInternalAddresses": [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway's IP address will be allocated from regional external IP address pool.

1078

"A String",

1079

],

Bu Sun Kim

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

[diff] [blame]

1080

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

1081

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, 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.

Bu Sun Kim

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

[diff] [blame]

1082

#

Bu Sun Kim

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

[diff] [blame]

1083

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

1084

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

1085

"a_key": "A String",

1086

},

1087

"mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

1088

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

1089

"operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:

1090

# - OS_ACTIVE: The attachment has been turned up and is ready to use.

1091

# - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

1092

"pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

1093

"partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

1094

"partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

1095

"interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.

1096

"partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

1097

"portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.

1098

},

1099

"privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

1100

"tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

1101

},

1102

"region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1103

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

1104

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

1105

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

1106

"state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:

1107

# - ACTIVE: The attachment has been turned up and is ready to use.

1108

# - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.

1109

# - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.

1110

# - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.

1111

# - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.

1112

# - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.

1113

"type": "A String", # The type of interconnect attachment this is, which can take one of the following values:

1114

# - DEDICATED: an attachment to a Dedicated Interconnect.

1115

# - PARTNER: an attachment to a Partner Interconnect, created by the customer.

1116

# - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.

1117

"vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.

1118

}

Bu Sun Kim

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

[diff] [blame]

1119

1120

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.

1121

1122

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.

1123

1124

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

1125

1126

Returns:

1127

An object of the form:

1128

1129

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1130

#

1131

# Google Compute Engine has three Operation resources:

1132

#

1133

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

1134

#

1135

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

1136

#

1137

# Operations can be global, regional or zonal.

1138

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

1139

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

1140

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

1141

#

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

Bu Sun Kim

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

[diff] [blame]

1149

{

Yoshi Automation Bot

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

[diff] [blame]

1150

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

1151

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

1152

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

Bu Sun Kim

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

[diff] [blame]

1153

},

1154

],

Yoshi Automation Bot

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

[diff] [blame]

1155

},

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

1162

#

1163

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

1164

#

1165

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

1166

#

1167

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

1168

#

1169

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

1170

#

1171

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

1172

#

1173

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

1174

#

1175

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

1176

#

1177

# Example 4: Pack and unpack a message in Go

1178

#

1179

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

1180

#

1181

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

1186

#

1187

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

1188

#

1189

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

1190

#

1191

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

1192

#

1193

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

1194

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

1195

#

1196

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

1197

#

1198

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

1199

#

1200

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

1201

#

1202

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

1203

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

1204

},

Yoshi Automation Bot

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

[diff] [blame]

1205

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

yoshi-code-bot

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

[diff] [blame]

1206

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

1207

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

1208

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

1209

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

1210

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

1211

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

1212

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

1213

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

1214

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

1215

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

1216

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

1217

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

1218

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

1219

{

1220

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

1221

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

1222

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

1223

{

1224

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

1225

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

1226

},

1227

],

1228

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

1229

},

1230

],

1231

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

1232

}</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]

1236

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

Bu Sun Kim

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

[diff] [blame]

1237

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

1238

1239

Args:

1240

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

1241

region: string, The name of the region for this request. (required)

1242

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

Dan O'Meara

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

[diff] [blame]

1243

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1244

The object takes the form of:

1245

1246

{

Yoshi Automation Bot

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

[diff] [blame]

1247

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

1248

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

1249

"bindingId": "A String",

1250

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

1251

#

Yoshi Automation Bot

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

[diff] [blame]

1252

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

1253

#

Yoshi Automation Bot

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

[diff] [blame]

1254

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

1255

#

1256

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

1257

#

1258

# Example (Comparison):

1259

#

1260

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

1261

#

1262

# Example (Equality):

1263

#

1264

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

1269

#

1270

# Example (Data Manipulation):

1271

#

1272

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

1273

#

1274

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

1275

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

1276

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

1277

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

1278

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

1279

},

1280

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

1281

#

1282

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

1283

#

1284

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

1285

#

1286

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

1291

#

1292

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

1293

#

1294

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

1295

#

1296

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

1297

#

1298

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

1303

"A String",

1304

],

1305

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

1306

},

Yoshi Automation Bot

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

[diff] [blame]

1307

],

1308

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

1309

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

1310

#

1311

#

1312

#

Dan O'Meara

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

[diff] [blame]

1313

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

1314

#

Bu Sun Kim

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

[diff] [blame]

1315

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

1316

#

Dan O'Meara

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

[diff] [blame]

1317

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1318

#

Bu Sun Kim

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

[diff] [blame]

1319

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

1320

#

Dan O'Meara

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

[diff] [blame]

1321

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1322

#

Bu Sun Kim

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

[diff] [blame]

1323

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

1324

#

Dan O'Meara

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

[diff] [blame]

1325

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

1326

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

Bu Sun Kim

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

[diff] [blame]

1327

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

1328

#

1329

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

1330

#

1331

# Example Policy with multiple AuditConfigs:

1332

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

1333

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

1334

#

Dan O'Meara

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

[diff] [blame]

1335

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

1336

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

Bu Sun Kim

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

[diff] [blame]

1337

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

1338

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

1339

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

1340

#

Bu Sun Kim

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

[diff] [blame]

1341

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

1342

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

1343

"A String",

Bu Sun Kim

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

[diff] [blame]

1344

],

Bu Sun Kim

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

[diff] [blame]

1345

"ignoreChildExemptions": True or False,

1346

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

Bu Sun Kim

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

[diff] [blame]

1347

},

1348

],

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]

1353

},

1354

],

Bu Sun Kim

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

[diff] [blame]

1355

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

1356

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

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

1357

"bindingId": "A String",

Bu Sun Kim

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

[diff] [blame]

1358

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

1359

#

1360

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

1361

#

1362

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

1363

#

1364

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

1365

#

1366

# Example (Comparison):

1367

#

1368

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

1369

#

1370

# Example (Equality):

1371

#

1372

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

1377

#

1378

# Example (Data Manipulation):

1379

#

1380

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

1381

#

1382

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

1383

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

1384

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

1385

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

1386

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

1387

},

1388

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

1389

#

1390

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

1391

#

1392

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

1393

#

Dan O'Meara

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

[diff] [blame]

1394

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

1399

#

1400

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

1401

#

Dan O'Meara

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

[diff] [blame]

1402

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

1403

#

1404

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

1405

#

1406

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

1407

#

Bu Sun Kim

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

[diff] [blame]

1408

#

1409

#

1410

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

1411

"A String",

Bu Sun Kim

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

[diff] [blame]

1412

],

Bu Sun Kim

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

[diff] [blame]

1413

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

1414

},

1415

],

Bu Sun Kim

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

[diff] [blame]

1416

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

1417

#

1418

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

1419

"iamOwned": True or False,

1420

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

1421

{ # A rule to be applied in a Policy.

1422

"action": "A String", # Required

1423

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

1424

{ # A condition to be met.

1425

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

1426

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

1427

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

1428

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

1429

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

"A String",

],

},

],

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

1435

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

1436

"A String",

1437

],

1438

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

1439

{ # Specifies what kind of log the caller must write

1440

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

1441

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

1442

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

1443

},

1444

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

1445

},

1446

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

1447

#

1448

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

1449

#

1450

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

1451

#

1452

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

1453

#

1454

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

1455

"customFields": [ # Custom fields.

1456

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

1457

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

1458

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

1459

},

1460

],

1461

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

1462

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

1463

},

1464

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

1465

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

1470

"A String",

1471

],

1472

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

1478

#

1479

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

1480

#

1481

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

1482

#

1483

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

1484

#

1485

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

1486

#

1487

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

1488

#

1489

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

1496

1497

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

1502

#

1503

# 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

1512

#

1513

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

1514

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

1515

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

1516

#

1517

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

1518

#

1519

# Example Policy with multiple AuditConfigs:

1520

#

1521

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

1522

#

1523

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

1524

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

1525

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

1526

#

1527

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

1528

#

1529

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

1530

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

1531

"A String",

1532

],

1533

"ignoreChildExemptions": True or False,

1534

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

1541

},

1542

],

1543

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

1544

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

1545

"bindingId": "A String",

1546

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

1547

#

1548

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

1549

#

1550

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

1551

#

1552

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

1553

#

1554

# Example (Comparison):

1555

#

1556

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

1557

#

1558

# Example (Equality):

1559

#

1560

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

1565

#

1566

# Example (Data Manipulation):

1567

#

1568

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

1569

#

1570

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

1571

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

1572

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

1573

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

1574

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

1575

},

1576

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

1577

#

1578

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

1579

#

1580

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

1581

#

1582

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

1587

#

1588

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

1589

#

1590

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

1591

#

1592

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

1593

#

1594

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

1599

"A String",

1600

],

1601

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

1602

},

1603

],

1604

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

1605

#

1606

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

1607

"iamOwned": True or False,

1608

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

1609

{ # A rule to be applied in a Policy.

1610

"action": "A String", # Required

1611

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

1612

{ # A condition to be met.

1613

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

1614

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

1615

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

1616

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

1617

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

"A String",

],

},

],

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

1623

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

1624

"A String",

1625

],

1626

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

1627

{ # Specifies what kind of log the caller must write

1628

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

1629

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

1630

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

1631

},

1632

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

1633

},

1634

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

1635

#

1636

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

1637

#

1638

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

1639

#

1640

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

1641

#

1642

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

1643

"customFields": [ # Custom fields.

1644

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

1645

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

1646

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

1647

},

1648

],

1649

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

1650

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

1651

},

1652

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

1653

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

1658

"A String",

1659

],

1660

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

1666

#

1667

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

1668

#

1669

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

1670

#

1671

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

1672

#

1673

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

1674

#

1675

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

1676

#

1677

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

1678

}</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]

1682

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

Bu Sun Kim

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

[diff] [blame]

1683

<pre>Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.

1684

1685

Args:

1686

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

1687

region: string, The region for this request. (required)

1688

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

Dan O'Meara

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

[diff] [blame]

1689

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1690

The object takes the form of:

1691

1692

{

Yoshi Automation Bot

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

[diff] [blame]

1693

"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 in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

1694

"labels": { # The labels to set for this resource.

1695

"a_key": "A String",

1696

},

1697

}

Bu Sun Kim

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

[diff] [blame]

1698

1699

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.

1700

1701

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.

1702

1703

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

1704

1705

Returns:

1706

An object of the form:

1707

1708

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1709

#

1710

# Google Compute Engine has three Operation resources:

1711

#

1712

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

1713

#

1714

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

1715

#

1716

# Operations can be global, regional or zonal.

1717

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

1718

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

1719

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

1720

#

1721

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

1722

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

1723

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

1724

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

1725

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

1726

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

1727

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

Bu Sun Kim

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

[diff] [blame]

1728

{

Yoshi Automation Bot

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

[diff] [blame]

1729

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

1730

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

1731

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

Bu Sun Kim

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

[diff] [blame]

1732

},

1733

],

Yoshi Automation Bot

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

[diff] [blame]

1734

},

1735

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

1736

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

1737

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

1738

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

1739

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

1740

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

1741

#

1742

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

1743

#

1744

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

1745

#

1746

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

1747

#

1748

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

1749

#

1750

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

1751

#

1752

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

1753

#

1754

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

1755

#

1756

# Example 4: Pack and unpack a message in Go

1757

#

1758

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

1759

#

1760

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

1765

#

1766

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

1767

#

1768

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

1769

#

1770

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

1771

#

1772

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

1773

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

1774

#

1775

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

1776

#

1777

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

1778

#

1779

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

1780

#

1781

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

1782

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

1783

},

Yoshi Automation Bot

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

[diff] [blame]

1784

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

yoshi-code-bot

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

[diff] [blame]

1785

"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