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

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

<h3>Method Details</h3>

105

106

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

107

<pre>Deletes the specified interconnect.

108

109

Args:

110

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

111

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

112

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.

113

114

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.

115

116

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

117

118

Returns:

119

An object of the form:

120

121

{ # Represents an Operation resource.

122

#

Dan O'Meara

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

[diff] [blame]

123

# Google Compute Engine has three Operation resources:

124

#

125

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

126

#

Bu Sun Kim

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

[diff] [blame]

127

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

128

#

129

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

130

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

131

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

132

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

Bu Sun Kim

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

[diff] [blame]

133

#

Dan O'Meara

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

[diff] [blame]

134

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

135

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

136

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

137

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

138

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

139

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

140

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

Bu Sun Kim

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

[diff] [blame]

141

{

Bu Sun Kim

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

[diff] [blame]

142

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

143

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

144

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

Bu Sun Kim

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

[diff] [blame]

145

},

146

],

147

},

Bu Sun Kim

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

[diff] [blame]

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

{

166

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

167

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

168

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

169

{

170

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

171

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

172

},

173

],

174

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

175

},

176

],

177

"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, interconnect)</code>

183

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

184

185

Args:

186

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

187

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

188

189

Returns:

190

An object of the form:

191

192

{ # Represents an Interconnect resource.

Bu Sun Kim

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

[diff] [blame]

193

#

194

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

195

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

196

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

Bu Sun Kim

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

[diff] [blame^]

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

199

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

200

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

Bu Sun Kim

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

[diff] [blame]

201

},

Bu Sun Kim

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

[diff] [blame]

202

],

203

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

204

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

205

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

206

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

Bu Sun Kim

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

[diff] [blame^]

207

{ # Description of a planned outage on this Interconnect.

Bu Sun Kim

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

[diff] [blame]

208

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

209

"A String",

210

],

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

},

224

],

225

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

226

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

227

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

228

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

229

"A String",

230

],

231

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

232

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

233

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

234

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

235

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

236

#

237

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

238

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

239

"a_key": "A String",

240

},

241

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

242

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

264

<pre>Returns the interconnectDiagnostics for the specified interconnect.

265

266

Args:

267

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

268

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

269

270

Returns:

271

An object of the form:

272

273

{ # Response for the InterconnectsGetDiagnosticsRequest.

Bu Sun Kim

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

[diff] [blame]

274

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

275

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

Bu Sun Kim

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

[diff] [blame]

276

{ # Describing the ARP neighbor entries seen on this link

Bu Sun Kim

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

[diff] [blame]

277

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

278

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

Bu Sun Kim

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

[diff] [blame]

279

},

280

],

Bu Sun Kim

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

[diff] [blame]

281

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

Bu Sun Kim

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

[diff] [blame]

282

{

Bu Sun Kim

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

[diff] [blame]

283

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

Bu Sun Kim

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

[diff] [blame]

284

{ # Describing the ARP neighbor entries seen on this link

Bu Sun Kim

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

[diff] [blame]

285

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

286

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

Bu Sun Kim

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

[diff] [blame]

287

},

288

],

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

291

"lacpStatus": {

292

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

293

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

294

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

Bu Sun Kim

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

[diff] [blame]

295

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

296

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

Bu Sun Kim

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

[diff] [blame]

297

},

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

302

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

303

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

304

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

Bu Sun Kim

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

[diff] [blame]

305

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

306

},

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

Bu Sun Kim

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

[diff] [blame]

315

},

316

},

317

],

Bu Sun Kim

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

[diff] [blame]

318

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

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]

324

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

Bu Sun Kim

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

[diff] [blame]

325

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

326

327

Args:

328

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

Dan O'Meara

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

[diff] [blame]

329

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

330

The object takes the form of:

331

332

{ # Represents an Interconnect resource.

Bu Sun Kim

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

[diff] [blame]

333

#

334

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

335

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

336

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

Bu Sun Kim

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

[diff] [blame^]

337

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

Bu Sun Kim

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

[diff] [blame]

338

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

339

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

340

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

Bu Sun Kim

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

[diff] [blame]

341

},

Bu Sun Kim

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

[diff] [blame]

342

],

343

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

344

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

345

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

346

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

Bu Sun Kim

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

[diff] [blame^]

347

{ # Description of a planned outage on this Interconnect.

Bu Sun Kim

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

[diff] [blame]

348

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

349

"A String",

350

],

351

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

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

360

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

361

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

362

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

363

},

364

],

365

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

366

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

367

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

368

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

369

"A String",

370

],

371

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

372

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

373

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

374

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

375

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

376

#

377

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

378

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

379

"a_key": "A String",

380

},

381

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

382

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

}

Bu Sun Kim

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

[diff] [blame]

400

401

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.

402

403

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.

404

405

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

406

407

Returns:

408

An object of the form:

409

410

{ # Represents an Operation resource.

411

#

Dan O'Meara

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

[diff] [blame]

412

# Google Compute Engine has three Operation resources:

413

#

414

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

415

#

Bu Sun Kim

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

[diff] [blame]

416

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

417

#

418

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

419

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

420

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

421

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

Bu Sun Kim

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

[diff] [blame]

422

#

Dan O'Meara

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

[diff] [blame]

423

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

424

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

425

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

426

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

427

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

428

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

429

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

Bu Sun Kim

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

[diff] [blame]

430

{

Bu Sun Kim

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

[diff] [blame]

431

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

432

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

433

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

Bu Sun Kim

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

[diff] [blame]

434

},

435

],

436

},

Bu Sun Kim

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

[diff] [blame]

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

{

455

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

456

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

457

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

458

{

459

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

460

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

461

},

462

],

