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

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

[diff] [blame]

87

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

88

<p class="firstline">Deletes the specified regional HealthCheckService.</p>

89

90

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

91

<p class="firstline">Returns the specified regional HealthCheckService resource.</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">Creates a regional HealthCheckService resource in the specified project and region using the data 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 all the HealthCheckService resources that have been configured for the specified 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="#patch">patch(project, region, healthCheckService, body=None, requestId=None)</a></code></p>

103

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

104

105

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

106

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

107

<h3>Method Details</h3>

108

yoshi-code-bot

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

[diff] [blame^]

109

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

110

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

111

112

Args:

113

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

114

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

115

116

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

117

118

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.

119

120

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

121

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.

122

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

123

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

124

125

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.

126

127

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

128

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.

129

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

130

131

Returns:

132

An object of the form:

133

134

{ # Contains a list of HealthCheckServicesScopedList.

135

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

136

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

137

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

138

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

139

{ # Represents a Health-Check as a Service resource.

140

#

141

# (== resource_for {$api_version}.regionHealthCheckServices ==)

142

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

143

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

144

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

145

"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs.

146

"A String",

147

],

148

"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

149

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

150

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

151

"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead.

152

#

153

# Policy for how the results from multiple health checks for the same endpoint are aggregated.

154

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

155

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

156

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

157

"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

158

"name": "A String", # Name of the resource. 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.

159

"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.

160

"A String",

161

],

162

"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.

163

"A String",

164

],

165

"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

166

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

167

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

168

},

169

],

170

"warning": { # Informational warning which replaces the list of backend services when the list is empty.

171

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

172

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

173

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

174

{

175

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

176

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

177

},

178

],

179

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

},

},

},

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

184

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

185

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

186

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

187

"A String",

188

],

189

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

190

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

191

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

192

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

193

{

194

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

195

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

196

},

197

],

198

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

205

<pre>Retrieves the next page of results.

206

207

Args:

208

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

209

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

210

211

Returns:

212

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

213

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]

218

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

219

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

223

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

224

<pre>Deletes the specified regional HealthCheckService.

225

226

Args:

227

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

228

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

229

healthCheckService: string, Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. (required)

230

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.

231

232

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.

233

234

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

235

236

Returns:

237

An object of the form:

238

239

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

240

#

241

# Google Compute Engine has three Operation resources:

242

#

243

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

244

#

245

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

246

#

247

# Operations can be global, regional or zonal.

248

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

249

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

250

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

251

#

252

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

253

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

254

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

255

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

256

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

257

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

258

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

Bu Sun Kim

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

[diff] [blame]

259

{

Yoshi Automation Bot

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

[diff] [blame]

260

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

261

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

262

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

Bu Sun Kim

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

[diff] [blame]

263

},

264

],

Yoshi Automation Bot

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

[diff] [blame]

265

},

266

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

267

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

268

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

269

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

270

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

271

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

272

#

273

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

274

#

275

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

276

#

277

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

278

#

279

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

280

#

281

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

282

#

283

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

284

#

285

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

286

#

287

# Example 4: Pack and unpack a message in Go

288

#

289

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

290

#

291

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

296

#

297

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

298

#

299

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

300

#

301

# 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][]):

302

#

303

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

304

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

305

#

306

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

307

#

308

# * 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.)

309

#

310

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

311

#

312

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

313

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

314

},

Yoshi Automation Bot

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

[diff] [blame]

315

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

yoshi-code-bot

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

[diff] [blame^]

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

{

330

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

331

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

332

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

333

{

334

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

335

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

336

},

337

],

338

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

339

},

340

],

341

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

342

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

347

<pre>Returns the specified regional HealthCheckService resource.

348

349

Args:

350

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

351

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

352

healthCheckService: string, Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. (required)

353

354

Returns:

355

An object of the form:

356

Bu Sun Kim

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

[diff] [blame]

357

{ # Represents a Health-Check as a Service resource.

Yoshi Automation Bot

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

[diff] [blame]

358

#

359

# (== resource_for {$api_version}.regionHealthCheckServices ==)

360

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

361

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

362

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

363

"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs.

364

"A String",

365

],

366

"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

367

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

368

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

369

"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead.

Bu Sun Kim

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

[diff] [blame]

370

#

Yoshi Automation Bot

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

[diff] [blame]

371

# Policy for how the results from multiple health checks for the same endpoint are aggregated.

372

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

373

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

374

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

375

"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

376

"name": "A String", # Name of the resource. 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.

377

"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.

378

"A String",

379

],

380

"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.

381

"A String",

382

],

383

"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

384

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

385

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

386

}</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]

390

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

391

<pre>Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.

392

393

Args:

394

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

395

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

Dan O'Meara

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

[diff] [blame]

396

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

397

The object takes the form of:

398

Bu Sun Kim

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

[diff] [blame]

399

{ # Represents a Health-Check as a Service resource.

400

#

401

# (== resource_for {$api_version}.regionHealthCheckServices ==)

402

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

403

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

404

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

405

"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs.

406

"A String",

407

],

408

"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

409

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

410

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

411

"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead.

412

#

413

# Policy for how the results from multiple health checks for the same endpoint are aggregated.

Bu Sun Kim

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

[diff] [blame]

414

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

415

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

416

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

417

"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

418

"name": "A String", # Name of the resource. 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.

419

"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.

420

"A String",

421

],

422

"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.

423

"A String",

424

],

425

"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

426

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

427

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

428

}

Bu Sun Kim

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

[diff] [blame]

429

430

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.

431

