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

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

[diff] [blame]

79

<p class="firstline">Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.</p>

80

81

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

82

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

83

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

87

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

Sai Cheemalapati

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

[diff] [blame]

88

<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

89

Sai Cheemalapati

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

[diff] [blame]

90

<code><a href="#get">get(project, targetHttpsProxy)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

95

Bu Sun Kim

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

<p class="firstline">Retrieves the list of TargetHttpsProxy resources available to the specified project.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

98

99

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

100

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

101

Bu Sun Kim

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

[diff] [blame]

102

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

103

<p class="firstline">Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)</p>

104

Bu Sun Kim

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

[diff] [blame]

105

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

106

<p class="firstline">Changes the Certificate Map for TargetHttpsProxy.</p>

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Sets the QUIC override policy for TargetHttpsProxy.</p>

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

113

Dan O'Meara

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

<p class="firstline">Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.</p>

116

Dan O'Meara

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

[diff] [blame]

117

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

Sai Cheemalapati

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

[diff] [blame]

118

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

119

Dan O'Meara

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

[diff] [blame]

120

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

Sai Cheemalapati

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

[diff] [blame]

121

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

122

<h3>Method Details</h3>

123

Bu Sun Kim

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame]

125

<pre>Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

126

127

Args:

128

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

Dan O'Meara

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

[diff] [blame]

129

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]

130

Dan O'Meara

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

[diff] [blame]

131

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]

132

Dan O'Meara

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

[diff] [blame]

133

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]

134

Bu Sun Kim

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

[diff] [blame]

135

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

Dan O'Meara

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

[diff] [blame]

136

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

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

[diff] [blame]

137

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

138

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

139

140

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.

141

142

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

143

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

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

[diff] [blame]

144

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

Bu Sun Kim

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

[diff] [blame]

145

146

Returns:

147

An object of the form:

148

149

{

Yoshi Automation Bot

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

[diff] [blame]

150

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

151

"items": { # A list of TargetHttpsProxiesScopedList resources.

152

"a_key": { # Name of the scope containing this set of TargetHttpsProxies.

153

"targetHttpsProxies": [ # A list of TargetHttpsProxies contained in this scope.

154

{ # Represents a Target HTTPS Proxy resource.

155

#

156

# Google Compute Engine has two Target HTTPS Proxy resources:

157

#

158

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

159

#

160

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

161

#

162

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

163

#

164

# 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 ==)

165

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

166

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

167

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

168

# Refer to the AuthorizationPolicy resource for additional details.

169

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

170

# Note: This field currently has no impact.

171

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

172

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

173

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

174

"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

175

"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.

176

# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

177

"A String",

Bu Sun Kim

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

[diff] [blame]

178

],

Yoshi Automation Bot

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

[diff] [blame]

179

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

180

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

181

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

182

"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

183

#

184

# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.

185

#

186

# The default is false.

187

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

188

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

189

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

190

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

191

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

Yoshi Automation Bot

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

[diff] [blame]

192

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

193

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

194

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

195

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

196

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

197

# If left blank, communications are not encrypted.

198

# Note: This field currently has no impact.

199

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

200

"A String",

201

],

202

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

203

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

204

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

205

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

206

# - global/urlMaps/url-map

Bu Sun Kim

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

[diff] [blame]

207

},

208

],

Yoshi Automation Bot

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

[diff] [blame]

209

"warning": { # Informational warning which replaces the list of backend services when the list is empty.

210

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

211

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

212

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

213

{

214

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

215

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

216

},

217

],

218

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

219

},

Bu Sun Kim

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

[diff] [blame]

220

},

Yoshi Automation Bot

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

[diff] [blame]

221

},

222

"kind": "compute#targetHttpsProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.

223

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

224

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

225

"unreachables": [ # [Output Only] Unreachable resources.

226

"A String",

227

],

228

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

229

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

230

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

231

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

232

{

233

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

234

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

235

},

236

],

237

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

238

},

239

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

244

<pre>Retrieves the next page of results.

245

246

Args:

