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

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

[diff] [blame]

84

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

85

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

86

Bu Sun Kim

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

89

Bu Sun Kim

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

93

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

94

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

95

Dan O'Meara

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

[diff] [blame]

96

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

97

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

98

<h3>Method Details</h3>

99

100

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

101

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

102

103

Args:

104

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

105

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

106

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.

107

108

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.

109

110

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

111

112

Returns:

113

An object of the form:

114

115

{ # Represents an Operation resource.

116

#

Dan O'Meara

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

[diff] [blame]

117

# Google Compute Engine has three Operation resources:

118

#

119

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

120

#

Bu Sun Kim

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

[diff] [blame]

121

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

122

#

123

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

124

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

125

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

126

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

Bu Sun Kim

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

[diff] [blame]

127

#

Dan O'Meara

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

[diff] [blame]

128

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

129

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

130

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

131

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

132

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

133

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

134

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

Bu Sun Kim

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

[diff] [blame]

135

{

Bu Sun Kim

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

[diff] [blame]

136

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

137

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

138

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

Bu Sun Kim

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

[diff] [blame]

139

},

140

],

141

},

Bu Sun Kim

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

[diff] [blame]

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

{

160

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

161

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

162

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

163

{

164

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

165

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

166

},

167

],

168

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

169

},

170

],

171

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

177

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

178

179

Args:

180

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

181

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

182

183

Returns:

184

An object of the form:

185

Dan O'Meara

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

[diff] [blame]

186

{ # Represents a Cloud Armor Security Policy resource.

Bu Sun Kim

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

[diff] [blame]

187

#

188

# Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

189

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

190

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

191

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

192

"A String",

193

],

194

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

195

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

196

"A String",

197

],

198

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

199

#

Bu Sun Kim

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

[diff] [blame]

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

{

209

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

210

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

211

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

212

{

213

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

214

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

215

},

216

],

217

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

218

},

219

],

220

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

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

226

227

Args:

228

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

Dan O'Meara

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

[diff] [blame]

229

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

230

The object takes the form of:

231

Dan O'Meara

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

[diff] [blame]

232

{ # Represents a Cloud Armor Security Policy resource.

Bu Sun Kim

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

[diff] [blame]

233

#

234

# Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

235

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

236

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

237

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

238

"A String",

239

],

240

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

241

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

242

"A String",

243

],

244

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

245

#

Bu Sun Kim

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

[diff] [blame]

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

{

255

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

256

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

257

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

258

{

259

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

260

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

261

},

262

],

263

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

264

},

265

],

266

}

Bu Sun Kim

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

[diff] [blame]

267

268

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.

269

270

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.

271

272

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

273

274

Returns:

275

An object of the form:

276

277

{ # Represents an Operation resource.

278

#

Dan O'Meara

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

[diff] [blame]

279

# Google Compute Engine has three Operation resources:

280

#

281

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

282

#

Bu Sun Kim

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

[diff] [blame]

283

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

284

#

285

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

286

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

287

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

288

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

Bu Sun Kim

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

[diff] [blame]

289

#

Dan O'Meara

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

[diff] [blame]

290

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

291

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

292

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

293

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

294

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

295

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

296

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

Bu Sun Kim

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

[diff] [blame]

297

{

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

300

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

Bu Sun Kim

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

[diff] [blame]

301

},

302

],

303

},

Bu Sun Kim

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

[diff] [blame]

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

{

322

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

323

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

324

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

325

{

326

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

327

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

328

},

329

],

330

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

331

},

332

],

333

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

338

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

Bu Sun Kim

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

[diff] [blame]

339

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

340

341

Args:

342

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

Dan O'Meara

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

[diff] [blame]

343

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]

344

Dan O'Meara

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

[diff] [blame]

345

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]

346

Dan O'Meara

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

[diff] [blame]

347

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]

348

Bu Sun Kim

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

[diff] [blame]

349

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

350

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

351

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

352

353

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.

354

355

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

356

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.

Bu Sun Kim

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

[diff] [blame]

357

358

Returns:

359

An object of the form:

360

361

{

Bu Sun Kim

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

[diff] [blame]

362

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

363

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

Dan O'Meara

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

[diff] [blame]

364

{ # Represents a Cloud Armor Security Policy resource.

Bu Sun Kim

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

[diff] [blame]

365

#

366

# Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

367

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

368

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

369

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

370

"A String",

371

],

372

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

373

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

374

"A String",

375

],

376

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

377

#

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

{

387

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

388

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

389

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

390

{

391

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

392

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

393

},

394

],

395

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

396

},

397

],

398

},

Bu Sun Kim

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

[diff] [blame]

399

],

Bu Sun Kim

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

[diff] [blame]

400

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

401

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

402

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

403

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

404

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

405

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

406

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

Bu Sun Kim

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

[diff] [blame]

407

{

Bu Sun Kim

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

[diff] [blame]

408

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

409

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

410

},

411

],

Bu Sun Kim

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

[diff] [blame]

412

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

413

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

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

420

421

Args:

422

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

Dan O'Meara

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

[diff] [blame]

423

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]

424

Dan O'Meara

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

[diff] [blame]

425

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]

426

Dan O'Meara

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

[diff] [blame]

427

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]

428

Bu Sun Kim

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

[diff] [blame]

429

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

430

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

431

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

432

433

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.

434

435

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

436

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.

Bu Sun Kim

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

[diff] [blame]

437

438

Returns:

439

An object of the form:

440

441

{

Bu Sun Kim

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

[diff] [blame]

442

"features": [

443

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}</pre>

</div>

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

450

<pre>Retrieves the next page of results.

451

452

Args:

453

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

454

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

455

456

Returns:

Bu Sun Kim

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

[diff] [blame]

457

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]

458

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]

463

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

464

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

465

466

Args:

467

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

468

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]

469

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

470

The object takes the form of:

471

Dan O'Meara

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

[diff] [blame]

472

{ # Represents a Cloud Armor Security Policy resource.

Bu Sun Kim

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

[diff] [blame]

473

#

474

# Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)

475

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

476

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

477

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

478

"A String",

479

],

480

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

481

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

482

"A String",

483

],

484

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

485

#

Bu Sun Kim

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

[diff] [blame]

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

{

495

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

496

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

497

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

498

{

499

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

500

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

501

},

502

],

503

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

504

},

505

],

506

}

Bu Sun Kim

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

[diff] [blame]

507

508

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.

509

510

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.

511

512

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

513

514

Returns:

515

An object of the form:

516

517

{ # Represents an Operation resource.

518

#

Dan O'Meara

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

[diff] [blame]

519

# Google Compute Engine has three Operation resources:

520

#

521

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

522

#

Bu Sun Kim

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

[diff] [blame]

523

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

524

#

525

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

526

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

527

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

528

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

Bu Sun Kim

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

[diff] [blame]

529

#

Dan O'Meara

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

[diff] [blame]

530

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

531

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

532

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

533

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

534

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

535

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

536

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

Bu Sun Kim

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

[diff] [blame]

537

{

Bu Sun Kim

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

[diff] [blame]

538

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

539

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

540

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

Bu Sun Kim

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

[diff] [blame]

541

},

542

],

543

},

Bu Sun Kim