Blame - docs/dyn/compute_beta.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

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

Bu Sun Kim

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

[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

Dmitry Frenkel

2020-10-06 16:46:05 -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

Dan O'Meara

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

[diff] [blame]

102

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

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

106

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

Jon Wayne Parrott

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

[diff] [blame]

107

Dan O'Meara

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

[diff] [blame]

108

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

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

112

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

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

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

116

<h3>Method Details</h3>

117

Dmitry Frenkel

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

[diff] [blame^]

118

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

119

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

120

121

Args:

122

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

Dan O'Meara

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

[diff] [blame]

123

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]

124

Dan O'Meara

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

[diff] [blame]

125

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]

126

Dan O'Meara

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

[diff] [blame]

127

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]

128

Bu Sun Kim

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

[diff] [blame]

129

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]

130

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]

131

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

132

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

133

134

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.

135

136

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

137

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

Dmitry Frenkel

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

[diff] [blame^]

138

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

Bu Sun Kim

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

[diff] [blame]

139

140

Returns:

141

An object of the form:

142

143

{

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

146

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

147

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

148

{ # Represents a Target HTTPS Proxy resource.

149

#

150

# Google Compute Engine has two Target HTTPS Proxy resources:

151

#

152

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

153

#

154

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

155

#

156

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

157

#

158

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

Bu Sun Kim

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

[diff] [blame]

159

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

160

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

161

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

162

# Refer to the AuthorizationPolicy resource for additional details.

163

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

Dmitry Frenkel

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

[diff] [blame^]

164

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

# -

177

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

178

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

Bu Sun Kim

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

[diff] [blame]

179

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

180

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

181

# If left blank, communications are not encrypted.

Dmitry Frenkel

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

[diff] [blame^]

182

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

183

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

184

"A String",

185

],

186

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

187

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

188

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

189

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

190

# - global/urlMaps/url-map

191

},

192

],

193

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

194

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

195

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

196

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

Bu Sun Kim

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

[diff] [blame]

197

{

Bu Sun Kim

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

[diff] [blame]

198

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

199

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

Bu Sun Kim

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

[diff] [blame]

200

},

201

],

Bu Sun Kim

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

[diff] [blame]

202

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

Bu Sun Kim

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

[diff] [blame]

203

},

Bu Sun Kim

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

[diff] [blame]

204

},

205

},

Bu Sun Kim

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

[diff] [blame]

206

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

207

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

208

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

Dmitry Frenkel

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

[diff] [blame^]

209

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

210

"A String",

211

],

Bu Sun Kim

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

[diff] [blame]

212

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

213

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

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

{

Bu Sun Kim

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

[diff] [blame]

217

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

218

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

Bu Sun Kim

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

[diff] [blame]

219

},

220

],

Bu Sun Kim

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

[diff] [blame]

221

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

Bu Sun Kim

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

[diff] [blame]

222

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

228

<pre>Retrieves the next page of results.

229

230

Args:

231

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

232

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

233

234

Returns:

Bu Sun Kim

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

[diff] [blame]

235

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]

236

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

241

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

242

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

246

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

Sai Cheemalapati

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

[diff] [blame]

247

<pre>Deletes the specified TargetHttpsProxy resource.

Jon Wayne Parrott

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

[diff] [blame]

248

249

Args:

Sai Cheemalapati

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

[diff] [blame]

250

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

251

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

Bu Sun Kim

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

[diff] [blame]

252

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.

253

254

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.

255

256

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]

257

258

Returns:

259

An object of the form:

260

Bu Sun Kim

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

[diff] [blame]

261

{ # Represents an Operation resource.

262

#

Dan O'Meara

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

[diff] [blame]

263

# Google Compute Engine has three Operation resources:

264

#

265

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

266

#

Bu Sun Kim

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

[diff] [blame]

267

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

268

#

269

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

270

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

271

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

272

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

Bu Sun Kim

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

[diff] [blame]

273

#

Dan O'Meara

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

[diff] [blame]

274

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

Bu Sun Kim

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

[diff] [blame]

275

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

276

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

277

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

278

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

279

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

280

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

Jon Wayne Parrott

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

[diff] [blame]

281

{

Bu Sun Kim

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

[diff] [blame]

282

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

283

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

284

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

Jon Wayne Parrott

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

[diff] [blame]

285

},

286

],

