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

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

[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

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

Bu Sun Kim

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

[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="#insert">insert(project, region, body=None, requestId=None, validateOnly=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

94

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

95

Dmitry Frenkel

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

110

<h3>Method Details</h3>

111

Dmitry Frenkel

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

<pre>Retrieves an aggregated list of interconnect attachments.

114

115

Args:

116

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

Dan O'Meara

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

[diff] [blame]

117

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

Bu Sun Kim

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

[diff] [blame]

118

Dan O'Meara

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

[diff] [blame]

119

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

Bu Sun Kim

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

[diff] [blame]

120

Dan O'Meara

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

[diff] [blame]

121

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.

Bu Sun Kim

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

[diff] [blame]

122

Bu Sun Kim

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

[diff] [blame]

123

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]

124

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]

125

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

126

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

127

128

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.

129

130

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

131

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

Dmitry Frenkel

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

[diff] [blame]

132

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

133

134

Returns:

135

An object of the form:

136

137

{

Bu Sun Kim

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

[diff] [blame]

138

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

139

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

140

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

141

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

Bu Sun Kim

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

[diff] [blame]

142

{ # Represents an Interconnect Attachment (VLAN) resource.

Bu Sun Kim

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

[diff] [blame]

143

#

144

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

145

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

146

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

147

# - BPS_50M: 50 Mbit/s

148

# - BPS_100M: 100 Mbit/s

149

# - BPS_200M: 200 Mbit/s

150

# - BPS_300M: 300 Mbit/s

151

# - BPS_400M: 400 Mbit/s

152

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

157

# - BPS_20G: 20 Gbit/s

158

# - BPS_50G: 50 Gbit/s

159

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

160

"A String",

161

],

162

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

163

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

164

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

Yoshi Automation Bot

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

[diff] [blame]

165

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

Bu Sun Kim

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

[diff] [blame]

166

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

167

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

168

# - AVAILABILITY_DOMAIN_ANY

169

# - AVAILABILITY_DOMAIN_1

170

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

171

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

172

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

173

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

174

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

175

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

176

#

Bu Sun Kim

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

[diff] [blame]

177

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

178

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

179

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

180

},

Bu Sun Kim

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

[diff] [blame]

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

},

192

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

193

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

194

},

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

# - DEDICATED: an attachment to a Dedicated Interconnect.

207

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

208

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

209

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

210

},

Bu Sun Kim

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

[diff] [blame]

211

],

Bu Sun Kim

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

[diff] [blame]

212

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

213

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

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

{

Bu Sun Kim

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

[diff] [blame]

217

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

218

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

Bu Sun Kim

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

[diff] [blame]

219

},

220

],

Bu Sun Kim

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

[diff] [blame]

221

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

Bu Sun Kim

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

[diff] [blame]

222

},

223

},

224

},

Bu Sun Kim

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

[diff] [blame]

225

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

226

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

227

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

Dmitry Frenkel

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

[diff] [blame]

228

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

229

"A String",

230

],

Bu Sun Kim

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

[diff] [blame]

231

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

232

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

233

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

234

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

Bu Sun Kim

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

[diff] [blame]

235

{

Bu Sun Kim

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

[diff] [blame]

236

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

237

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

Bu Sun Kim

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

[diff] [blame]

238

},

239

],

Bu Sun Kim

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

[diff] [blame]

240

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

Bu Sun Kim

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

[diff] [blame]

241

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

247

<pre>Retrieves the next page of results.

248

249

Args:

250

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

251

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

252

253

Returns:

Bu Sun Kim

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

[diff] [blame]

254

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

Bu Sun Kim

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

[diff] [blame]

255

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]

260

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

261

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

265

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

266

<pre>Deletes the specified interconnect attachment.

267

268

Args:

269

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

270

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

271

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

272

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.

273

274

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.

275

276

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

277

278

Returns:

279

An object of the form:

280

281

