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

<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

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

91

<p class="firstline">Lists the PublicAdvertisedPrefixes 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, publicAdvertisedPrefix, body=None, requestId=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

97

<p class="firstline">Patches the specified Router 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, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</code>

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

106

<pre>Deletes the specified PublicAdvertisedPrefix

107

108

Args:

109

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

110

publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix 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

a8b35b9

2021-03-31 13:33:30 -0700

[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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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

a8b35b9

2021-03-31 13:33:30 -0700

[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

a8b35b9

2021-03-31 13:33:30 -0700

[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, publicAdvertisedPrefix, x__xgafv=None)</code>

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

169

<pre>Returns the specified PublicAdvertisedPrefix resource.

170

171

Args:

172

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

173

publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix 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

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

178

179

Returns:

180

An object of the form:

181

182

{ # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.

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.

185

"dnsVerificationIp": "A String", # The IPv4 address to be used for reverse DNS verification.

yoshi-code-bot

3659137

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

[diff] [blame]

186

"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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

187

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

188

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

189

"kind": "compute#publicAdvertisedPrefix", # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised 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

"publicDelegatedPrefixs": [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

192

{ # Represents a CIDR range which can be used to assign addresses.

193

"ipRange": "A String", # The IP address range of the public delegated prefix

194

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

195

"project": "A String", # The project number of the public delegated prefix

196

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

197

"status": "A String", # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

198

},

199

],

200

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

201

"sharedSecret": "A String", # [Output Only] The shared secret to be used for reverse DNS verification.

202

"status": "A String", # The status of the public advertised prefix.

}</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

207

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

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

208

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

209

210

Args:

211

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

212

body: object, The request body.

213

The object takes the form of:

214

215

{ # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.

216

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

217

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

218

"dnsVerificationIp": "A String", # The IPv4 address to be used for reverse DNS verification.

yoshi-code-bot

3659137

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

[diff] [blame]

219

"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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

220

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

221

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

222

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

223

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

224

"publicDelegatedPrefixs": [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

225

{ # Represents a CIDR range which can be used to assign addresses.

226

"ipRange": "A String", # The IP address range of the public delegated prefix

227

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

228

"project": "A String", # The project number of the public delegated prefix

229

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

230

"status": "A String", # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

231

},

232

],

233

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

234

"sharedSecret": "A String", # [Output Only] The shared secret to be used for reverse DNS verification.

235

"status": "A String", # The status of the public advertised prefix.

236

}

237

yoshi-code-bot

3659137

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

[diff] [blame]

238

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

239

x__xgafv: string, V1 error format.

240

Allowed values

241

1 - v1 error format

242

2 - v2 error format

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

243

244

Returns:

245

An object of the form:

246

yoshi-code-bot

3659137

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

[diff] [blame]

247

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

248

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

249

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

250

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

251

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

252

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

253

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

254

{

255

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

256

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

257

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

{

280

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

281

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

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

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

[diff] [blame]

295

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

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

296

<pre>Lists the PublicAdvertisedPrefixes for a project.

297

298

Args:

299

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

yoshi-code-bot

3659137

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

[diff] [blame]

300

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

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

301

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]

302

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

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

303

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.

304

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]

305

x__xgafv: string, V1 error format.

306

Allowed values

307

1 - v1 error format

308

2 - v2 error format

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

309

310

Returns:

311

An object of the form:

312

313

{

314

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

315

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

316

{ # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.

317

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

318

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

319

"dnsVerificationIp": "A String", # The IPv4 address to be used for reverse DNS verification.

yoshi-code-bot

3659137

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

[diff] [blame]

320

"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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

321

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

322

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

323

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

324

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

325

"publicDelegatedPrefixs": [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

326

{ # Represents a CIDR range which can be used to assign addresses.

327

"ipRange": "A String", # The IP address range of the public delegated prefix

328

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

329

"project": "A String", # The project number of the public delegated prefix

330

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

331

"status": "A String", # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

332

},

333

],

334

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

335

"sharedSecret": "A String", # [Output Only] The shared secret to be used for reverse DNS verification.

336

"status": "A String", # The status of the public advertised prefix.

337

},

338

],

339

"kind": "compute#publicAdvertisedPrefixList", # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

340

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

341

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

342

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

343

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

344

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

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

345

{

346

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

347

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

348

},

349

],

350

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

357

<pre>Retrieves the next page of results.

358

359

Args:

360

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

361

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

362

363

Returns:

364

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

365

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]

370

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

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

371

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

372

373

Args:

374

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

375

publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to patch. (required)

376

body: object, The request body.

377

The object takes the form of:

378

379

{ # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.

380

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

381

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

382

"dnsVerificationIp": "A String", # The IPv4 address to be used for reverse DNS verification.

yoshi-code-bot

3659137

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

[diff] [blame]

383

"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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

384

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

385

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

386

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

387

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

388

"publicDelegatedPrefixs": [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

389

{ # Represents a CIDR range which can be used to assign addresses.

390

"ipRange": "A String", # The IP address range of the public delegated prefix

391

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

392

"project": "A String", # The project number of the public delegated prefix

393

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

394

"status": "A String", # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

395

},

396

],

397

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

398

"sharedSecret": "A String", # [Output Only] The shared secret to be used for reverse DNS verification.

399

"status": "A String", # The status of the public advertised prefix.

400

}

401

yoshi-code-bot

3659137

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

[diff] [blame]

402

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

403

x__xgafv: string, V1 error format.

404

Allowed values

405

1 - v1 error format

406

2 - v2 error format

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

407

408

Returns:

409

An object of the form:

410

yoshi-code-bot

3659137

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

[diff] [blame]

411

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

412

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

413

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

414

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

415

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

416

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

417

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

418

{

419

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

420

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

421

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

{

444

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

445

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

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

446

{

447

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

448

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

449

},

450

],

451

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

452

},

453

],