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

<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.globalPublicDelegatedPrefixes.html">globalPublicDelegatedPrefixes</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

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

80

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

81

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

82

<p class="firstline">Deletes the specified global PublicDelegatedPrefix.</p>

83

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

84

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

85

<p class="firstline">Returns the specified global PublicDelegatedPrefix resource.</p>

86

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

87

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

88

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

89

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

90

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

91

<p class="firstline">Lists the global PublicDelegatedPrefixes for a project.</p>

92

93

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

94

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

95

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

96

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

97

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

98

<h3>Method Details</h3>

99

100

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

101

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

105

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

106

<pre>Deletes the specified global PublicDelegatedPrefix.

107

108

Args:

109

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

110

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

111

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder

112

x__xgafv: string, V1 error format.

113

Allowed values

114

1 - v1 error format

115

2 - v2 error format

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

116

117

Returns:

118

An object of the form:

119

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

120

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

121

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

122

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

123

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

124

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

125

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

126

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

127

{

128

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

129

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

130

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

{

153

"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

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

154

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

155

{

156

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

157

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

158

},

159

],

160

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

161

},

162

],

163

"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-16 00:22:06 -0700

[diff] [blame]

168

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

169

<pre>Returns the specified global PublicDelegatedPrefix resource.

170

171

Args:

172

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

173

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

174

x__xgafv: string, V1 error format.

175

Allowed values

176

1 - v1 error format

177

2 - v2 error format

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

178

179

Returns:

180

An object of the form:

181

182

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

183

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

184

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

{ # Represents a sub PublicDelegatedPrefix.

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

},

202

],

203

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

204

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

205

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

}</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

210

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

211

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

212

213

Args:

214

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

215

body: object, The request body.

216

The object takes the form of:

217

218

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

219

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

220

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

{ # Represents a sub PublicDelegatedPrefix.

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

},

238

],

239

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

240

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

241

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

242

}

243

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

244

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder

245

x__xgafv: string, V1 error format.

246

Allowed values

247

1 - v1 error format

248

2 - v2 error format

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

249

250

Returns:

251

An object of the form:

252

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

253

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

254

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

255

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

256

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

257

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

258

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

259

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

260

{

261

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

262

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

263

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

{

286

"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

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

287

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

288

{

289

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

290

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

291

},

292

],

293

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

294

},

295

],

296

"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-16 00:22:06 -0700

[diff] [blame]

301

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

302

<pre>Lists the global PublicDelegatedPrefixes for a project.

303

304

Args:

305

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

306

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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]

307

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

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

308

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

309

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.

310

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

311

x__xgafv: string, V1 error format.

312

Allowed values

313

1 - v1 error format

314

2 - v2 error format

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

315

316

Returns:

317

An object of the form:

318

319

{

320

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

321

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

322

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

323

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

324

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

{ # Represents a sub PublicDelegatedPrefix.

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

},

342

],

343

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

344

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

345

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

346

},

347

],

348

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

349

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

350

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

351

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

352

"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

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

353

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

354

{

355

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

356

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

357

},

358

],

359

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

366

<pre>Retrieves the next page of results.

367

368

Args:

369

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

370

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

371

372

Returns:

373

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

374

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

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

379

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

380

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

381

382

Args:

383

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

384

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

385

body: object, The request body.

386

The object takes the form of:

387

388

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

389

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

390

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

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

{ # Represents a sub PublicDelegatedPrefix.

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

},

408

],

409

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

410

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

411

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

412

}

413

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

414

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder

415

x__xgafv: string, V1 error format.

416

Allowed values

417

1 - v1 error format

418

2 - v2 error format

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

419

420

Returns:

421

An object of the form:

422

yoshi-code-bot

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

423

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

424

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

425

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

426

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

427

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

428

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

429

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

430

{

431

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

432

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

433

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

},

],

},

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

438

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

{

456

"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

3659137

2021-06-16 00:22:06 -0700

[diff] [blame]

457

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

458

{

459

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

460

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

461

},

462

],

463

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

464

},

465

],