287

},

Bu Sun Kim

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

[diff] [blame]

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

{

306

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

307

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

308

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

309

{

310

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

311

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

312

},

313

],

314

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

315

},

316

],

317

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

Jon Wayne Parrott

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

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

322

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

Bu Sun Kim

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

[diff] [blame]

323

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

324

325

Args:

Sai Cheemalapati

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

[diff] [blame]

326

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

327

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

Jon Wayne Parrott

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

[diff] [blame]

328

329

Returns:

330

An object of the form:

331

Dan O'Meara

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

[diff] [blame]

332

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

333

#

334

# Google Compute Engine has two Target HTTPS Proxy resources:

335

#

336

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

337

#

338

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

339

#

340

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

341

#

342

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

Bu Sun Kim

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

[diff] [blame]

343

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

344

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

345

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

346

# Refer to the AuthorizationPolicy resource for additional details.

347

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

Dmitry Frenkel

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

[diff] [blame^]

348

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

360

# -

361

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

362

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

Bu Sun Kim

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

[diff] [blame]

363

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

364

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

365

# If left blank, communications are not encrypted.

Dmitry Frenkel

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

[diff] [blame^]

366

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

367

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

368

"A String",

369

],

370

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

371

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

372

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

373

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

374

# - global/urlMaps/url-map

375

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

379

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

Sai Cheemalapati

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

[diff] [blame]

380

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

381

382

Args:

Sai Cheemalapati

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

[diff] [blame]

383

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

Dan O'Meara

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

[diff] [blame]

384

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

385

The object takes the form of:

386

Dan O'Meara

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

[diff] [blame]

387

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

388

#

389

# Google Compute Engine has two Target HTTPS Proxy resources:

390

#

391

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

392

#

393

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

394

#

395

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

396

#

397

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

Bu Sun Kim

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

[diff] [blame]

398

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

399

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

400

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

401

# Refer to the AuthorizationPolicy resource for additional details.

402

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

Dmitry Frenkel

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

[diff] [blame^]

403

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

# -

416

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

417

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

Bu Sun Kim

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

[diff] [blame]

418

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

419

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

420

# If left blank, communications are not encrypted.

Dmitry Frenkel

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

[diff] [blame^]

421

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

422

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

423

"A String",

424

],

425

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

426

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

427

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

428

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

429

# - global/urlMaps/url-map

430

}

Jon Wayne Parrott

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

[diff] [blame]

431

Bu Sun Kim

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

[diff] [blame]

432

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.

433

434

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.

435

436

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]

437

438

Returns:

439

An object of the form:

440

Bu Sun Kim

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

[diff] [blame]

441

{ # Represents an Operation resource.

442

#

Dan O'Meara

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

[diff] [blame]

443

# Google Compute Engine has three Operation resources:

444

#

445

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

446

#

Bu Sun Kim

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

[diff] [blame]

447

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

448

#

449

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

450

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

451

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

452

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

Bu Sun Kim

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

[diff] [blame]

453

#

Dan O'Meara

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

[diff] [blame]

454

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

Bu Sun Kim

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

[diff] [blame]

455

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

456

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

457

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

458

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

459

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

460

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

Jon Wayne Parrott

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

[diff] [blame]

461

{

Bu Sun Kim

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

[diff] [blame]

462

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

463

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

464

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

Jon Wayne Parrott

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

[diff] [blame]

465

},

466

],

467

},

Bu Sun Kim

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

[diff] [blame]

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

{

486

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

487

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

488

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

489

{

490

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

491

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

492

},

493

],

494

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

495

},

496

],

497

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

Jon Wayne Parrott

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

502

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

Sai Cheemalapati

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

[diff] [blame]

503

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

Jon Wayne Parrott

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

[diff] [blame]

504

505

Args:

Sai Cheemalapati

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

[diff] [blame]

506

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

Dan O'Meara

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

[diff] [blame]

507

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

Jon Wayne Parrott

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

[diff] [blame]

508

Dan O'Meara

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

[diff] [blame]

509

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