247

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

248

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

249

250

Returns:

Bu Sun Kim

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

[diff] [blame]

251

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]

252

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

257

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

258

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

262

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

Sai Cheemalapati

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

[diff] [blame]

263

<pre>Deletes the specified TargetHttpsProxy resource.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

264

265

Args:

Sai Cheemalapati

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

[diff] [blame]

266

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

267

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

Bu Sun Kim

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

[diff] [blame]

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

273

274

Returns:

275

An object of the form:

276

Bu Sun Kim

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

[diff] [blame]

277

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

278

#

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

#

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.

286

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

287

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

288

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

289

#

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

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

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

[diff] [blame]

297

{

Yoshi Automation Bot

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

[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

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

[diff] [blame]

301

},

302

],

Yoshi Automation Bot

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

[diff] [blame]

303

},

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.

yoshi-code-bot

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

[diff] [blame]

310

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

{

324

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

325

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

326

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

327

{

328

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

329

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

330

},

331

],

332

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

333

},

334

],

335

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

336

}</pre>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

340

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

Bu Sun Kim

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

[diff] [blame]

341

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

342

343

Args:

Sai Cheemalapati

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

[diff] [blame]

344

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

345

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

346

347

Returns:

348

An object of the form:

349

Dan O'Meara

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

[diff] [blame]

350

{ # Represents a Target HTTPS Proxy resource.

Yoshi Automation Bot

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

[diff] [blame]

351

#

352

# Google Compute Engine has two Target HTTPS Proxy resources:

353

#

354

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

355

#

356

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

357

#

358

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

359

#

360

# 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 ==)

361

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

362

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

363

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

364

# Refer to the AuthorizationPolicy resource for additional details.

365

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

366

# Note: This field currently has no impact.

367

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

368

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

369

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

370

"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

371

"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.

372

# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

373

"A String",

374

],

375

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

376

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

377

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

378

"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

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

[diff] [blame]

379

#

Yoshi Automation Bot

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

[diff] [blame]

380

# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.

Bu Sun Kim

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

[diff] [blame]

381

#

Yoshi Automation Bot

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

[diff] [blame]

382

# The default is false.

383

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

384

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

385

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

386

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

387

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

Yoshi Automation Bot

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

[diff] [blame]

388

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

389

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

390

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

391

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

392

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

393

# If left blank, communications are not encrypted.

394

# Note: This field currently has no impact.

395

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

396

"A String",

397

],

398

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

399

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

400

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

401

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

402

# - global/urlMaps/url-map

403

}</pre>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

407

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

Sai Cheemalapati

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

[diff] [blame]

408

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

409

410

Args:

Sai Cheemalapati

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

[diff] [blame]

411

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

Dan O'Meara

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

[diff] [blame]

412

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

413

The object takes the form of:

414

Dan O'Meara

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

[diff] [blame]

415

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

416

#

417

# Google Compute Engine has two Target HTTPS Proxy resources:

418

#

419

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

420

#

421

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

422

#

423

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

424

#

425

# 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

d059ad8

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

[diff] [blame]

426

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

427

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

428

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

429

# Refer to the AuthorizationPolicy resource for additional details.

430

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

431

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

432

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

433

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

434

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

Bu Sun Kim

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

[diff] [blame]

435

"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

436

"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.

437

# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

438

"A String",

439

],

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

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

Bu Sun Kim

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

[diff] [blame]

443

"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

444

#

445

# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.

446

#

447

# The default is false.

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

450

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

451

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

452

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

Bu Sun Kim

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

[diff] [blame]

453

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

454

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

455

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

456

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

457

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

458

# If left blank, communications are not encrypted.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

459

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

460

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

461

"A String",

462

],

463

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

464

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

465

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

466

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

467

# - global/urlMaps/url-map

468

}

469

470

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.

471

472

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.

473

474

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

475

476

Returns:

477

An object of the form:

478

479

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

480

#

481

# Google Compute Engine has three Operation resources:

482

#

483

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

484

#

485

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

486

#

487