432

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.

433

434

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

435

436

Returns:

437

An object of the form:

438

439

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

440

#

441

# Google Compute Engine has three Operation resources:

442

#

443

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

444

#

445

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

446

#

447

# Operations can be global, regional or zonal.

448

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

449

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

450

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

451

#

452

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

453

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

454

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

455

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

456

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

457

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

458

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

Bu Sun Kim

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

[diff] [blame]

459

{

Yoshi Automation Bot

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

[diff] [blame]

460

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

461

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

462

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

Bu Sun Kim

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

[diff] [blame]

463

},

464

],

Yoshi Automation Bot

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

[diff] [blame]

465

},

466

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

467

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

468

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

469

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

470

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

471

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

472

#

473

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

474

#

475

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

476

#

477

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

478

#

479

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

480

#

481

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

482

#

483

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

484

#

485

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

486

#

487

# Example 4: Pack and unpack a message in Go

488

#

489

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

490

#

491

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

496

#

497

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

498

#

499

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

500

#

501

# 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][]):

502

#

503

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

504

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

505

#

506

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

507

#

508

# * 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.)

509

#

510

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

511

#

512

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

513

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

514

},

Yoshi Automation Bot

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

[diff] [blame]

515

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

yoshi-code-bot

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

[diff] [blame^]

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

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

529

{

530

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

531

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

532

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

533

{

534

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

535

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

536

},

537

],

538

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

539

},

540

],

541

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

542

}</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]

546

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

547

<pre>Lists all the HealthCheckService resources that have been configured for the specified project in the given region.

548

549

Args:

550

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

551

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

Dan O'Meara

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

[diff] [blame]

552

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]

553

Dan O'Meara

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

[diff] [blame]

554

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]

555

Dan O'Meara

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

[diff] [blame]

556

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]

557

Bu Sun Kim

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

[diff] [blame]

558

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

559

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

560

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

561

562

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.

563

564

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

565

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

566

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]

567

568

Returns:

569

An object of the form:

570

571

{

Yoshi Automation Bot

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

[diff] [blame]

572

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

573

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

574

{ # Represents a Health-Check as a Service resource.

575

#

576

# (== resource_for {$api_version}.regionHealthCheckServices ==)

577

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

578

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

579

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

580

"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs.

581

"A String",

582

],

583

"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

584

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

585

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

586

"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead.

Bu Sun Kim

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

[diff] [blame]

587

#

Yoshi Automation Bot

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

[diff] [blame]

588

# Policy for how the results from multiple health checks for the same endpoint are aggregated.

589

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

590

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

591

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

592

"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

593

"name": "A String", # Name of the resource. 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.

594

"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.

595

"A String",

596

],

597

"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.

598

"A String",

599

],

600

"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

601

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

602

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

603

},

604

],

605

"kind": "compute#healthCheckServicesList", # [Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.

606

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

607

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

608

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

609

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

610

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

611

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

612

{

613

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

614

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

615

},

Bu Sun Kim

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

[diff] [blame]

616

],

Yoshi Automation Bot

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

[diff] [blame]

617

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

618

},

619

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

624

<pre>Retrieves the next page of results.

625

626

Args:

627

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

628

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

629

630

Returns:

Bu Sun Kim

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

[diff] [blame]

631

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

Bu Sun Kim

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

[diff] [blame]

632

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

637

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

638

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

639

640

Args:

641

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

642

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

643

healthCheckService: string, Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. (required)

644

body: object, The request body.

645

The object takes the form of:

646

Bu Sun Kim

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

[diff] [blame]

647

{ # Represents a Health-Check as a Service resource.

648

#

649

# (== resource_for {$api_version}.regionHealthCheckServices ==)

650

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

651

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

652

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

653

"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs.

654

"A String",

655

],

656

"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

657

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

658

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

659

"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead.

660

#

661

# Policy for how the results from multiple health checks for the same endpoint are aggregated.

Bu Sun Kim

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

[diff] [blame]

662

# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.

663

# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .

664

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

665

"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

666

"name": "A String", # Name of the resource. 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.

667

"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.

668

"A String",

669

],

670

"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.

671

"A String",

672

],

673

"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

674

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

675

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

676

}

Dan O'Meara

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

[diff] [blame]

677

678

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.

679

680

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.

681

682

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

683

684

Returns:

685

An object of the form:

686

687

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

688

#

689

# Google Compute Engine has three Operation resources:

690

#

691

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

692

#

693

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

694

#

695

# Operations can be global, regional or zonal.

696

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

697

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

698

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

699

#

700

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

701

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

702

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

703

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

704

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

705

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

706

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

Bu Sun Kim

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

[diff] [blame]

707

{

Yoshi Automation Bot

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

[diff] [blame]

708

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

709

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

710

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

Bu Sun Kim

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

[diff] [blame]

711

},

712

],

Yoshi Automation Bot

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

[diff] [blame]

713

},

714

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

715

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

716

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

717

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

718

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

719

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

720

#

721

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

722

#

723

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

724

#

725

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

726

#

727

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

728

#

729

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

730

#

731

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

732

#

733

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

734

#

735

# Example 4: Pack and unpack a message in Go

736

#

737

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

738

#

739

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

744

#

745

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

746

#

747

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

748

#

749

# 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][]):

750

#

751

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

752

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

753

#

754

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

755

#

756

# * 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.)

757

#

758

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

759

#

760

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

761

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

762

},

Yoshi Automation Bot

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

[diff] [blame]

763

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

yoshi-code-bot

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

[diff] [blame^]

764

"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