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

2016-10-21 13:59:49 -0700

[diff] [blame]

108

109

Returns:

110

An object of the form:

111

Bu Sun Kim

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

[diff] [blame]

112

{ # Represents an Operation resource.

113

#

Dan O'Meara

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

[diff] [blame]

114

# Google Compute Engine has three Operation resources:

115

#

116

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

117

#

Bu Sun Kim

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

[diff] [blame]

118

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

119

#

120

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

121

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

122

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

123

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

Bu Sun Kim

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

[diff] [blame]

124

#

Dan O'Meara

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

[diff] [blame]

125

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

126

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

127

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

128

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

129

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

130

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

131

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

132

{

Bu Sun Kim

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

[diff] [blame^]

133

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

134

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

135

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

136

},

137

],

138

},

Bu Sun Kim

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

[diff] [blame^]

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

{

158

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

159

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

160

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

161

{

162

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

163

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

164

},

165

],

166

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

167

},

168

],

169

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

175

<pre>Returns the specified Route resource. Gets a list of available routes by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

176

177

Args:

178

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

179

route: string, Name of the Route resource to return. (required)

180

181

Returns:

182

An object of the form:

183

Bu Sun Kim

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

[diff] [blame]

184

{ # Represents a Route resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

185

#

Dan O'Meara

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

[diff] [blame]

186

# A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)

Bu Sun Kim

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

[diff] [blame^]

187

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

188

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

189

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

190

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

191

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

192

"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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

193

"network": "A String", # Fully-qualified URL of the network that this route applies to.

194

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway

195

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:

Bu Sun Kim

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

[diff] [blame]

196

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

Dan O'Meara

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

[diff] [blame]

197

# - regions/region/forwardingRules/forwardingRule

Bu Sun Kim

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

[diff] [blame^]

198

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

199

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Bu Sun Kim

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

[diff] [blame^]

200

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

201

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

202

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

203

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

204

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

205

"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

206

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

207

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

208

"tags": [ # A list of instance tags to which this route applies.

209

"A String",

210

],

211

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

212

{

Bu Sun Kim

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

[diff] [blame^]

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

Sai Cheemalapati

2016-10-21 13:59:49 -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.

Sai Cheemalapati

2016-10-21 13:59:49 -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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

222

},

223

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

228

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

229

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

230

231

Args:

232

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

Dan O'Meara

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

[diff] [blame]

233

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

234

The object takes the form of:

235

Bu Sun Kim

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

[diff] [blame]

236

{ # Represents a Route resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

237

#

Dan O'Meara

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

[diff] [blame]

238

# A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)

Bu Sun Kim

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

[diff] [blame^]

239

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

240

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

241

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

242

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

243

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

244

"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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

245

"network": "A String", # Fully-qualified URL of the network that this route applies to.

246

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway

247

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:

Bu Sun Kim

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

[diff] [blame]

248

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

Dan O'Meara

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

[diff] [blame]

249

# - regions/region/forwardingRules/forwardingRule

Bu Sun Kim

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

[diff] [blame^]

250

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

251

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Bu Sun Kim

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

[diff] [blame^]

252

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

253

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

254

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

255

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

256

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

257

"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

258

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

259

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

260

"tags": [ # A list of instance tags to which this route applies.

261

"A String",

262

],

263

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

264

{

Bu Sun Kim

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

[diff] [blame^]

265

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

266

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

267

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

268

{

Bu Sun Kim

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

[diff] [blame^]

269

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

270

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

271

},

272

],

Bu Sun Kim

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

[diff] [blame^]

273

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

274

},

275

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

276

}

277

Bu Sun Kim

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

[diff] [blame]

278

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.

279

280

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.

281

282

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

283

284

Returns:

285

An object of the form:

286

Bu Sun Kim

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

[diff] [blame]

287

{ # Represents an Operation resource.

288

#

Dan O'Meara

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

[diff] [blame]

289

# Google Compute Engine has three Operation resources:

290

#

291

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

292

#

Bu Sun Kim

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

[diff] [blame]

293

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

294

#

295

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

296

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

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

#

Dan O'Meara

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

[diff] [blame]

300

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

301

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

302

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

303

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

304

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

305

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

306

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

307

{

Bu Sun Kim

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

[diff] [blame^]

308

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

309

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

310

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

311

},

312

],

313

},

Bu Sun Kim

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

[diff] [blame^]

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

{

333

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

334

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

335

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

336

{

337

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

338

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

339

},

340

],

341

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

342

},

343

],

344

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

349

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

350

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

351

352

Args:

353

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

Dan O'Meara

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

[diff] [blame]

354

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

355

Dan O'Meara

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

[diff] [blame]

356

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

357

Dan O'Meara

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

[diff] [blame]

358

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

359

Bu Sun Kim

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

[diff] [blame^]

360

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

361

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

362

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

363

364

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.

365

366

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

367

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.

368

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

369

370

Returns:

371

An object of the form:

372

373

{ # Contains a list of Route resources.

Bu Sun Kim

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

[diff] [blame^]

374

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

375

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

Bu Sun Kim

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

[diff] [blame]

376

{ # Represents a Route resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

377

#

Dan O'Meara

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

[diff] [blame]

378

# A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)

Bu Sun Kim

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

[diff] [blame^]

379

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

380

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

381

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

382

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

383

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

384

"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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

385

"network": "A String", # Fully-qualified URL of the network that this route applies to.

386

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway

387

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:

Bu Sun Kim

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

[diff] [blame]

388

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

Dan O'Meara

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

[diff] [blame]

389

# - regions/region/forwardingRules/forwardingRule

Bu Sun Kim

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

[diff] [blame^]

390

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

391

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Bu Sun Kim

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

[diff] [blame^]

392

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

393

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

394

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

395

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

396

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

397

"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

398

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

399

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

400

"tags": [ # A list of instance tags to which this route applies.

401

"A String",

402

],

403

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

404

{

Bu Sun Kim

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

[diff] [blame^]

405

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

406

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

407

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

408

{

Bu Sun Kim

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

[diff] [blame^]

409

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

410

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

411

},

412

],

Bu Sun Kim

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

[diff] [blame^]

413

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

414

},

415

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

416

},

417

],

Bu Sun Kim

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

[diff] [blame^]

418

"kind": "compute#routeList", # Type of resource.

419

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

420

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

421

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

422

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

423

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

424

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

Bu Sun Kim

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

[diff] [blame]

425

{

Bu Sun Kim

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

[diff] [blame^]

426

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

427

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

428

},

429

],

Bu Sun Kim