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

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

79

<p class="firstline">Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.</p>

80

81

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

82

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

83

84

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

85

<p class="firstline">Deletes the specified PublicDelegatedPrefix in the given region.</p>

86

87

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

88

<p class="firstline">Returns the specified PublicDelegatedPrefix resource in the given region.</p>

89

90

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

91

<p class="firstline">Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.</p>

92

93

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

94

<p class="firstline">Lists the PublicDelegatedPrefixes for a project in the given region.</p>

95

96

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

97

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

98

99

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

100

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

101

<h3>Method Details</h3>

102

103

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

104

<pre>Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.

105

106

Args:

107

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

108

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

109

110

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

111

112

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.

113

114

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

115

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

116

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

117

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

118

119

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.

120

121

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

122

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.

123

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.

124

125

Returns:

126

An object of the form:

127

128

{

129

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

130

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

131

"a_key": { # [Output Only] Name of the scope containing this set of PublicDelegatedPrefixes.

132

"publicDelegatedPrefixes": [ # [Output Only] A list of PublicDelegatedPrefixes contained in this scope.

133

{ # A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

134

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

135

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

136

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

137

#

138

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

139

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

140

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this public delegated prefix.

141

"kind": "compute#publicDelegatedPrefix", # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

142

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

143

"parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

144

"publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public delegated prefix.

145

{ # Represents a sub PublicDelegatedPrefix.

146

"delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.

147

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

148

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this sub public delegated prefix.

149

"isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.

150

"name": "A String", # The name of the sub public delegated prefix.

151

"region": "A String", # [Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.

152

"status": "A String", # [Output Only] The status of the sub public delegated prefix.

153

},

154

],

155

"region": "A String", # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

156

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

157

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

158

"status": "A String", # [Output Only] The status of the public delegated prefix.

159

},

160

],

161

"warning": { # [Output Only] Informational warning which replaces the list of public delegated prefixes when the list is empty.

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.

},

},

},

"kind": "compute#publicDelegatedPrefixAggregatedList", # [Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes.

175

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

176

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

177

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

178

"A String",

179

],

180

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

181

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

182

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

183

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

184

{

185

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

186

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

187

},

188

],

189

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

},

}</pre>

</div>

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

196

<pre>Retrieves the next page of results.

197

198

Args:

199

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

200

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

201

202

Returns:

203

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

204

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

</pre>

</div>

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

210

<pre>Deletes the specified PublicDelegatedPrefix in the given region.

211

212

Args:

213

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

214

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

215

publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to delete. (required)

216

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.

217

218

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.

219

220

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

221

222

Returns:

223

An object of the form:

224

225

{ # Represents an Operation resource.

226

#

227

# Google Compute Engine has three Operation resources:

228

#

229

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

230

#

231

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

232

#

233

# Operations can be global, regional or zonal.

234

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

235

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

236

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

237

#

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

{

246

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

247

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

248

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

},

],

},

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

{

271

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

272

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

273

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

274

{

275

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

276

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

277

},

278

],

279

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

280

},

281

],

282

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

}</pre>

</div>

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

288

<pre>Returns the specified PublicDelegatedPrefix resource in the given region.

289

290

Args:

291

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

292

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

293

publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to return. (required)

294

295

Returns:

296

An object of the form:

297

298

{ # A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

299

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

300

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

301

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

302

#

303

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

304

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

305

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this public delegated prefix.

306

"kind": "compute#publicDelegatedPrefix", # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

307

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

308

"parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

309

"publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public delegated prefix.

310

{ # Represents a sub PublicDelegatedPrefix.

311

"delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.

312

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

313

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this sub public delegated prefix.

314

"isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.

315

"name": "A String", # The name of the sub public delegated prefix.

316

"region": "A String", # [Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.

317

"status": "A String", # [Output Only] The status of the sub public delegated prefix.

318

},

319

],

320

"region": "A String", # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

321

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

322

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

323

"status": "A String", # [Output Only] The status of the public delegated prefix.

}</pre>

</div>

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

329

<pre>Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.

330

331

Args:

332

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

333

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

334

body: object, The request body.

335

The object takes the form of:

336

337

