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

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.</p>

89

Dmitry Frenkel

3e17f89

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Lists all the SSL policies that have been configured for the specified project.</p>

92

Dmitry Frenkel

3e17f89

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Lists all features that can be specified in the SSL policy when using custom profile.</p>

95

96

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

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Patches the specified SSL policy with the data included in the request.</p>

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

<h3>Method Details</h3>

105

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>

Bu Sun Kim

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

[diff] [blame]

111

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

112

<pre>Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

113

114

Args:

115

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

116

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

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

122

123

Returns:

124

An object of the form:

125

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.

158

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

yoshi-code-bot

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

[diff] [blame^]

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

{

172

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

173

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

174

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

175

{

176

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

177

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

178

},

179

],

180

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

181

},

182

],

183

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

184

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

189

<pre>Lists all of the ordered rules present in a single specified policy.

190

191

Args:

192

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

193

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

194

195

Returns:

196

An object of the form:

197

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

198

{ # Represents an SSL Policy resource.

Yoshi Automation Bot

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

[diff] [blame]

199

#

200

# Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

201

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

202

"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The

203

# - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

204

"A String",

205

],

206

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

207

"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.

208

"A String",

209

],

210

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.

Bu Sun Kim

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

[diff] [blame]

211

#

Yoshi Automation Bot

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

[diff] [blame]

212

# To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

213

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

214

"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

215

"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.

216

"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

217

"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

218

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

219

"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

220

{

221

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

222

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

223

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

224

{

225

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

226

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

227

},

228

],

229

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

230

},

231

],

232

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

236

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

Bu Sun Kim

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

[diff] [blame]

237

<pre>Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.

238

239

Args:

240

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

Dan O'Meara

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

[diff] [blame]

241

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

242

The object takes the form of:

243

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

244

{ # Represents an SSL Policy resource.

Bu Sun Kim

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

[diff] [blame]

245

#

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

246

# Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

Bu Sun Kim

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

[diff] [blame]

247

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

248

"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The

249

# - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

250

"A String",

251

],

252

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

253

"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.

254

"A String",

255

],

256

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.

Dan O'Meara

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

[diff] [blame]

257

#

Bu Sun Kim

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

[diff] [blame]

258

# To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

259

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

260

"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

261

"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.

262

"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

263

"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

264

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

265

"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

266

{

267

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

268

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

269

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

270

{

271

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

272

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

273

},

274

],

275

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

276

},

277

],

278

}

Bu Sun Kim

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

[diff] [blame]

279

280

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.

281

282

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.

283

284

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

285

286

Returns:

287

An object of the form:

288

289

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

290

#

291

# Google Compute Engine has three Operation resources:

292

#

293

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

294

#

295

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

296

#

297

# Operations can be global, regional or zonal.

298

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

299

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

300

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

301

#

302

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

303

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

304

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

305

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

306

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

307

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

308

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

Bu Sun Kim

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

[diff] [blame]

309

{

Yoshi Automation Bot

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

[diff] [blame]

310

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

311

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

312

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

Bu Sun Kim

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

[diff] [blame]

313

},

314

],

Yoshi Automation Bot

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

[diff] [blame]

315

},

316

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

317

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

318

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

319

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

320

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

321

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

yoshi-code-bot

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

[diff] [blame^]

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

{

335

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

336

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

337

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

338

{

339

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

340

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

341

},

342

],

343

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

344

},

345

],

346

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

347

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

351

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

Bu Sun Kim

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

[diff] [blame]

352

<pre>Lists all the SSL policies that have been configured for the specified project.

353

354

Args:

355

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

Dan O'Meara

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

[diff] [blame]

356

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

Bu Sun Kim

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

[diff] [blame]

357

Dan O'Meara

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

[diff] [blame]

358

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

Bu Sun Kim

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

[diff] [blame]

359

Dan O'Meara

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

[diff] [blame]

360

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

Bu Sun Kim

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

[diff] [blame]

361

Bu Sun Kim

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

[diff] [blame]

