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

2016-10-21 13:59:49 -0700

[diff] [blame]

98

Dan O'Meara

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

[diff] [blame]

99

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

103

<p class="firstline">Updates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>

104

<h3>Method Details</h3>

105

Dmitry Frenkel

3e17f89

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

[diff] [blame]

106

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

107

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

111

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

112

<pre>Deletes the specified HttpsHealthCheck resource.

113

114

Args:

115

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

116

httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

117

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.

118

119

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.

120

121

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

122

123

Returns:

124

An object of the form:

125

Bu Sun Kim

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

[diff] [blame]

126

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

127

#

128

# Google Compute Engine has three Operation resources:

129

#

130

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

131

#

132

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

133

#

134

# Operations can be global, regional or zonal.

135

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

136

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

137

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

138

#

139

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

140

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

141

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

142

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

143

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

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

{

Yoshi Automation Bot

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

[diff] [blame]

147

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

148

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

149

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

Bu Sun Kim

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

[diff] [blame]

150

},

151

],

Yoshi Automation Bot

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

[diff] [blame]

152

},

153

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

154

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

155

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

156

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

157

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

158

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

159

#

160

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

161

#

162

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

163

#

164

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

165

#

166

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

167

#

168

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

169

#

170

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

171

#

172

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

173

#

174

# Example 4: Pack and unpack a message in Go

175

#

176

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

177

#

178

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

183

#

184

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

185

#

186

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

187

#

188

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

189

#

190

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

191

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

192

#

193

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

194

#

195

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

196

#

197

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

198

#

199

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

200

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

201

},

Yoshi Automation Bot

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

[diff] [blame]

202

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

yoshi-code-bot

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

[diff] [blame^]

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

{

217

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

218

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

219

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

220

{

221

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

222

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

223

},

224

],

225

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

226

},

227

],

228

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

229

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

234

<pre>Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

235

236

Args:

237

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

238

httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)

239

240

Returns:

241

An object of the form:

242

Dan O'Meara

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

[diff] [blame]

243

{ # Represents a legacy HTTPS Health Check resource.

Yoshi Automation Bot

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

[diff] [blame]

244

#

245

# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

246

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

247

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

248

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

249

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

250

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

251

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

252

"kind": "compute#httpsHealthCheck", # Type of the resource.

253

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

254

"port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.

255

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".

256

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

257

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

258

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.

259

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

260

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

264

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

265

<pre>Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

266

267

Args:

268

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

Dan O'Meara

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

[diff] [blame]

269

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

270

The object takes the form of:

271

Dan O'Meara

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

[diff] [blame]

272

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

273

#

274

# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

275

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

276

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

277

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

278

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

279

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

280

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

281

"kind": "compute#httpsHealthCheck", # Type of the resource.

282

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

283

"port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.

284

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".

285

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

286

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

287

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.

288

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

289

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

290

Bu Sun Kim

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

[diff] [blame]

291

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.

292

293

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.

294

295

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

296

297

Returns:

298

An object of the form:

299

Bu Sun Kim

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

[diff] [blame]

300

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

301

#

302

# Google Compute Engine has three Operation resources:

303

#

304

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

305

#

306

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

307

#

308

# Operations can be global, regional or zonal.

309

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

310

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

311

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

312

#

313

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

314

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

315

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

316

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

317

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

318

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

319

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

Bu Sun Kim

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

[diff] [blame]

320

{

Yoshi Automation Bot

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

[diff] [blame]

321

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

322

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

323

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

Bu Sun Kim

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

[diff] [blame]

324

},

325

],

Yoshi Automation Bot

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

[diff] [blame]

326

},

327

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

328

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

329

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

330

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

331

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

332

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

333

#

334

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

335

#

336

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

337

#

338

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

339

#

340

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

341

#

342

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

343

#

344

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

345

#

346

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

347

#

348

# Example 4: Pack and unpack a message in Go

349

#

350

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

351

#

352

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

357

#

358

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

359

#

360

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

361

#

362

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

363

#

364

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

365

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

366

#

367

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

368

#

369

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

370

#

371

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

372

#

373

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

374

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

375

},

Yoshi Automation Bot

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

[diff] [blame]

376

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

yoshi-code-bot

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

[diff] [blame^]

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

{

391

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

392

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

393

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

394

{

395

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

396

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

397

},

398

],

399

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

400

},

401

],

402

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

403

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

407

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

408

<pre>Retrieves the list of HttpsHealthCheck resources available to the specified project.

409

410

Args:

411

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

Dan O'Meara

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

[diff] [blame]

412

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

413

Dan O'Meara

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

[diff] [blame]

414

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

415

Dan O'Meara

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

[diff] [blame]

416

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

417

Bu Sun Kim

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

[diff] [blame]

418

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

419

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

420

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

421

422

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.

423

424

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

425

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

426

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

427

428

Returns:

429

An object of the form:

430

431