{ # Represents an Operation resource.

282

#

Dan O'Meara

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

[diff] [blame]

283

# Google Compute Engine has three Operation resources:

284

#

285

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

286

#

Bu Sun Kim

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

[diff] [blame]

287

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

288

#

289

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

290

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

291

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

292

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

Bu Sun Kim

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

[diff] [blame]

293

#

Dan O'Meara

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

[diff] [blame]

294

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

Bu Sun Kim

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

[diff] [blame]

295

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

296

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

297

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

298

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

299

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

300

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

Bu Sun Kim

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

[diff] [blame]

301

{

Bu Sun Kim

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

[diff] [blame]

302

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

303

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

304

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

Bu Sun Kim

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

[diff] [blame]

305

},

306

],

307

},

Bu Sun Kim

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

[diff] [blame]

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

{

326

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

327

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

328

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

329

{

330

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

331

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

332

},

333

],

334

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

335

},

336

],

337

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

343

<pre>Returns the specified interconnect attachment.

344

345

Args:

346

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

347

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

348

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

349

350

Returns:

351

An object of the form:

352

353

{ # Represents an Interconnect Attachment (VLAN) resource.

Bu Sun Kim

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

[diff] [blame]

354

#

355

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

356

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

357

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

358

# - BPS_50M: 50 Mbit/s

359

# - BPS_100M: 100 Mbit/s

360

# - BPS_200M: 200 Mbit/s

361

# - BPS_300M: 300 Mbit/s

362

# - BPS_400M: 400 Mbit/s

363

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

368

# - BPS_20G: 20 Gbit/s

369

# - BPS_50G: 50 Gbit/s

370

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

371

"A String",

372

],

373

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

374

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

375

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

Yoshi Automation Bot

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

[diff] [blame]

376

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

Bu Sun Kim

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

[diff] [blame]

377

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

378

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

379

# - AVAILABILITY_DOMAIN_ANY

380

# - AVAILABILITY_DOMAIN_1

381

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

382

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

383

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

384

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

385

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

386

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

387

#

Bu Sun Kim

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

[diff] [blame]

388

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

389

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

390

"a_key": "A String",

391

},

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

},

403

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

404

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

405

},

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

# - DEDICATED: an attachment to a Dedicated Interconnect.

418

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

419

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

420

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

421

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

425

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

Bu Sun Kim

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

[diff] [blame]

426

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

427

428

Args:

429

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

430

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

Dan O'Meara

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

[diff] [blame]

431

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

432

The object takes the form of:

433

434

{ # Represents an Interconnect Attachment (VLAN) resource.

Bu Sun Kim

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

[diff] [blame]

435

#

436

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

437

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

438

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

439

# - BPS_50M: 50 Mbit/s

440

# - BPS_100M: 100 Mbit/s

441

# - BPS_200M: 200 Mbit/s

442

# - BPS_300M: 300 Mbit/s

443

# - BPS_400M: 400 Mbit/s

444

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

449

# - BPS_20G: 20 Gbit/s

450

# - BPS_50G: 50 Gbit/s

451

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

452

"A String",

453

],

454

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

455

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

456

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

Yoshi Automation Bot

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

[diff] [blame]

457

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

Bu Sun Kim

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

[diff] [blame]

458

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

459

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

460

# - AVAILABILITY_DOMAIN_ANY

461

# - AVAILABILITY_DOMAIN_1

462

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

463

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

464

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

465

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

466

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

467

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

468

#

Bu Sun Kim

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

[diff] [blame]

469

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

470

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

471

"a_key": "A String",

472

},

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

},

484

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

485

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

486

},

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

# - DEDICATED: an attachment to a Dedicated Interconnect.

499

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

500

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

501

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

502

}

Bu Sun Kim

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

[diff] [blame]

503

504

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.

505

506

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.

507

508

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

Dan O'Meara

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

[diff] [blame]

509

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

Bu Sun Kim

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