463

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

464

},

465

],

466

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

Bu Sun Kim

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

[diff] [blame]

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

473

474

Args:

475

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

Dan O'Meara

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

[diff] [blame]

476

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]

477

Dan O'Meara

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

[diff] [blame]

478

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]

479

Dan O'Meara

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

[diff] [blame]

480

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]

481

Bu Sun Kim

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

[diff] [blame]

482

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

483

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

484

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

485

486

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.

487

488

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

489

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.

Bu Sun Kim

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

[diff] [blame]

490

491

Returns:

492

An object of the form:

493

494

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

Bu Sun Kim

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

[diff] [blame]

495

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

496

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

Bu Sun Kim

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

[diff] [blame]

497

{ # Represents an Interconnect resource.

Bu Sun Kim

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

[diff] [blame]

498

#

499

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

500

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

501

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

Bu Sun Kim

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

[diff] [blame^]

502

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

Bu Sun Kim

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

[diff] [blame]

503

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

504

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

505

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

Bu Sun Kim

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

[diff] [blame]

506

},

Bu Sun Kim

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

[diff] [blame]

507

],

508

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

509

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

510

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

511

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

Bu Sun Kim

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

[diff] [blame^]

512

{ # Description of a planned outage on this Interconnect.

Bu Sun Kim

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

[diff] [blame]

513

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

514

"A String",

515

],

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

},

529

],

530

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

531

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

532

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

533

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

534

"A String",

535

],

536

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

537

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

538

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

539

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

540

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

541

#

542

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

543

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

544

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

545

},

Bu Sun Kim

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

[diff] [blame]

546

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

547

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

},

Bu Sun Kim

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

[diff] [blame]

565

],

Bu Sun Kim

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

[diff] [blame]

566

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

567

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

568

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

569

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

570

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

571

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

572

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

Bu Sun Kim

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

[diff] [blame]

573

{

Bu Sun Kim

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

[diff] [blame]

574

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

575

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

576

},

577

],

Bu Sun Kim

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

[diff] [blame]

578

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

579

},

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>

585

<pre>Retrieves the next page of results.

586

587

Args:

588

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

589

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

590

591

Returns:

Bu Sun Kim

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

[diff] [blame]

592

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]

593

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]

598

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

Bu Sun Kim

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

[diff] [blame]

599

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

600

601

Args:

602

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

603

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

Dan O'Meara

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

[diff] [blame]

604

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

605

The object takes the form of:

606

607

{ # Represents an Interconnect resource.

Bu Sun Kim

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

[diff] [blame]

608

#

609

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

610

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

611

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

Bu Sun Kim

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

[diff] [blame^]

612

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

Bu Sun Kim

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

[diff] [blame]

613

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

614

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

615

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

Bu Sun Kim

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

[diff] [blame]

616

},

Bu Sun Kim

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

[diff] [blame]

617

],

618

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

619

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

620

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

621

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

Bu Sun Kim

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

[diff] [blame^]

622

{ # Description of a planned outage on this Interconnect.

Bu Sun Kim

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

[diff] [blame]

623

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

624

"A String",

625

],

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

},

639

],

640

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

641

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

642

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

643

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

644

"A String",

645

],

646

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

647

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

648

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

649

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

650

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

651

#

652

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

653

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

654

"a_key": "A String",

655

},

656

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

657

# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

}

Bu Sun Kim

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

[diff] [blame]

675

676

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.

677

678

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.

679

680

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

681

682

Returns:

683

An object of the form:

684

685

{ # Represents an Operation resource.

686

#

Dan O'Meara

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

[diff] [blame]

687

# Google Compute Engine has three Operation resources:

688

#

689

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

690

#

Bu Sun Kim

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

[diff] [blame]

691

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

692

#

693

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

694

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

695

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

696

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

Bu Sun Kim

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

[diff] [blame]

697

#

Dan O'Meara

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

[diff] [blame]

698

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

699

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

700

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

701

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

702

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

703

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

704

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

Bu Sun Kim

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

[diff] [blame]

705

{

Bu Sun Kim

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

[diff] [blame]

706

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

707

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

708

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

Bu Sun Kim

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

[diff] [blame]

709

},

710

],

711

},

Bu Sun Kim

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

[diff] [blame]

712

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

713

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

714

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

715

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

716

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

717

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

718

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

719

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

720

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

721

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

722

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

723

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

724

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

725

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

726

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

727

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

728

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

729

{

730

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

731

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

732

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

733

{

734

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

735

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

736

},

737

],

738

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

739

},

740

],

741

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

746

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

Bu Sun Kim

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

[diff] [blame]

747

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

748

749

Args:

750

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

751

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

Dan O'Meara

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

[diff] [blame]

752

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

753

The object takes the form of:

754

755

{

Bu Sun Kim

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

[diff] [blame]

756

"labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.

757

"labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").

758

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

},

}

Returns:

An object of the form:

765

766

{ # Represents an Operation resource.

767

#

Dan O'Meara

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

[diff] [blame]

768

# Google Compute Engine has three Operation resources:

769

#

770

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

771

#

Bu Sun Kim

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

[diff] [blame]

772

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

773

#

774

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

775

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

776

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

777

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

Bu Sun Kim

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

[diff] [blame]

778

#

Dan O'Meara

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

[diff] [blame]

779

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

780

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

781

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

782

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

783

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

784

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

785

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

Bu Sun Kim

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

[diff] [blame]

786

{

Bu Sun Kim

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

[diff] [blame]

787

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

788

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

789

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

Bu Sun Kim

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

[diff] [blame]

790

},

791

],

792

},

Bu Sun Kim