{ # Contains a list of HttpsHealthCheck resources.

Yoshi Automation Bot

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

[diff] [blame]

432

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

433

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

434

{ # Represents a legacy HTTPS Health Check resource.

435

#

436

# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

437

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

438

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

439

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

440

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

441

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

442

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

443

"kind": "compute#httpsHealthCheck", # Type of the resource.

444

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

445

"port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.

446

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".

447

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

448

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

449

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.

450

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

451

},

452

],

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

{

461

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

462

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

463

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

464

],

Yoshi Automation Bot

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

[diff] [blame]

465

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

466

},

467

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

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

472

<pre>Retrieves the next page of results.

473

474

Args:

475

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

476

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

477

478

Returns:

Bu Sun Kim

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

[diff] [blame]

479

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

480

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]

485

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

Bu Sun Kim

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

[diff] [blame]

486

<pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

487

488

Args:

489

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

490

httpsHealthCheck: string, Name of the HttpsHealthCheck resource to patch. (required)

Dan O'Meara

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

[diff] [blame]

491

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

492

The object takes the form of:

493

Dan O'Meara

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

[diff] [blame]

494

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

495

#

496

# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

497

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

498

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

499

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

500

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

501

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

502

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

503

"kind": "compute#httpsHealthCheck", # Type of the resource.

504

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

505

"port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.

506

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".

507

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

508

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

509

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.

510

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

511

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

512

Bu Sun Kim

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

[diff] [blame]

513

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.

514

515

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.

516

517

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

518

519

Returns:

520

An object of the form:

521

Bu Sun Kim

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

[diff] [blame]

522

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

523

#

524

# Google Compute Engine has three Operation resources:

525

#

526

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

527

#

528

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

529

#

530

# Operations can be global, regional or zonal.

531

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

532

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

533

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

534

#

535

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

536

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

537

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

538

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

539

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

540

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

541

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

Bu Sun Kim

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

[diff] [blame]

542

{

Yoshi Automation Bot

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

[diff] [blame]

543

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

544

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

545

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

Bu Sun Kim

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

[diff] [blame]

546

},

547

],

Yoshi Automation Bot

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

[diff] [blame]

548

},

549

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

550

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

551

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

552

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

553

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

554

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

555

#

556

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

557

#

558

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

559

#

560

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

561

#

562

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

563

#

564

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

565

#

566

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

567

#

568

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

569

#

570

# Example 4: Pack and unpack a message in Go

571

#

572

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

573

#

574

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

579

#

580

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

581

#

582

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

583

#

584

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

585

#

586

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

587

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

588

#

589

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

590

#

591

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

592

#

593

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

594

#

595

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

596

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

597

},

Yoshi Automation Bot

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

[diff] [blame]

598

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

yoshi-code-bot

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

[diff] [blame^]

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

{

613

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

614

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

615

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

616

{

617

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

618

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

619

},

620

],

621

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

622

},

623

],

624

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

625

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

629

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

630

<pre>Returns permissions that a caller has on the specified resource.

631

632

Args:

633

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

Bu Sun Kim

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

[diff] [blame]

634

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

635

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

636

The object takes the form of:

637

638

{

Yoshi Automation Bot

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

[diff] [blame]

639

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

640

"A String",

641

],

642

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

647

648

{

Yoshi Automation Bot

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

[diff] [blame]

649

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

650

"A String",

651

],

652

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

656

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

657

<pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

658

659

Args:

660

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

661

httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)

Dan O'Meara

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

[diff] [blame]

662

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

663

The object takes the form of:

664

Dan O'Meara

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

[diff] [blame]

665

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

666

#

667

# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

668

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

669

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

670

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

671

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

672

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

673

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

674

"kind": "compute#httpsHealthCheck", # Type of the resource.

675

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

676

"port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.

677

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".

678

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

679

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

680

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.

681

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

682

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

683

Bu Sun Kim

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

[diff] [blame]

684

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.

685

686

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.

687

688

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

689

690

Returns:

691

An object of the form:

692

Bu Sun Kim

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

[diff] [blame]

693

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

694

#

695

# Google Compute Engine has three Operation resources:

696

#

697

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

698

#

699

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

700

#

701

# Operations can be global, regional or zonal.

702

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

703

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

704

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

705

#

706

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

707

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

708

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

709

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

710

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

711

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

712

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

Bu Sun Kim

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

[diff] [blame]

713

{

Yoshi Automation Bot

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

[diff] [blame]

714

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

715

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

716

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

Bu Sun Kim

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

[diff] [blame]

717

},

718

],

Yoshi Automation Bot

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

[diff] [blame]

719

},

720

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

721

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

722

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

723

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

724

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

725

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

726

#

727

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

728

#

729

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

730

#

731

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

732

#

733

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

734

#

735

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

736

#

737

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

738

#

739

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

740

#

741

# Example 4: Pack and unpack a message in Go

742

#

743

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

744

#

745

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

750

#

751

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

752

#

753

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

754

#

755

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

756

#

757

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

758

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

759

#

760

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

761

#

762

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

763

#

764

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

765

#

766

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

767

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

768

},

Yoshi Automation Bot

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

[diff] [blame]

769

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

yoshi-code-bot

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

[diff] [blame^]

770

"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