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

2020-05-20 12:08:20 -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

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>

Bu Sun Kim

2020-05-20 12:08:20 -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

Dmitry Frenkel

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

[diff] [blame]

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>

Bu Sun Kim

2020-05-20 12:08:20 -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

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

Bu Sun Kim

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

[diff] [blame]

116

117

Returns:

118

An object of the form:

119

yoshi-code-bot

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

2021-01-15 07:10:04 -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.

Bu Sun Kim

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

[diff] [blame]

127

{

Yoshi Automation Bot

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

131

},

132

],

Yoshi Automation Bot

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

[diff] [blame]

133

},

134

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

yoshi-code-bot

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

[diff] [blame]

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.

Yoshi Automation Bot

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

[diff] [blame]

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

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

{

154

"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

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

[diff] [blame]

155

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

Yoshi Automation Bot

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

[diff] [blame]

156

{

157

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

158

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

159

},

160

],

161

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

162

},

163

],

164

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

165

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

169

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

Bu Sun Kim

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

[diff] [blame]

170

<pre>Returns the specified PublicAdvertisedPrefix resource.

171

172

Args:

173

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

174

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

yoshi-code-bot

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

[diff] [blame]

175

x__xgafv: string, V1 error format.

176

Allowed values

177

1 - v1 error format

178

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

179

180

Returns:

181

An object of the form:

182

183

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

Yoshi Automation Bot

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

[diff] [blame]

184

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

185

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

186

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

yoshi-code-bot

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

[diff] [blame]

187

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

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

[diff] [blame]

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

},

200

],

201

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

202

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

203

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

204

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

205

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

209

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

Bu Sun Kim

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

[diff] [blame]

210

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

211

212

Args:

213

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

214

body: object, The request body.

215

The object takes the form of:

216

217

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

218

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

219

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

220

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

yoshi-code-bot

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

Bu Sun Kim

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

[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 advertised prefix.

224

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

225

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

226

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

227

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

Dmitry Frenkel

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

[diff] [blame]

228

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

Bu Sun Kim

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

[diff] [blame]

229

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

Dmitry Frenkel

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

[diff] [blame]

230

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

Bu Sun Kim

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

[diff] [blame]

231

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

Dmitry Frenkel

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

[diff] [blame]

232

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

Bu Sun Kim

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

[diff] [blame]

233

},

234

],

235

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

236

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

237

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

238

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

239

}

240

yoshi-code-bot

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

[diff] [blame]

241

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

242

x__xgafv: string, V1 error format.

243

Allowed values

244

1 - v1 error format

245

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

246

247

Returns:

248

An object of the form:

249

yoshi-code-bot

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

[diff] [blame]

250

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

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

[diff] [blame]

251

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

252

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

253

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

254

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

255

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

256

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

Bu Sun Kim

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

[diff] [blame]

257

{

Yoshi Automation Bot

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

[diff] [blame]

258

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

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

},

262

],

Yoshi Automation Bot

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

[diff] [blame]

263

},

264

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

265

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

266

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

267

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

268

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

269

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

yoshi-code-bot

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

[diff] [blame]

270

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

Yoshi Automation Bot

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

[diff] [blame]

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

{

284

"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

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

[diff] [blame]

285

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

Yoshi Automation Bot

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

[diff] [blame]

286

{

287

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

288

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

289

},

290

],

291

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

292

},

293

],

294

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

295

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

299

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

Bu Sun Kim

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

[diff] [blame]

300

<pre>Lists the PublicAdvertisedPrefixes for a project.

301

302

Args:

303

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

yoshi-code-bot

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

[diff] [blame]

304

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

Bu Sun Kim

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

[diff] [blame]

305

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

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

[diff] [blame]

306

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.

Bu Sun Kim

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

[diff] [blame]

307

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.

yoshi-code-bot

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

[diff] [blame]

308

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

yoshi-code-bot

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

[diff] [blame]

309

x__xgafv: string, V1 error format.

310

Allowed values

311

1 - v1 error format

312

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

313

314

Returns:

315

An object of the form:

316

317

{

Yoshi Automation Bot

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

[diff] [blame]

318

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

319

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

320

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

321

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

322

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

323

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

yoshi-code-bot

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

[diff] [blame]

324

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

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

[diff] [blame]

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

Bu Sun Kim

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

[diff] [blame]

336

},

337

],

Yoshi Automation Bot

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

[diff] [blame]

338

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

339

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

340

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

341

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

Bu Sun Kim

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

[diff] [blame]

342

},

Yoshi Automation Bot

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

[diff] [blame]

343

],

344

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

345

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

346

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

347

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

348

"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

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

[diff] [blame]

349

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

Yoshi Automation Bot

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

[diff] [blame]

350

{

351

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

352

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

353

},

354

],

355

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

356

},

357

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

362

<pre>Retrieves the next page of results.

363

364

Args:

365

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

366

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

367

368

Returns:

369

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

370

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]

375

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

Bu Sun Kim

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

[diff] [blame]

376

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

377

378

Args:

379

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

380

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

381

body: object, The request body.

382

The object takes the form of:

383

384

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

385

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

386

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

387

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

yoshi-code-bot

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

[diff] [blame]

388

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

Bu Sun Kim

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

[diff] [blame]

389

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

390

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

391

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

392

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

393

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

394

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

Dmitry Frenkel

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

[diff] [blame]

395

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

Bu Sun Kim

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

[diff] [blame]

396

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

Dmitry Frenkel

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

[diff] [blame]

397

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

Bu Sun Kim

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

[diff] [blame]

398

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

Dmitry Frenkel

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

[diff] [blame]

399

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

Bu Sun Kim

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

[diff] [blame]

400

},

401

],

402

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

403

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

404

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

405

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

406

}

407

yoshi-code-bot

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

[diff] [blame]

408

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

409

x__xgafv: string, V1 error format.

410

Allowed values

411

1 - v1 error format

412

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

413

414

Returns:

415

An object of the form:

416

yoshi-code-bot

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

[diff] [blame]

417

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

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

[diff] [blame]

418

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

419

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

420

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

421

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

422

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

423

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

Bu Sun Kim

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

[diff] [blame]

424

{

Yoshi Automation Bot

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

[diff] [blame]

425

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

426

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

427

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

Bu Sun Kim

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

[diff] [blame]

428

},

429

],

Yoshi Automation Bot

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

[diff] [blame]

430

},

431

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

432

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

433

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

434

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

435

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

436

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

yoshi-code-bot

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

[diff] [blame]

437

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

Yoshi Automation Bot

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

[diff] [blame]

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

{

451

"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

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

[diff] [blame]

452

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

Yoshi Automation Bot