# Operations can be global, regional or zonal.

488

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

489

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

490

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

491

#

492

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

493

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

494

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

495

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

496

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

497

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

498

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

Bu Sun Kim

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

[diff] [blame]

499

{

Yoshi Automation Bot

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

[diff] [blame]

500

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

501

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

502

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

Bu Sun Kim

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

[diff] [blame]

503

},

Sai Cheemalapati

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

[diff] [blame]

504

],

Yoshi Automation Bot

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

[diff] [blame]

505

},

506

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

507

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

508

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

509

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

510

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

511

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

yoshi-code-bot

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

[diff] [blame]

512

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

{

526

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

527

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

528

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

529

{

530

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

531

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

532

},

533

],

534

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

535

},

536

],

537

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

538

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

543

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

544

545

Args:

546

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

547

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

548

549

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

550

551

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.

552

553

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

554

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

555

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

556

557

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.

558

559

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

560

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

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

[diff] [blame]

561

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

Bu Sun Kim

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

[diff] [blame]

562

563

Returns:

564

An object of the form:

565

566

{ # Contains a list of TargetHttpsProxy resources.

Yoshi Automation Bot

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

[diff] [blame]

567

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

568

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

569

{ # Represents a Target HTTPS Proxy resource.

570

#

571

# Google Compute Engine has two Target HTTPS Proxy resources:

572

#

573

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

574

#

575

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

576

#

577

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

578

#

579

# 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 ==)

580

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

581

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

582

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

583

# Refer to the AuthorizationPolicy resource for additional details.

584

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

585

# Note: This field currently has no impact.

586

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

587

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

588

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

589

"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

590

"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.

591

# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

592

"A String",

593

],

594

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

595

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

596

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

597

"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

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

[diff] [blame]

598

#

Yoshi Automation Bot

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

[diff] [blame]

599

# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.

Bu Sun Kim

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

[diff] [blame]

600

#

Yoshi Automation Bot

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

[diff] [blame]

601

# The default is false.

602

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

603

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

604

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

605

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

606

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

Yoshi Automation Bot

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

[diff] [blame]

607

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

608

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

609

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

610

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

611

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

612

# If left blank, communications are not encrypted.

613

# Note: This field currently has no impact.

614

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

615

"A String",

616

],

617

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

618

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

619

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

620

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

621

# - global/urlMaps/url-map

622

},

623

],

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

{

632

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

633

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

Bu Sun Kim

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

[diff] [blame]

634

},

635

],

Yoshi Automation Bot

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

[diff] [blame]

636

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

637

},

638

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

643

<pre>Retrieves the next page of results.

644

645

Args:

646

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

647

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

648

649

Returns:

650

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

651

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

656

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

657

<pre>Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)

658

659

Args:

660

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

661

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

662

body: object, The request body.

663

The object takes the form of:

664

665

{ # Represents a Target HTTPS Proxy resource.

666

#

667

# Google Compute Engine has two Target HTTPS Proxy resources:

668

#

669

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

670

#

671

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

672

#

673

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

674

#

675

# 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 ==)

676

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

677

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

678

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

679

# Refer to the AuthorizationPolicy resource for additional details.

680

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

681

# Note: This field currently has no impact.

682

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

683

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

684

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

685

"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

686

"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.

687

# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

688

"A String",

689

],

690

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

691

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

692

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

693

"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

694

#

695

# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.

696

#

697

# The default is false.

698

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

699

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

700

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

701

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

702

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

Bu Sun Kim

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

[diff] [blame]

703

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

704

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

705

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

706

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

707

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

708

# If left blank, communications are not encrypted.

709

# Note: This field currently has no impact.

710

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

711

"A String",

712

],

713

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

714

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

715

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

716

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

717

# - global/urlMaps/url-map

718

}

719

720

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.

721

722

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.

723

724

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

725

726

Returns:

727

An object of the form:

728

729

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

730

#

731

# Google Compute Engine has three Operation resources:

732

#

733

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

734

#

735

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

736

#

737

# Operations can be global, regional or zonal.