[diff] [blame]

510

511

Returns:

512

An object of the form:

513

514

{ # Represents an Operation resource.

515

#

Dan O'Meara

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

[diff] [blame]

516

# Google Compute Engine has three Operation resources:

517

#

518

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

519

#

Bu Sun Kim

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

[diff] [blame]

520

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

521

#

522

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

523

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

524

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

525

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

Bu Sun Kim

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

[diff] [blame]

526

#

Dan O'Meara

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

[diff] [blame]

527

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

Bu Sun Kim

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

[diff] [blame]

528

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

529

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

530

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

531

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

532

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

533

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

Bu Sun Kim

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

[diff] [blame]

534

{

Bu Sun Kim

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

[diff] [blame]

535

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

536

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

537

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

Bu Sun Kim

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

[diff] [blame]

538

},

539

],

540

},

Bu Sun Kim

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

[diff] [blame]

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

556

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

557

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

558

{

559

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

560

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

561

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

562

{

563

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

564

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

565

},

566

],

567

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

568

},

569

],

570

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

575

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

Bu Sun Kim

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

[diff] [blame]

576

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

577

578

Args:

579

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

580

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

Dan O'Meara

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

[diff] [blame]

581

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

Bu Sun Kim

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

[diff] [blame]

582

Dan O'Meara

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

[diff] [blame]

583

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

Bu Sun Kim

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

[diff] [blame]

584

Dan O'Meara

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

[diff] [blame]

585

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.

Bu Sun Kim

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

[diff] [blame]

586

Bu Sun Kim

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

[diff] [blame]

587

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

588

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

589

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

590

591

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.

592

593

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

594

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

Dmitry Frenkel

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

[diff] [blame]

595

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

596

597

Returns:

598

An object of the form:

599

600

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

Bu Sun Kim

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

[diff] [blame]

601

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

602

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

Bu Sun Kim

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

[diff] [blame]

603

{ # Represents an Interconnect Attachment (VLAN) resource.

Bu Sun Kim

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

[diff] [blame]

604

#

605

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

606

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

607

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

608

# - BPS_50M: 50 Mbit/s

609

# - BPS_100M: 100 Mbit/s

610

# - BPS_200M: 200 Mbit/s

611

# - BPS_300M: 300 Mbit/s

612

# - BPS_400M: 400 Mbit/s

613

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

618

# - BPS_20G: 20 Gbit/s

619

# - BPS_50G: 50 Gbit/s

620

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

621

"A String",

622

],

623

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

624

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

625

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

Yoshi Automation Bot

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

[diff] [blame]

626

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

Bu Sun Kim

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

[diff] [blame]

627

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

628

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

629

# - AVAILABILITY_DOMAIN_ANY

630

# - AVAILABILITY_DOMAIN_1

631

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

632

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

633

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

634

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

635

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

636

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

637

#

Bu Sun Kim

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

[diff] [blame]

638

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

639

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

640

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

641

},

Bu Sun Kim

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

[diff] [blame]

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

},

653

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

654

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

655

},

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

# - DEDICATED: an attachment to a Dedicated Interconnect.

668

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

669

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

670

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

671

},

Bu Sun Kim

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

[diff] [blame]

672

],

Bu Sun Kim

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

[diff] [blame]

673

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

674

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

675

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

676

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

677

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

678

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

679

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

Bu Sun Kim

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

[diff] [blame]

680

{

Bu Sun Kim

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

[diff] [blame]

681

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

682

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

Bu Sun Kim

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

[diff] [blame]

683

},

684

],

Bu Sun Kim

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

[diff] [blame]

685

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

Bu Sun Kim

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

[diff] [blame]

686

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

692

<pre>Retrieves the next page of results.

693

694

Args:

695

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

696

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

697

698

Returns:

Bu Sun Kim

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

[diff] [blame]

699

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

Bu Sun Kim

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

[diff] [blame]

700

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]

705

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