Jon Wayne Parrott

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

[diff] [blame]

510

Dan O'Meara

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

[diff] [blame]

511

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.

Jon Wayne Parrott

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

[diff] [blame]

512

Bu Sun Kim

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

[diff] [blame]

513

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

514

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

515

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

516

517

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.

518

519

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

520

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

Dmitry Frenkel

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

[diff] [blame^]

521

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

Jon Wayne Parrott

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

[diff] [blame]

522

523

Returns:

524

An object of the form:

525

Sai Cheemalapati

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

[diff] [blame]

526

{ # Contains a list of TargetHttpsProxy resources.

Bu Sun Kim

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

[diff] [blame]

527

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

528

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

Dan O'Meara

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

[diff] [blame]

529

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

530

#

531

# Google Compute Engine has two Target HTTPS Proxy resources:

532

#

533

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

534

#

535

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

536

#

537

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

538

#

539

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

Bu Sun Kim

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

[diff] [blame]

540

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

541

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

542

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

543

# Refer to the AuthorizationPolicy resource for additional details.

544

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

Dmitry Frenkel

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

[diff] [blame^]

545

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

556

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

557

# -

558

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

559

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

Bu Sun Kim

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

[diff] [blame]

560

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

561

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

562

# If left blank, communications are not encrypted.

Dmitry Frenkel

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

[diff] [blame^]

563

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

564

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

565

"A String",

566

],

567

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

568

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

569

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

570

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

571

# - global/urlMaps/url-map

572

},

Jon Wayne Parrott

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

[diff] [blame]

573

],

Bu Sun Kim

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

[diff] [blame]

574

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

575

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

576

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

577

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

578

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

579

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

580

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

Bu Sun Kim

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

[diff] [blame]

581

{

Bu Sun Kim

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

[diff] [blame]

582

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

583

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

Bu Sun Kim

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

[diff] [blame]

584

},

585

],

Bu Sun Kim

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

[diff] [blame]

586

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

Bu Sun Kim

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

[diff] [blame]

587

},

Jon Wayne Parrott

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

[diff] [blame]

}</pre>

</div>

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

593

<pre>Retrieves the next page of results.

594

595

Args:

596

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

597

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

598

599

Returns:

Bu Sun Kim

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

[diff] [blame]

600

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

Jon Wayne Parrott

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

[diff] [blame]

601

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

606

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

607

<pre>Sets the QUIC override policy for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

608

609

Args:

Sai Cheemalapati

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

[diff] [blame]

610

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

Bu Sun Kim

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

[diff] [blame]

611

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]

612

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

613

The object takes the form of:

614

Sai Cheemalapati

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

[diff] [blame]

615

{

Bu Sun Kim

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

[diff] [blame]

616

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

Jon Wayne Parrott

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

[diff] [blame]

617

}

618

Bu Sun Kim

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

[diff] [blame]

619

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.

620

621

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.

622

623

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]

624

625

Returns:

626

An object of the form:

627

Bu Sun Kim

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

[diff] [blame]

628

{ # Represents an Operation resource.

629

#

Dan O'Meara

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

[diff] [blame]

630

# Google Compute Engine has three Operation resources:

631

#

632

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

633

#

Bu Sun Kim

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

[diff] [blame]

634

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

635

#

636

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

637

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

638

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

639

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

Bu Sun Kim

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

[diff] [blame]

640

#

Dan O'Meara

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

[diff] [blame]

641

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

Bu Sun Kim

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

[diff] [blame]

642

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

643

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

644

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

645

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

646

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

647

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

Jon Wayne Parrott

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

[diff] [blame]

648

{

Bu Sun Kim

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

[diff] [blame]

649

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

650

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

651

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

Jon Wayne Parrott

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

[diff] [blame]

652

},

653

],

654

},

Bu Sun Kim

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

[diff] [blame]

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

{

673

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

674

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

675

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

676

{

677

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

678

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

679

},

680

],

681

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

682

},

683

],

684

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

Jon Wayne Parrott

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

689

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

690

<pre>Replaces SslCertificates for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

691

692

Args:

Sai Cheemalapati

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

[diff] [blame]

693

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

Bu Sun Kim

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