738

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

739

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

740

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

741

#

742

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

743

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

744

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

745

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

746

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

747

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

748

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

Bu Sun Kim

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

[diff] [blame]

749

{

Yoshi Automation Bot

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

[diff] [blame]

750

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

751

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

752

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

Bu Sun Kim

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

[diff] [blame]

753

},

754

],

Yoshi Automation Bot

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

[diff] [blame]

755

},

756

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

757

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

758

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

759

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

760

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

761

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

yoshi-code-bot

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

[diff] [blame]

762

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

763

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

764

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

765

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

766

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

767

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

768

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

769

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

770

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

771

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

772

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

773

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

774

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

775

{

776

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

777

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

778

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

779

{

780

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

781

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

782

},

783

],

784

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

785

},

786

],

787

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

788

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

792

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

793

<pre>Changes the Certificate Map for TargetHttpsProxy.

794

795

Args:

796

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

797

targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required)

798

body: object, The request body.

799

The object takes the form of:

800

801

{

Yoshi Automation Bot

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

[diff] [blame]

802

"certificateMap": "A String", # URL of the Certificate Map to associate with this TargetHttpsProxy.

803

}

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

804

Bu Sun Kim

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

[diff] [blame]

805

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.

806

807

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.

808

809

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

810

811

Returns:

812

An object of the form:

813

Bu Sun Kim

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

[diff] [blame]

814

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

815

#

816

# Google Compute Engine has three Operation resources:

817

#

818

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

819

#

820

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

821

#

822

# Operations can be global, regional or zonal.

823

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

824

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

825

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

826

#

827

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

828

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

829

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

830

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

831

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

832

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

833

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

834

{

Yoshi Automation Bot

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

[diff] [blame]

835

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

836

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

837

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

838

},

839

],

Yoshi Automation Bot

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

[diff] [blame]

840

},

841

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

842

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

843

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

844

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

845

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

846

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

yoshi-code-bot

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

[diff] [blame]

847

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

{

861

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

862

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

863

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

864

{

865

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

866

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

867

},

868

],

869

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

870

},

871

],

872

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

873

}</pre>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

877

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

Bu Sun Kim

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

[diff] [blame]

878

<pre>Sets the QUIC override policy for TargetHttpsProxy.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

879

880

Args:

Sai Cheemalapati

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

[diff] [blame]

881

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

Bu Sun Kim

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

[diff] [blame]

882

targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. (required)

Dan O'Meara

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

[diff] [blame]

883

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

884

The object takes the form of:

885

Sai Cheemalapati

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

[diff] [blame]

886

{

Yoshi Automation Bot

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

[diff] [blame]

887

"quicOverride": "A String", # QUIC policy for the TargetHttpsProxy resource.

888

}

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

889

Bu Sun Kim

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

[diff] [blame]

890

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.

891

892

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.

893

894

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

895

896

Returns:

897

An object of the form:

898

Bu Sun Kim

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

[diff] [blame]

899

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

900

#

901

# Google Compute Engine has three Operation resources:

902

#

903

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

904

#

905

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

906

#

907

# Operations can be global, regional or zonal.

908

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

909

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

910

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

911

#

912

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

913

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

914

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

915

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

916

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

917

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

918

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

Bu Sun Kim

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

[diff] [blame]

919

{

Yoshi Automation Bot

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

[diff] [blame]

920

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

921

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

922

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

Bu Sun Kim

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

[diff] [blame]

923

},

924

],

Yoshi Automation Bot

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

[diff] [blame]

925

},

926

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

927

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

928

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

929

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

930

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

931

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

yoshi-code-bot

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

[diff] [blame]

932

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

933

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

934

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

935

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

936

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

937

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

938

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

939

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

940

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

941

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

942

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

943

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

944

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

945

{

946

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

947

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

948

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

949

{

950

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

951

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

952

},

953

],

954

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

955

},

956

],

957

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

958

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

962

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

Bu Sun Kim

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

[diff] [blame]

963