{ # A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

338

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

339

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

340

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

341

#

342

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

343

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

344

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this public delegated prefix.

345

"kind": "compute#publicDelegatedPrefix", # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

346

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

347

"parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

348

"publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public delegated prefix.

349

{ # Represents a sub PublicDelegatedPrefix.

350

"delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.

351

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

352

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this sub public delegated prefix.

353

"isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.

354

"name": "A String", # The name of the sub public delegated prefix.

355

"region": "A String", # [Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.

356

"status": "A String", # [Output Only] The status of the sub public delegated prefix.

357

},

358

],

359

"region": "A String", # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

360

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

361

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

362

"status": "A String", # [Output Only] The status of the public delegated prefix.

363

}

364

365

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.

366

367

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.

368

369

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

370

371

Returns:

372

An object of the form:

373

374

{ # Represents an Operation resource.

375

#

376

# Google Compute Engine has three Operation resources:

377

#

378

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

379

#

380

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

381

#

382

# Operations can be global, regional or zonal.

383

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

384

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

385

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

386

#

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

{

395

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

396

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

397

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

},

],

},

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

{

420

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

421

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

422

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

423

{

424

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

425

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

426

},

427

],

428

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

429

},

430

],

431

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

}</pre>

</div>

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

437

<pre>Lists the PublicDelegatedPrefixes for a project in the given region.

438

439

Args:

440

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

441

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

442

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

443

444

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

445

446

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.

447

448

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

449

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

450

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

451

452

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.

453

454

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

455

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.

456

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.

457

458

Returns:

459

An object of the form:

460

461

{

462

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

463

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

464

{ # A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

465

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

466

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

467

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

468

#

469

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

470

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

471

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this public delegated prefix.

472

"kind": "compute#publicDelegatedPrefix", # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

473

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

474

"parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

475

"publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public delegated prefix.

476

{ # Represents a sub PublicDelegatedPrefix.

477

"delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.

478

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

479

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this sub public delegated prefix.

480

"isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.

481

"name": "A String", # The name of the sub public delegated prefix.

482

"region": "A String", # [Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.

483

"status": "A String", # [Output Only] The status of the sub public delegated prefix.

484

},

485

],

486

"region": "A String", # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

487

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

488

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

489

"status": "A String", # [Output Only] The status of the public delegated prefix.

490

},

491

],

492

"kind": "compute#publicDelegatedPrefixList", # [Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.

493

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

494

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

495

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

496

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

497

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

498

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

499

{

500

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

501

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

502

},

503

],

504

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

},

}</pre>

</div>

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

511

<pre>Retrieves the next page of results.

512

513

Args:

514

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

515

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

516

517

Returns:

518

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

519

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

</pre>

</div>

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

525

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

526

527

Args:

528

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

529

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

530

publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to patch. (required)

531

body: object, The request body.

532

The object takes the form of:

533

534

{ # A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

535

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

536

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

537

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

538

#

539

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

540

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

541

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this public delegated prefix.

542

"kind": "compute#publicDelegatedPrefix", # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

543

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

544

"parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

545

"publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public delegated prefix.

546

{ # Represents a sub PublicDelegatedPrefix.

547

"delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.

548

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

549

"ipCidrRange": "A String", # The IPv4 address range, in CIDR format, represented by this sub public delegated prefix.

550

"isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.

551

"name": "A String", # The name of the sub public delegated prefix.

552

"region": "A String", # [Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.

553

"status": "A String", # [Output Only] The status of the sub public delegated prefix.

554

},

555

],

556

"region": "A String", # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

557

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

558

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

559

"status": "A String", # [Output Only] The status of the public delegated prefix.

560

}

561

562

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.

563

564

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.

565

566

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

567

568

Returns:

569

An object of the form:

570

571

{ # Represents an Operation resource.

572

#

573

# Google Compute Engine has three Operation resources:

574

#

575

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

576

#

577

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

578

#

579

# Operations can be global, regional or zonal.

580

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

581

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

582

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

583

#

584

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

585

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

586

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

587

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

588

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

589

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

590

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

591

{

592

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

593

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

594

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

},

],

},

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

{

617

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

618

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

619

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

620

{

621

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

622

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

623

},

624

],

625

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

626

},

627

],