706

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

707

708

Args:

709

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

710

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

711

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

Dan O'Meara

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

[diff] [blame]

712

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

713

The object takes the form of:

714

715

{ # Represents an Interconnect Attachment (VLAN) resource.

Bu Sun Kim

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

[diff] [blame]

716

#

717

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

718

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

719

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

720

# - BPS_50M: 50 Mbit/s

721

# - BPS_100M: 100 Mbit/s

722

# - BPS_200M: 200 Mbit/s

723

# - BPS_300M: 300 Mbit/s

724

# - BPS_400M: 400 Mbit/s

725

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

730

# - BPS_20G: 20 Gbit/s

731

# - BPS_50G: 50 Gbit/s

732

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

733

"A String",

734

],

735

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

736

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

737

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

Yoshi Automation Bot

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

[diff] [blame]

738

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

Bu Sun Kim

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

[diff] [blame]

739

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

740

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

741

# - AVAILABILITY_DOMAIN_ANY

742

# - AVAILABILITY_DOMAIN_1

743

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

744

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

745

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

746

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

747

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

748

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

749

#

Bu Sun Kim

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

[diff] [blame]

750

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

751

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

752

"a_key": "A String",

753

},

754

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

755

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

756

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

757

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

758

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

759

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

760

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

761

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

762

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

763

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

764

},

765

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

766

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

767

},

768

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

769

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

770

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

771

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

772

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

773

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

774

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

775

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

776

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

777

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

778

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

779

# - DEDICATED: an attachment to a Dedicated Interconnect.

780

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

781

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

782

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

783

}

Bu Sun Kim

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

[diff] [blame]

784

785

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.

786

787

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.

788

789

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

790

791

Returns:

792

An object of the form:

793

794

{ # Represents an Operation resource.

795

#

Dan O'Meara

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

[diff] [blame]

796

# Google Compute Engine has three Operation resources:

797

#

798

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

799

#

Bu Sun Kim

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

[diff] [blame]

800

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

801

#

802

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

803

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

804

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

805

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

Bu Sun Kim

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

[diff] [blame]

806

#

Dan O'Meara

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

[diff] [blame]

807

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

Bu Sun Kim

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

[diff] [blame]

808

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

809

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

810

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

811

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

812

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

813

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

Bu Sun Kim

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

[diff] [blame]

814

{

Bu Sun Kim

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

[diff] [blame]

815

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

816

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

817

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

Bu Sun Kim

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

[diff] [blame]

818

},

819

],

820

},

Bu Sun Kim

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

[diff] [blame]

821

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

822

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

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

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

838

{

839

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

840

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

841

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

842

{

843

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

844

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

845

},

846

],

847

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

848

},

849

],

850

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

855

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

856

<pre>Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.

857

858

Args:

859

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

860

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

861

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

Dan O'Meara

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

[diff] [blame]

862

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

863

The object takes the form of:

864

865

{

Bu Sun Kim

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

[diff] [blame]

866

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

867

"labels": { # The labels to set for this resource.

868

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

},

}

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.

873

874

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.

875

876

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

877

878

Returns:

879

An object of the form:

880

881

{ # Represents an Operation resource.

882

#

Dan O'Meara

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

[diff] [blame]

883

# Google Compute Engine has three Operation resources:

884

#

885

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

886

#

Bu Sun Kim

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

[diff] [blame]

887

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

888

#

889

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

890

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

891

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

892

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

Bu Sun Kim

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

[diff] [blame]

893

#

Dan O'Meara

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

[diff] [blame]

894

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

Bu Sun Kim

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

[diff] [blame]

895

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

896

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

897

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

898

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

899

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

900

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

Bu Sun Kim

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

[diff] [blame]

901

{

Bu Sun Kim

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

[diff] [blame]

902

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

903

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

904

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

Bu Sun Kim

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

[diff] [blame]

905

},

906

],

907

},

Bu Sun Kim