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

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

[diff] [blame]

78

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

79

<p class="firstline">Retrieves the list of all NotificationEndpoint resources, regional and global, available to the specified project.</p>

80

81

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

82

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

83

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

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

85

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

86

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

87

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

88

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

89

90

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

91

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

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

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

95

Bu Sun Kim

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

[diff] [blame]

96

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

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

98

99

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

100

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

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

104

<h3>Method Details</h3>

105

yoshi-code-bot

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

[diff] [blame]

106

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

107

<pre>Retrieves the list of all NotificationEndpoint resources, regional and global, available to the specified project.

108

109

Args:

110

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

111

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

112

113

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

114

115

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

116

117

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

118

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

119

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

120

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

121

122

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

123

124

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

125

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

126

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

127

128

Returns:

129

An object of the form:

130

131

{ # Contains a list of NotificationEndpointsScopedList.

132

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

133

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

134

"a_key": { # Name of the scope containing this set of NotificationEndpoints.

135

"resources": [ # A list of NotificationEndpoints contained in this scope.

136

{ # Represents a notification endpoint.

137

#

138

# A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service.

139

#

140

# For more information, see Health checks overview. (== resource_for {$api_version}.notificationEndpoint ==) (== resource_for {$api_version}.regionNotificationEndpoints ==)

141

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

142

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

143

"grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. # Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

144

"authority": "A String", # Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3

145

"endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.

146

"payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field in gRPC requests.

147

"resendInterval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed.

148

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

149

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

150

},

151

"retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.

152

},

153

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

154

"kind": "compute#notificationEndpoint", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

155

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

156

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

157

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

158

},

159

],

160

"warning": { # Informational warning which replaces the list of notification endpoints when the list is empty.

161

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

162

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

163

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

164

{

165

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

166

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

167

},

168

],

169

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

},

},

},

"kind": "compute#notificationEndpointAggregatedList", # Type of resource.

174

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

175

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

176

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

177

"A String",

178

],

179

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

180

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

181

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

182

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

183

{

184

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

185

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

186

},

187

],

188

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

},

}</pre>

</div>

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

195

<pre>Retrieves the next page of results.

196

197

Args:

198

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

199

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

200

201

Returns:

202

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

203

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

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

208

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

209

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

213

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

214

<pre>Deletes the specified NotificationEndpoint in the given region

215

216

Args:

217

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

218

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

219

notificationEndpoint: string, Name of the NotificationEndpoint resource to delete. (required)

220

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.

221

222

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.

223

224

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

225

226

Returns:

227

An object of the form:

228

229

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

230

#

231

# Google Compute Engine has three Operation resources:

232

#

233

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

234

#

235

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

236

#

237

# Operations can be global, regional or zonal.

238

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

239

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

240

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

241

#

242

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

243

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

244

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

245

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

246

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

247

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

248

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

Bu Sun Kim

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

[diff] [blame]

249

{

Yoshi Automation Bot

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

[diff] [blame]

250

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

251

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

252

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

Bu Sun Kim

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

[diff] [blame]

253

},

254

],

Yoshi Automation Bot

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

[diff] [blame]

255

},

256

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

257

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

258

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

259

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

260

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

yoshi-code-bot

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

[diff] [blame]

261

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

262

#

263

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

264

#

265

# Example 1: Pack and unpack a message in C++.

266

#

267

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

268

#

269

# Example 2: Pack and unpack a message in Java.

270

#

271

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

272

#

273

# Example 3: Pack and unpack a message in Python.

274

#

275

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

276

#

277

# Example 4: Pack and unpack a message in Go

278

#

279

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

280

#

281

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

286

#

287

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

288

#

289

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

290

#

291

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

292

#

293

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

294

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

295

#

296

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

297

#

298

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

299

#

300

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

301

#

302

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

303

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

304

},

Yoshi Automation Bot

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

[diff] [blame]

305

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

yoshi-code-bot

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

[diff] [blame]

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

{

320

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

321

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

322

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

323

{

324

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

325

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

326

},

327

],

328

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

329

},

330

],

331

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

332

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

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

337

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

338

339

Args:

340

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

341

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

342

notificationEndpoint: string, Name of the NotificationEndpoint resource to return. (required)

343

344

Returns:

345

An object of the form:

346

Bu Sun Kim

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

[diff] [blame]

347