[diff] [blame]

694

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]

695

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

696

The object takes the form of:

697

Sai Cheemalapati

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

[diff] [blame]

698

{

Bu Sun Kim

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

[diff] [blame]

699

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

700

"A String",

Bu Sun Kim

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

[diff] [blame]

701

],

Jon Wayne Parrott

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

[diff] [blame]

702

}

703

Bu Sun Kim

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

[diff] [blame]

704

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.

705

706

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.

707

708

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]

709

710

Returns:

711

An object of the form:

712

Bu Sun Kim

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

[diff] [blame]

713

{ # Represents an Operation resource.

714

#

Dan O'Meara

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

[diff] [blame]

715

# Google Compute Engine has three Operation resources:

716

#

717

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

718

#

Bu Sun Kim

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

[diff] [blame]

719

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

720

#

721

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

722

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

723

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

724

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

Bu Sun Kim

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

[diff] [blame]

725

#

Dan O'Meara

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

[diff] [blame]

726

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

Bu Sun Kim

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

[diff] [blame]

727

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

728

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

729

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

730

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

731

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

732

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

Bu Sun Kim

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

[diff] [blame]

733

{

Bu Sun Kim

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

[diff] [blame]

734

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

735

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

736

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

Bu Sun Kim

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

[diff] [blame]

737

},

738

],

739

},

Bu Sun Kim

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

[diff] [blame]

740

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

741

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

742

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

743

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

744

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

745

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

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

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

756

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

757

{

758

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

759

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

760

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

761

{

762

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

763

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

764

},

765

],

766

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

767

},

768

],

769

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

774

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

775

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

776

777

Args:

778

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

779

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]

780

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

781

The object takes the form of:

782

783

{

Bu Sun Kim

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

[diff] [blame]

784

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

Bu Sun Kim

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

[diff] [blame]

785

}

786

787

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.

788

789

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.

790

791

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

792

793

Returns:

794

An object of the form:

795

796

{ # Represents an Operation resource.

797

#

Dan O'Meara

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

[diff] [blame]

798

# Google Compute Engine has three Operation resources:

799

#

800

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

801

#

Bu Sun Kim

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

[diff] [blame]

802

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

803

#

804

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

805

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

806

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

807

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

Bu Sun Kim

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

[diff] [blame]

808

#

Dan O'Meara

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

[diff] [blame]

809

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

Bu Sun Kim

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

[diff] [blame]

810

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

811

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

812

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

813

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

814

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

815

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

Bu Sun Kim

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

[diff] [blame]

816

{

Bu Sun Kim

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

[diff] [blame]

817

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

818

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

819

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

Bu Sun Kim

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

[diff] [blame]

820

},

821

],

822

},

Bu Sun Kim

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

[diff] [blame]

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

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

838

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

839

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

840

{

841

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

842

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

843

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

844

{

845

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

846

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

847

},

848

],

849

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

850

},

851

],

852

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

857

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

Bu Sun Kim

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

[diff] [blame]

858

<pre>Changes the URL map for TargetHttpsProxy.

859

860

Args:

861

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

862

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]

863

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

864

The object takes the form of:

865

866

{

Bu Sun Kim

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

[diff] [blame]

867

"urlMap": "A String",

Bu Sun Kim

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

[diff] [blame]

868

}

869

870

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.

871

872

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.

873

874

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

875

876

Returns:

877

An object of the form:

878

879

{ # Represents an Operation resource.

880

#

Dan O'Meara

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

[diff] [blame]

881

# Google Compute Engine has three Operation resources:

882

#

883

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

884

#

Bu Sun Kim

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

[diff] [blame]

885

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

886

#

887

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

888

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

889

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

890

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

Bu Sun Kim

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

[diff] [blame]

891

#

Dan O'Meara

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

[diff] [blame]

892

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

Bu Sun Kim

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

[diff] [blame]

893

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

894

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

895

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

896

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

897

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

898

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

Jon Wayne Parrott

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

[diff] [blame]

899

{

Bu Sun Kim

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

[diff] [blame]

900

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

901

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

902

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

Jon Wayne Parrott

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

[diff] [blame]

903

},

904

],

905

},

Bu Sun Kim