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

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.</p>

89

Dmitry Frenkel

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

[diff] [blame^]

90

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

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.</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="#setSslCertificates">setSslCertificates(project, region, targetHttpsProxy, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>

98

Dan O'Meara

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>

101

<h3>Method Details</h3>

102

Dmitry Frenkel

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

[diff] [blame^]

103

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

104

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

108

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

109

<pre>Deletes the specified TargetHttpsProxy resource.

110

111

Args:

112

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

113

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

114

targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)

115

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.

116

117

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.

118

119

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

120

121

Returns:

122

An object of the form:

123

124

{ # Represents an Operation resource.

125

#

Dan O'Meara

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

[diff] [blame]

126

# Google Compute Engine has three Operation resources:

127

#

128

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

129

#

Bu Sun Kim

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

[diff] [blame]

130

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

131

#

132

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

133

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

134

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

135

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

Bu Sun Kim

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

[diff] [blame]

136

#

Dan O'Meara

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

[diff] [blame]

137

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

138

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

139

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

140

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

141

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

142

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

143

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

Bu Sun Kim

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

[diff] [blame]

144

{

Bu Sun Kim

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

[diff] [blame]

145

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

146

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

147

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

Bu Sun Kim

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

[diff] [blame]

148

},

149

],

150

},

Bu Sun Kim

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

[diff] [blame]

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

{

169

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

170

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

171

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

172

{

173

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

174

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

175

},

176

],

177

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

178

},

179

],

180

"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, region, targetHttpsProxy)</code>

186

<pre>Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.

187

188

Args:

189

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

190

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

191

targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)

192

193

Returns:

194

An object of the form:

195

Dan O'Meara

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

[diff] [blame]

196

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

197

#

198

# Google Compute Engine has two Target HTTPS Proxy resources:

199

#

200

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)

201

#

202

# A target HTTPS proxy is a component of GCP HTTPS load balancers.

203

#

204

# * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.

205

#

206

# Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)

Bu Sun Kim

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

[diff] [blame]

207

"authentication": "A String", # [Deprecated] Use serverTlsPolicy instead.

208

"authorization": "A String", # [Deprecated] Use authorizationPolicy instead.

209

"authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.

210

# Refer to the AuthorizationPolicy resource for additional details.

211

# authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

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

[diff] [blame^]

212

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

213

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

214

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

215

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

216

"kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

217

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

218

"proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.

219

"quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE.

220

# - When quic-override is set to NONE, Google manages whether QUIC is used.

221

# - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.

222

# - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.

223

# - If the quic-override flag is not specified, NONE is implied.

224

# -

225

"region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

226

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

Bu Sun Kim

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

[diff] [blame]

227

"serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.

228

# serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

229

# If left blank, communications are not encrypted.

Dmitry Frenkel

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

[diff] [blame^]

230

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

231

"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

232

"A String",

233

],

234

"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

235

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:

236

# - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map

237

# - projects/project/global/urlMaps/url-map

238

# - global/urlMaps/url-map

239

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

243

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

Bu Sun Kim

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

[diff] [blame]

244

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

245

246

Args:

247

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

248

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

Dan O'Meara

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

[diff] [blame]

249

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

250

The object takes the form of:

251

Dan O'Meara

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

[diff] [blame]

252

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

253

#

254

# Google Compute Engine has two Target HTTPS Proxy resources:

255

#

256

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)

257

#

258

# A target HTTPS proxy is a component of GCP HTTPS load balancers.

259

#

260

# * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.

261

#

262

# Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)

Bu Sun Kim

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

[diff] [blame]

263

"authentication": "A String", # [Deprecated] Use serverTlsPolicy instead.

264

"authorization": "A String", # [Deprecated] Use authorizationPolicy instead.

265

"authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.

266

# Refer to the AuthorizationPolicy resource for additional details.

267

# authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

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

[diff] [blame^]

268

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

269

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

270

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

271

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

272

"kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

273

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

274

"proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.

275

"quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE.

276

# - When quic-override is set to NONE, Google manages whether QUIC is used.

277

# - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.

278

# - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.

279

# - If the quic-override flag is not specified, NONE is implied.

280

# -

281

"region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

282

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

Bu Sun Kim

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

[diff] [blame]

283

"serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.

284

# serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

285

# If left blank, communications are not encrypted.

Dmitry Frenkel

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

[diff] [blame^]

286

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

287

"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

288

"A String",

289

],

290

"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

291

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:

292

# - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map

293

# - projects/project/global/urlMaps/url-map

294

# - global/urlMaps/url-map

295

}

Bu Sun Kim

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

[diff] [blame]

296

297

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.

298

299

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.

300

301

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

302

303

Returns:

304

An object of the form:

305

306

{ # Represents an Operation resource.

307

#

Dan O'Meara

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

[diff] [blame]

308

# Google Compute Engine has three Operation resources:

309

#

310

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

311

#

Bu Sun Kim

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

[diff] [blame]

312

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

313

#

314

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

315

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

316

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

317

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

Bu Sun Kim

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

[diff] [blame]

318

#

Dan O'Meara

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

[diff] [blame]

319

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

320

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

321

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

322

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

323

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

324

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

325

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

Bu Sun Kim

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

[diff] [blame]

326

{

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

329

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

Bu Sun Kim

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

[diff] [blame]

330

},

331

],

332

},

Bu Sun Kim

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

[diff] [blame]

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