<pre>Replaces SslCertificates for TargetHttpsProxy.

964

965

Args:

966

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

967

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]

968

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

969

The object takes the form of:

970

971

{

Yoshi Automation Bot

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

[diff] [blame]

972

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

973

"A String",

974

],

975

}

Bu Sun Kim

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

[diff] [blame]

976

977

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.

978

979

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.

980

981

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

982

983

Returns:

984

An object of the form:

985

986

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

987

#

988

# Google Compute Engine has three Operation resources:

989

#

990

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

991

#

992

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

993

#

994

# Operations can be global, regional or zonal.

995

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

996

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

997

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

998

#

999

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

1000

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

1001

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

1002

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

1003

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

1004

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

1005

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

Bu Sun Kim

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

[diff] [blame]

1006

{

Yoshi Automation Bot

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

[diff] [blame]

1007

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

1008

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

1009

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

Bu Sun Kim

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

[diff] [blame]

1010

},

1011

],

Yoshi Automation Bot

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

[diff] [blame]

1012

},

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

yoshi-code-bot

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

[diff] [blame]

1019

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

{

1033

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

1034

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

1035

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

1036

{

1037

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

1038

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

1039

},

1040

],

1041

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

1042

},

1043

],

1044

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

1045

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

1049

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

Bu Sun Kim

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

[diff] [blame]

1050

<pre>Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.

1051

1052

Args:

1053

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

1054

targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose SSL policy is to be set. 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]

1055

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1056

The object takes the form of:

1057

1058

{

Yoshi Automation Bot

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

[diff] [blame]

1059

"sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.

1060

}

Bu Sun Kim

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

[diff] [blame]

1061

1062

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.

1063

1064

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.

1065

1066

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

1067

1068

Returns:

1069

An object of the form:

1070

1071

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1072

#

1073

# Google Compute Engine has three Operation resources:

1074

#

1075

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

1076

#

1077

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

1078

#

1079

# Operations can be global, regional or zonal.

1080

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

1081

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

1082

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

1083

#

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

Bu Sun Kim

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

[diff] [blame]

1091

{

Yoshi Automation Bot

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

[diff] [blame]

1092

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

1093

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

1094

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

Bu Sun Kim

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

[diff] [blame]

1095

},

1096

],

Yoshi Automation Bot

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

[diff] [blame]

1097

},

1098

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

1099

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

1100

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

1101

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

1102

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

1103

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

yoshi-code-bot

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

[diff] [blame]

1104

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

{

1118

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

1119

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

1120

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

1121

{

1122

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

1123

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

1124

},

1125

],

1126

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

1127

},

1128

],

1129

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

1130

}</pre>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1134

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

Sai Cheemalapati

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

[diff] [blame]

1135

<pre>Changes the URL map for TargetHttpsProxy.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1136

1137

Args:

Sai Cheemalapati

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

[diff] [blame]

1138

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

1139

targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)

Dan O'Meara

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

[diff] [blame]

1140

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1141

The object takes the form of:

1142

Sai Cheemalapati

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

[diff] [blame]

1143

{

Yoshi Automation Bot

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

[diff] [blame]

1144

"urlMap": "A String",

1145

}

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1146

Bu Sun Kim

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

[diff] [blame]

1147

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.

1148

1149

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.

1150

1151

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1152

1153

Returns:

1154

An object of the form:

1155

Bu Sun Kim

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

[diff] [blame]

1156

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1157

#

1158

# Google Compute Engine has three Operation resources:

1159

#

1160

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

1161

#

1162

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

1163

#

1164

# Operations can be global, regional or zonal.

1165

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

1166

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

1167

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

1168

#

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

Bu Sun Kim

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

[diff] [blame]

1176

{

Yoshi Automation Bot

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

[diff] [blame]

1177

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

1178

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

1179

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

Bu Sun Kim

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

[diff] [blame]

1180

},

1181

],

Yoshi Automation Bot

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

[diff] [blame]

1182

},

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

yoshi-code-bot

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

[diff] [blame]

1189

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot