Blame - docs/dyn/compute_beta.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>

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

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="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

87

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

88

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

89

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

90

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

91

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

92

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

93

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

94

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

95

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

96

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

97

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

98

99

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

100

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

101

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

102

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

103

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

104

<h3>Method Details</h3>

105

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

106

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

107

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

108

109

Args:

110

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

111

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

112

113

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

114

115

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.

116

117

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

118

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.

119

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

120

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

121

122

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.

123

124

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

125

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.

126

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

127

128

Returns:

129

An object of the form:

130

131

{

132

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

133

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

134

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

135

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

136

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

137

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

138

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

139

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

140

#

141

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

142

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

143

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

144

"isLiveMigration": True or False, # If true, the prefix will be live migrated.

145

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

146

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

147

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

148

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

149

{ # Represents a sub PublicDelegatedPrefix.

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

},

158

],

159

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

160

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

161

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

162

},

163

],

164

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

165

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

166

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

167

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

168

{

169

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

170

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

171

},

172

],

173

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

178

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

179

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

180

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

181

"A String",

182

],

183

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

184

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

185

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

186

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

187

{

188

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

189

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

190

},

191

],

192

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

199

<pre>Retrieves the next page of results.

200

201

Args:

202

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

203

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

204

205

Returns:

206

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

207

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

</pre>

</div>

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

213

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-12 00:20:02 -0700

[diff] [blame]

217

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

218

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

219

220

Args:

221

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

222

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

223

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

224

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.

225

226

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.

227

228

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

229

230

Returns:

231

An object of the form:

232

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

233

{ # Represents an Operation resource.

234

#

235

# Google Compute Engine has three Operation resources:

236

#

237

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

238

#

239

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

240

#

241

# Operations can be global, regional or zonal.

242

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

243

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

244

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

245

#

246

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

247

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

248

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

249

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

250

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

251

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

252

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

253

{

254

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

255

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

256

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

261

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

262

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

263

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

264

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

265

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

266

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

{

279

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

280

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

281

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

282

{

283

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

284

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

285

},

286

],

287

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

288

},

289

],

290

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

}</pre>

</div>

yoshi-code-bot

2021-06-12 00:20:02 -0700

[diff] [blame]

295

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

296

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

297

298

Args:

299

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

300

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

301

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

302

303

Returns:

304

An object of the form:

305

306

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

307

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

308

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

309

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

310

#

311

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

312

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

313

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

314

"isLiveMigration": True or False, # If true, the prefix will be live migrated.

315

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

316

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

317

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

318

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

319

{ # Represents a sub PublicDelegatedPrefix.

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

},

328

],

329

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

330

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

331

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

}</pre>

</div>

yoshi-code-bot

2021-06-12 00:20:02 -0700

[diff] [blame]

336

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

337

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

338

339

Args:

340

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

341

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

342

body: object, The request body.

343

The object takes the form of:

344

345

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

346

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

347

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

348

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

349

#

350

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

351

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

352

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

353

"isLiveMigration": True or False, # If true, the prefix will be live migrated.

354

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

355

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

356

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

357

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

358

{ # Represents a sub PublicDelegatedPrefix.

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

},

367

],

368

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

369

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

370

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

371

}

372

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

373

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.

374

375

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.

376

377

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

378

379

Returns:

380

An object of the form:

381

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

382

{ # Represents an Operation resource.

383

#

384

# Google Compute Engine has three Operation resources:

385

#

386

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

387

#

388

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

389

#

390

# Operations can be global, regional or zonal.

391

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

392

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

393

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

394

#

395

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

396

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

397

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

398

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

399

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

400

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

401

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

402

{

403

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

404

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

405

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

410

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

411

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

412

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

413

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

414

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

415

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

{

428

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

429

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

430

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

431

{

432

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

433

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

434

},

435

],

436

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

437

},

438

],

439

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

}</pre>

</div>

yoshi-code-bot

2021-06-12 00:20:02 -0700

[diff] [blame]

444

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

445

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

446

447

Args:

448

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

449

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

450

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

451

452

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

453

454

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.

455

456

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

457

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

458

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

459

460

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.

461

462

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

463

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.

464

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

465

466

Returns:

467

An object of the form:

468

469

{

470

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

471

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

472

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

473

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

474

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

475

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

476

#

477

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

478

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

479

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

480

"isLiveMigration": True or False, # If true, the prefix will be live migrated.

481

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

482

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

483

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

484

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

485

{ # Represents a sub PublicDelegatedPrefix.

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

},

494

],

495

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

496

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

497

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

498

},

499

],

500

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

501

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

502

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

503

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

504

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

505

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

506

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

507

{

508

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

509

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

510

},

511

],

512

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

519

<pre>Retrieves the next page of results.

520

521

Args:

522

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

523

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

524

525

Returns:

526

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

527

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

</pre>

</div>

yoshi-code-bot

2021-06-12 00:20:02 -0700

[diff] [blame]

532

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

533

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

534

535

Args:

536

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

537

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

538

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

539

body: object, The request body.

540

The object takes the form of:

541

542

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

543

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

544

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

545

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

546

#

547

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

548

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

549

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

550

"isLiveMigration": True or False, # If true, the prefix will be live migrated.

551

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

552

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

553

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

554

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

555

{ # Represents a sub PublicDelegatedPrefix.

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

},

564

],

565

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

566

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

567

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

568

}

569

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

570

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.

571

572

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.

573

574

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

575

576

Returns:

577

An object of the form:

578

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

579

{ # Represents an Operation resource.

580

#

581

# Google Compute Engine has three Operation resources:

582

#

583

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

584

#

585

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

586

#

587

# Operations can be global, regional or zonal.

588

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

589

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

590

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

591

#

592

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

593

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

594

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

595

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

596

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

597

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

598

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

599

{

600

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

601

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

602

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

607

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

608

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

609

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

610

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

611

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

612

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

{

625

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

yoshi-code-bot

c3f8675

2021-06-12 00:20:02 -0700

[diff] [blame]

626

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

627

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

628

{

629

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

630

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

631

},

632

],

633

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

634

},

635

],