{

351

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

352

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

353

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

354

{

355

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

356

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

357

},

358

],

359

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

360

},

361

],

362

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

Dmitry Frenkel

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

[diff] [blame^]

367

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

Bu Sun Kim

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

[diff] [blame]

368

<pre>Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.

369

370

Args:

371

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

372

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

Dan O'Meara

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

[diff] [blame]

373

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]

374

Dan O'Meara

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

[diff] [blame]

375

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]

376

Dan O'Meara

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

[diff] [blame]

377

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]

378

Bu Sun Kim

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

[diff] [blame]

379

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

380

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

381

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

382

383

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.

384

385

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

386

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.

Dmitry Frenkel

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

[diff] [blame^]

387

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

388

389

Returns:

390

An object of the form:

391

392

{ # Contains a list of TargetHttpsProxy resources.

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

Dan O'Meara

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

[diff] [blame]

395

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

396

#

397

# Google Compute Engine has two Target HTTPS Proxy resources:

398

#

399

# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)

400

#

401

# A target HTTPS proxy is a component of GCP HTTPS load balancers.

402

#

403

# * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.

404

#

405

# Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)

Bu Sun Kim

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

[diff] [blame]

406

"authentication": "A String", # [Deprecated] Use serverTlsPolicy instead.

407

"authorization": "A String", # [Deprecated] Use authorizationPolicy instead.

408

"authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.

409

# Refer to the AuthorizationPolicy resource for additional details.

410

# authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

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

[diff] [blame^]

411

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

412

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

413

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

414

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

415

"kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

416

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

417

"proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.

418

"quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE.

419

# - When quic-override is set to NONE, Google manages whether QUIC is used.

420

# - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.

421

# - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.

422

# - If the quic-override flag is not specified, NONE is implied.

423

# -

424

"region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

425

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

Bu Sun Kim

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

[diff] [blame]

426

"serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.

427

# serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

428

# If left blank, communications are not encrypted.

Dmitry Frenkel

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

[diff] [blame^]

429

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

430

"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

431

"A String",

432

],

433

"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

434

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:

435

# - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map

436

# - projects/project/global/urlMaps/url-map

437

# - global/urlMaps/url-map

438

},

Bu Sun Kim

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

[diff] [blame]

439

],

Bu Sun Kim

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

[diff] [blame]

440

"kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.

441

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

442

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

443

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

444

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

445

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

446

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

Bu Sun Kim

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

[diff] [blame]

447

{

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

450

},

451

],

Bu Sun Kim

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

[diff] [blame]

452

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

453

},

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>

459

<pre>Retrieves the next page of results.

460

461

Args:

462

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

463

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

464

465

Returns:

Bu Sun Kim

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

[diff] [blame]

466

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]

467

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]

472

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

Bu Sun Kim

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

[diff] [blame]

473

<pre>Replaces SslCertificates for TargetHttpsProxy.

474

475

Args:

476

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

477

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

478

targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)

Dan O'Meara

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

[diff] [blame]

479

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

480

The object takes the form of:

481

482

{

Bu Sun Kim

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

[diff] [blame]

483

"sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.

484

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}

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.

489

490

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.

491

492

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

493

494

Returns:

495

An object of the form:

496

497

{ # Represents an Operation resource.

498

#

Dan O'Meara

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

[diff] [blame]

499

# Google Compute Engine has three Operation resources:

500

#

501

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

502

#

Bu Sun Kim

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

[diff] [blame]

503

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

504

#

505

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

506

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

507

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

508

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

Bu Sun Kim

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

[diff] [blame]

509

#

Dan O'Meara

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

[diff] [blame]

510

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

511

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

512

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

513

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

514

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

515

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

516

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

Bu Sun Kim

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

[diff] [blame]

517

{

Bu Sun Kim

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

[diff] [blame]

518

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

519

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

520

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

Bu Sun Kim

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

[diff] [blame]

521

},

522

],

523

},

Bu Sun Kim

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

[diff] [blame]

524

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

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

{

542

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

543

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

544

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

545

{

546

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

547

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

548

},

549

],

550

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

551

},

552

],

553

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

Dan O'Meara

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

[diff] [blame]

558

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

Bu Sun Kim

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

[diff] [blame]

559

<pre>Changes the URL map for TargetHttpsProxy.

560

561

Args:

562

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

563

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

564

targetHttpsProxy: string, Name of the TargetHttpsProxy to set a URL map for. (required)

Dan O'Meara

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

[diff] [blame]

565

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

566

The object takes the form of:

567

568

{

Bu Sun Kim

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

[diff] [blame]

569

"urlMap": "A String",

Bu Sun Kim

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

[diff] [blame]

570

}

571

572

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.

573

574

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.

575

576

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

577

578

Returns:

579

An object of the form:

580

581

{ # Represents an Operation resource.

582

#

Dan O'Meara

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

[diff] [blame]

583

# Google Compute Engine has three Operation resources:

584

#

585

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

586

#

Bu Sun Kim

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

[diff] [blame]

587

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

588

#

589

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

590

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

591

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

592

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

Bu Sun Kim

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

[diff] [blame]

593

#

Dan O'Meara

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

[diff] [blame]

594

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

595

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

596

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

597

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

598

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

599

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

600

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

Bu Sun Kim

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

[diff] [blame]

601

{

Bu Sun Kim

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

[diff] [blame]

602

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

603

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

604

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

Bu Sun Kim

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

[diff] [blame]

605

},

606

],

607

},

Bu Sun Kim