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

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

[diff] [blame]

95

Dan O'Meara

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

100

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

101

<h3>Method Details</h3>

102

Bu Sun Kim

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

[diff] [blame]

103

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

Sai Cheemalapati

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

[diff] [blame]

104

<pre>Deletes the specified HttpsHealthCheck resource.

105

106

Args:

107

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

108

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

Bu Sun Kim

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

[diff] [blame]

109

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.

110

111

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.

112

113

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]

114

115

Returns:

116

An object of the form:

117

Bu Sun Kim

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

[diff] [blame]

118

{ # Represents an Operation resource.

119

#

Dan O'Meara

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

[diff] [blame]

120

# Google Compute Engine has three Operation resources:

121

#

122

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

123

#

Bu Sun Kim

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

[diff] [blame]

124

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

125

#

126

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

127

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

128

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

129

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

Bu Sun Kim

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

[diff] [blame]

130

#

Dan O'Meara

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

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

135

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

136

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

137

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

Sai Cheemalapati

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

[diff] [blame]

138

{

Bu Sun Kim

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

[diff] [blame]

139

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

140

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

141

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

Sai Cheemalapati

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

[diff] [blame]

142

},

143

],

144

},

Bu Sun Kim

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

[diff] [blame]

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

{

163

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

164

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

165

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

166

{

167

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

168

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

169

},

170

],

171

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

172

},

173

],

174

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

180

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

181

182

Args:

183

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

184

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

185

186

Returns:

187

An object of the form:

188

Dan O'Meara

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

[diff] [blame]

189

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

190

#

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

209

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

Sai Cheemalapati

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

[diff] [blame]

210

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

211

212

Args:

213

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

Dan O'Meara

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

[diff] [blame]

214

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

215

The object takes the form of:

216

Dan O'Meara

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

[diff] [blame]

217

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

218

#

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

233

}

Sai Cheemalapati

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

[diff] [blame]

234

Bu Sun Kim

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

[diff] [blame]

235

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.

236

237

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.

238

239

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]

240

241

Returns:

242

An object of the form:

243

Bu Sun Kim

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

[diff] [blame]

244

{ # Represents an Operation resource.

245

#

Dan O'Meara

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

[diff] [blame]

246

# Google Compute Engine has three Operation resources:

247

#

248

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

249

#

Bu Sun Kim

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

[diff] [blame]

250

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

251

#

252

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

#

Dan O'Meara

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

[diff] [blame]

257

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

Bu Sun Kim

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

[diff] [blame]

258

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

259

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

260

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

261

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

262

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

263

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

Sai Cheemalapati

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

[diff] [blame]

264

{

Bu Sun Kim

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

[diff] [blame]

265

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

266

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

267

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

Sai Cheemalapati

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

[diff] [blame]

268

},

269

],

270

},

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

{

289

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

290

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

291

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

292

{

293

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

294

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

295

},

296

],

297

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

298

},

299

],

300

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

305

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

Sai Cheemalapati

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

[diff] [blame]

306

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

307

308

Args:

309

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

Dan O'Meara

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

[diff] [blame]

310

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]

311

Dan O'Meara

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

[diff] [blame]

312

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]

313

Dan O'Meara

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

[diff] [blame]

314

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]

315

Bu Sun Kim

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

[diff] [blame]

316

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

317

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

318

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

319

320

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.

321

322

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

323

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.

Sai Cheemalapati

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

[diff] [blame]

324

325

Returns:

326

An object of the form:

327

328

{ # Contains a list of HttpsHealthCheck resources.

Bu Sun Kim

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

[diff] [blame]

329

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

330

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

Dan O'Meara

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

[diff] [blame]

331

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

332

#

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

},

Sai Cheemalapati

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

[diff] [blame]

348

],

Bu Sun Kim

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

[diff] [blame]

349

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

350

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

351

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

352

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

353

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

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

{

Bu Sun Kim

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

[diff] [blame]

357

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

358

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

Bu Sun Kim

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

[diff] [blame]

359

},

360

],

Bu Sun Kim

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

[diff] [blame]

361

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

Bu Sun Kim

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

[diff] [blame]

362

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

368

<pre>Retrieves the next page of results.

369

370

Args:

371

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

372

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

373

374

Returns:

Bu Sun Kim

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

[diff] [blame]

375

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

Sai Cheemalapati

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

[diff] [blame]

376

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]

381

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

382

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

383

384

Args:

385

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

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

386

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

Dan O'Meara

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

[diff] [blame]

387

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

388

The object takes the form of:

389

Dan O'Meara

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

[diff] [blame]

390

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

391

#

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

}

Sai Cheemalapati

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

[diff] [blame]

407

Bu Sun Kim

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

[diff] [blame]

408

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

409

410

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.

411

412

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]

413

414

Returns:

415

An object of the form:

416

Bu Sun Kim

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

[diff] [blame]

417

{ # Represents an Operation resource.

418

#

Dan O'Meara

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

[diff] [blame]

419

# Google Compute Engine has three Operation resources:

420

#

421

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

422

#

Bu Sun Kim

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

[diff] [blame]

423

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

424

#

425

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

426

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

427

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

428

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

Bu Sun Kim

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

[diff] [blame]

429

#

Dan O'Meara

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

[diff] [blame]

430

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

Bu Sun Kim

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

[diff] [blame]

431

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

432

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

433

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

434

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

435

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

436

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

Sai Cheemalapati

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

[diff] [blame]

437

{

Bu Sun Kim

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

[diff] [blame]

438

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

439

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

440

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

Sai Cheemalapati

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

[diff] [blame]

441

},

442

],

443

},

Bu Sun Kim

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

[diff] [blame]

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

{

462

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

463

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

464

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

465

{

466

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

467

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

468

},

469

],

470

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

471

},

472

],

473

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

478

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

Sai Cheemalapati

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

[diff] [blame]

479

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

480

481

Args:

482

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

Bu Sun Kim

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

[diff] [blame]

483

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

Dan O'Meara

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

[diff] [blame]

484

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

485

The object takes the form of:

486

487

{

Bu Sun Kim

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

[diff] [blame]

488

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

489

"A String",

Sai Cheemalapati

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

[diff] [blame]

],

}

Returns:

An object of the form:

496

497

{

Bu Sun Kim

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

[diff] [blame]

498

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

499

"A String",

Sai Cheemalapati

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

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

505

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

Sai Cheemalapati

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

[diff] [blame]

506

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

507

508

Args:

509

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

510

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

Dan O'Meara

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

[diff] [blame]

511

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

512

The object takes the form of:

513

Dan O'Meara

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

[diff] [blame]

514

{ # Represents a legacy HTTPS Health Check resource.

Bu Sun Kim

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

[diff] [blame]

515

#

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

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

529

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

530

}

Sai Cheemalapati

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

[diff] [blame]

531

Bu Sun Kim

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

[diff] [blame]

532

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.

533

534

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.

535

536

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]

537

538

Returns:

539

An object of the form:

540

Bu Sun Kim

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

[diff] [blame]

541

{ # Represents an Operation resource.

542

#

Dan O'Meara

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

[diff] [blame]

543

# Google Compute Engine has three Operation resources:

544

#

545

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

546

#

Bu Sun Kim

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

[diff] [blame]

547

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

548

#

549

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

550

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

551

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

552

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

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 more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

555

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

556

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

557

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

558

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

559

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

560

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

Sai Cheemalapati

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

[diff] [blame]

561

{

Bu Sun Kim

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

[diff] [blame]

562

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

563

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

564

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

Sai Cheemalapati

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

[diff] [blame]

565

},

566

],

567

},

Bu Sun Kim