362

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

363

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

364

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

365

366

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.

367

368

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

369

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

370

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

Bu Sun Kim

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

[diff] [blame]

371

372

Returns:

373

An object of the form:

374

375

{

Yoshi Automation Bot

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

[diff] [blame]

376

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

377

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

378

{ # Represents an SSL Policy resource.

379

#

380

# Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

381

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

382

"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The

383

# - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

384

"A String",

385

],

386

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

387

"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.

388

"A String",

389

],

390

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.

Bu Sun Kim

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

[diff] [blame]

391

#

Yoshi Automation Bot

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

[diff] [blame]

392

# To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

393

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

394

"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

395

"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.

396

"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

397

"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

398

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

399

"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

Bu Sun Kim

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

[diff] [blame]

400

{

Yoshi Automation Bot

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

[diff] [blame]

401

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

402

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

403

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

404

{

405

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

406

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

407

},

408

],

409

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

410

},

411

],

412

},

Yoshi Automation Bot

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

[diff] [blame]

413

],

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

{

422

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

423

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

424

},

425

],

426

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

427

},

428

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

432

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

Bu Sun Kim

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

[diff] [blame]

433

<pre>Lists all features that can be specified in the SSL policy when using custom profile.

434

435

Args:

436

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

Dan O'Meara

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

[diff] [blame]

437

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

Bu Sun Kim

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

[diff] [blame]

438

Dan O'Meara

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

[diff] [blame]

439

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

Bu Sun Kim

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

[diff] [blame]

440

Dan O'Meara

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

[diff] [blame]

441

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

Bu Sun Kim

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

[diff] [blame]

442

Bu Sun Kim

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

[diff] [blame]

443

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

444

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

445

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

446

447

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.

448

449

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

450

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

451

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

Bu Sun Kim

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

[diff] [blame]

452

453

Returns:

454

An object of the form:

455

456

{

Yoshi Automation Bot

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

[diff] [blame]

"features": [

"A String",

],

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

465

<pre>Retrieves the next page of results.

466

467

Args:

468

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

469

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

470

471

Returns:

Bu Sun Kim

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

[diff] [blame]

472

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

Bu Sun Kim

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

[diff] [blame]

473

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]

478

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

Bu Sun Kim

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

[diff] [blame]

479

<pre>Patches the specified SSL policy with the data included in the request.

480

481

Args:

482

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

483

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

Dan O'Meara

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

[diff] [blame]

484

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

485

The object takes the form of:

486

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

487

{ # Represents an SSL Policy resource.

Bu Sun Kim

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

[diff] [blame]

488

#

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

489

# Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

Bu Sun Kim

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

[diff] [blame]

490

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

491

"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The

492

# - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

493

"A String",

494

],

495

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

496

"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.

497

"A String",

498

],

499

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.

Dan O'Meara

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

[diff] [blame]

500

#

Bu Sun Kim

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

[diff] [blame]

501

# To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

502

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

503

"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

504

"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.

505

"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

506

"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

507

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

508

"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

509

{

510

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

511

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

512

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

513

{

514

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

515

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

516

},

517

],

518

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

519

},

520

],

521

}

Bu Sun Kim

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

[diff] [blame]

522

523

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.

524

525

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.

526

527

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

528

529

Returns:

530

An object of the form:

531

532

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

533

#

534

# Google Compute Engine has three Operation resources:

535

#

536

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

537

#

538

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

539

#

540

# Operations can be global, regional or zonal.

541

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

542

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

543

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

544

#

545

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

546

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

547

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

548

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

549

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

550

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

551

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

Bu Sun Kim

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

[diff] [blame]

552

{

Yoshi Automation Bot

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

[diff] [blame]

553

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

554

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

555

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

Bu Sun Kim

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

[diff] [blame]

556

},

557

],

Yoshi Automation Bot

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

[diff] [blame]

558

},

559

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

560

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

561

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

562

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

563

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

564

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

yoshi-code-bot

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

[diff] [blame^]

565

"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