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

2014-04-24 15:46:26 -0400

[diff] [blame]

113

114

Returns:

115

An object of the form:

116

Bu Sun Kim

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

[diff] [blame]

117

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

118

#

119

# Google Compute Engine has three Operation resources:

120

#

121

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

122

#

123

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

124

#

125

# Operations can be global, regional or zonal.

126

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

127

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

128

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

129

#

130

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

131

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

132

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

133

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

134

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

135

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

136

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

Bu Sun Kim

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

[diff] [blame]

137

{

Yoshi Automation Bot

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

[diff] [blame^]

138

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

139

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

140

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

Bu Sun Kim

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

[diff] [blame]

141

},

142

],

Yoshi Automation Bot

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

[diff] [blame^]

143

},

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

{

162

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

163

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

164

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

165

{

166

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

167

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

168

},

169

],

170

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

171

},

172

],

173

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

174

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

179

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

180

181

Args:

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

182

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

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

183

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

184

185

Returns:

186

An object of the form:

187

Bu Sun Kim

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

[diff] [blame]

188

{ # Represents a Route resource.

Yoshi Automation Bot

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

[diff] [blame^]

189

#

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

"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

199

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs:

200

# - 10.128.0.56

201

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

202

# - regions/region/forwardingRules/forwardingRule

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

"A String",

213

],

214

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

215

{

216

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

217

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

218

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

219

{

220

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

221

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

222

},

223

],

224

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

225

},

226

],

227

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

231

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

232

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

233

234

Args:

235

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

Dan O'Meara

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

[diff] [blame]

236

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

237

The object takes the form of:

238

Bu Sun Kim

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

[diff] [blame]

239

{ # Represents a Route resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

240

#

Dan O'Meara

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

[diff] [blame]

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

"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

Bu Sun Kim

673ec5c

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

[diff] [blame]

250

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs:

251

# - 10.128.0.56

Dan O'Meara

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

[diff] [blame]

252

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

253

# - regions/region/forwardingRules/forwardingRule

Bu Sun Kim

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

[diff] [blame]

254

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

255

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

Bu Sun Kim

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

[diff] [blame]

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

"A String",

264

],

265

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

266

{

Bu Sun Kim

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

[diff] [blame]

267

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

268

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

269

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

270

{

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

273

},

274

],

Bu Sun Kim

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

[diff] [blame]

275

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

276

},

277

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

278

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

279

Bu Sun Kim

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

[diff] [blame]

280

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.

281

282

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.

283

284

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

285

286

Returns:

287

An object of the form:

288

Bu Sun Kim

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

[diff] [blame]

289

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

290

#

291

# Google Compute Engine has three Operation resources:

292

#

293

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

294

#

295

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

296

#

297

# Operations can be global, regional or zonal.

298

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

299

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

300

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

301

#

302

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

303

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

304

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

305

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

306

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

307

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

308

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

Bu Sun Kim

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

[diff] [blame]

309

{

Yoshi Automation Bot

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

[diff] [blame^]

310

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

311

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

312

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

Bu Sun Kim

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

[diff] [blame]

313

},

314

],

Yoshi Automation Bot

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

[diff] [blame^]

315

},

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

{

334

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

335

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

336

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

337

{

338

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

339

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

340

},

341

],

342

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

343

},

344

],

345

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

346

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

350

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

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

351

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

352

353

Args:

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

354

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

Dan O'Meara

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

[diff] [blame]

355

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

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

356

Dan O'Meara

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

[diff] [blame]

357

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

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

358

Dan O'Meara

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

[diff] [blame]

359

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.

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

360

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

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

364

365

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.

366

367

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

368

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

369

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

370

371

Returns:

372

An object of the form:

373

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

374

{ # Contains a list of Route resources.

Yoshi Automation Bot

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

[diff] [blame^]

375

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

376

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

377

{ # Represents a Route resource.

378

#

379

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

380

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

381

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

382

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

383

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

384

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

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])?`. 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.

386

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

387

"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

388

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs:

389

# - 10.128.0.56

390

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

391

# - regions/region/forwardingRules/forwardingRule

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

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.

Bu Sun Kim

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

[diff] [blame]

404

{

Yoshi Automation Bot

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

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

408

{

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.

411

},

412

],

413

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

414

},

415

],

416

},

Yoshi Automation Bot