{ # Represents a notification endpoint.

Yoshi Automation Bot

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

[diff] [blame]

348

#

349

# A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service.

350

#

351

# For more information, see Health checks overview. (== resource_for {$api_version}.notificationEndpoint ==) (== resource_for {$api_version}.regionNotificationEndpoints ==)

352

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

353

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

354

"grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. # Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

355

"authority": "A String", # Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3

356

"endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.

357

"payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field in gRPC requests.

358

"resendInterval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed.

359

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

360

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

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

[diff] [blame]

361

},

Yoshi Automation Bot

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

[diff] [blame]

362

"retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.

363

},

364

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

365

"kind": "compute#notificationEndpoint", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

366

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

367

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

368

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

369

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

373

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

374

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

375

376

Args:

377

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

378

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

379

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

380

The object takes the form of:

381

Bu Sun Kim

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

[diff] [blame]

382

{ # Represents a notification endpoint.

383

#

384

# A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service.

385

#

386

# For more information, see Health checks overview. (== resource_for {$api_version}.notificationEndpoint ==) (== resource_for {$api_version}.regionNotificationEndpoints ==)

387

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

388

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

389

"grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. # Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

390

"authority": "A String", # Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3

391

"endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.

392

"payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field in gRPC requests.

393

"resendInterval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed.

394

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

395

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

396

},

Bu Sun Kim

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

[diff] [blame]

397

"retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.

398

},

399

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

400

"kind": "compute#notificationEndpoint", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

401

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

402

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

403

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

404

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

405

406

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.

407

408

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.

409

410

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

411

412

Returns:

413

An object of the form:

414

415

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

416

#

417

# Google Compute Engine has three Operation resources:

418

#

419

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

420

#

421

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

422

#

423

# Operations can be global, regional or zonal.

424

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

425

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

426

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

427

#

428

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

429

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

430

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

431

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

432

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

433

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

434

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

Bu Sun Kim

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

[diff] [blame]

435

{

Yoshi Automation Bot

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

[diff] [blame]

436

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

437

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

438

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

Bu Sun Kim

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

[diff] [blame]

439

},

440

],

Yoshi Automation Bot

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

[diff] [blame]

441

},

442

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

443

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

444

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

445

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

446

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

yoshi-code-bot

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

[diff] [blame]

447

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

448

#

449

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

450

#

451

# Example 1: Pack and unpack a message in C++.

452

#

453

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

454

#

455

# Example 2: Pack and unpack a message in Java.

456

#

457

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

458

#

459

# Example 3: Pack and unpack a message in Python.

460

#

461

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

462

#

463

# Example 4: Pack and unpack a message in Go

464

#

465

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

466

#

467

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

472

#

473

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

474

#

475

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

476

#

477

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

478

#

479

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

480

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

481

#

482

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

483

#

484

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

485

#

486

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

487

#

488

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

489

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

490

},

Yoshi Automation Bot

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

[diff] [blame]

491

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

yoshi-code-bot

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

[diff] [blame]

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

{

506

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

507

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

508

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

509

{

510

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

511

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

512

},

513

],

514

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

515

},

516

],

517

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

518

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

522

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

523

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

524

525

Args:

526

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

527

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

528

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

529

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

530

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

531

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

532

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

533

Bu Sun Kim

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

[diff] [blame]

534

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

535

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

536

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

537

538

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.

539

540

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

541

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]

542

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

543

544

Returns:

545

An object of the form:

546

547

{

Yoshi Automation Bot

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

[diff] [blame]

548

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

549

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

550

{ # Represents a notification endpoint.

551

#

552

# A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service.

553

#

554

# For more information, see Health checks overview. (== resource_for {$api_version}.notificationEndpoint ==) (== resource_for {$api_version}.regionNotificationEndpoints ==)

555

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

556

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

557

"grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. # Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

558

"authority": "A String", # Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3

559

"endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.

560

"payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field in gRPC requests.

561

"resendInterval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed.

562

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

563

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

564

},

Yoshi Automation Bot

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

[diff] [blame]

565

"retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.

566

},

567

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

568

"kind": "compute#notificationEndpoint", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

569

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

570

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

571

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

572

},

573

],

574

"kind": "compute#notificationEndpointList", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

575

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

576

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

577

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

578

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

579

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

580

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

581

{

582

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

583

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

Bu Sun Kim

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

[diff] [blame]

584

},

Bu Sun Kim