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

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

84

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

Sai Cheemalapati

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

[diff] [blame]

85

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

Jon Wayne Parrott

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

[diff] [blame]

86

Sai Cheemalapati

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

89

Dan O'Meara

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

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

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

92

Bu Sun Kim

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

[diff] [blame]

93

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

94

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

95

96

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

97

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

98

Bu Sun Kim

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

[diff] [blame]

99

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

100

<p class="firstline">Changes the Certificate Map for TargetHttpsProxy.</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

Bu Sun Kim

2020-05-20 12:08:20 -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.

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

159

"authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.

160

# Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.

161

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

162

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

163

# Refer to the Authorization resource for additional details.

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

# -

178

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

179

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

180

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

181

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

182

"A String",

183

],

184

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

185

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

186

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

187

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

188

# - global/urlMaps/url-map

189

},

190

],

191

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

192

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

193

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

194

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

Bu Sun Kim

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

[diff] [blame]

195

{

Bu Sun Kim

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

[diff] [blame]

196

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

197

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

198

},

199

],

Bu Sun Kim

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

[diff] [blame]

200

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

201

},

Bu Sun Kim

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

[diff] [blame]

202

},

203

},

Bu Sun Kim

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

[diff] [blame]

204

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

205

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

206

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

207

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

208

"A String",

209

],

210

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

211

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

212

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

213

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

Bu Sun Kim

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

[diff] [blame]

214

{

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

217

},

218

],

Bu Sun Kim

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

[diff] [blame]

219

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

220

},

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>

226

<pre>Retrieves the next page of results.

227

228

Args:

229

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

230

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

231

232

Returns:

Bu Sun Kim

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

[diff] [blame]

233

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]

234

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

</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

239

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

Sai Cheemalapati

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

[diff] [blame]

240

<pre>Deletes the specified TargetHttpsProxy resource.

Jon Wayne Parrott

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

[diff] [blame]

241

242

Args:

Sai Cheemalapati

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

[diff] [blame]

243

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

244

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

Bu Sun Kim

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

[diff] [blame]

245

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.

246

247

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.

248

249

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]

250

251

Returns:

252

An object of the form:

253

Bu Sun Kim

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

[diff] [blame]

254

{ # Represents an Operation resource.

255

#

Dan O'Meara

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

[diff] [blame]

256

# Google Compute Engine has three Operation resources:

257

#

258

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

259

#

Bu Sun Kim

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

[diff] [blame]

260

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

261

#

262

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

263

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

264

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

265

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

Bu Sun Kim

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

[diff] [blame]

266

#

Dan O'Meara

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

[diff] [blame]

267

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

268

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

269

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

270

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

271

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

272

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

273

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

Jon Wayne Parrott

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

[diff] [blame]

274

{

Bu Sun Kim

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

[diff] [blame]

275

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

276

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

277

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

Jon Wayne Parrott

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

[diff] [blame]

278

},

279

],

280

},

Bu Sun Kim

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

[diff] [blame]

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

{

300

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

301

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

302

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

303

{

304

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

305

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

306

},

307

],

308

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

309

},

310

],

311

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

316

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

Bu Sun Kim

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

[diff] [blame]

317

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

318

319

Args:

Sai Cheemalapati

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

[diff] [blame]

320

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

321

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

Jon Wayne Parrott

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

[diff] [blame]

322

323

Returns:

324

An object of the form:

325

Dan O'Meara

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

[diff] [blame]

326

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

327

#

328

# Google Compute Engine has two Target HTTPS Proxy resources:

329

#

330

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

331

#

332

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

333

#

334

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

335

#

336

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

337

"authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.

338

# Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.

339

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

340

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

341

# Refer to the Authorization resource for additional details.

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

# -

356

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

357

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

358

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

359

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

360

"A String",

361

],

362

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

363

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

364

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

365

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

366

# - global/urlMaps/url-map

367

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

371

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

Sai Cheemalapati

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

[diff] [blame]

372

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

373

374

Args:

Sai Cheemalapati

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

[diff] [blame]

375

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

Dan O'Meara

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

[diff] [blame]

376

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

377

The object takes the form of:

378

Dan O'Meara

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

[diff] [blame]

379

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

380

#

381

# Google Compute Engine has two Target HTTPS Proxy resources:

382

#

383

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

384

#

385

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

386

#

387

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

388

#

389

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

390

"authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.

391

# Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.

392

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

393

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

394

# Refer to the Authorization resource for additional details.

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

# -

409

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

410

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

411

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

412

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

413

"A String",

414

],

415

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

416

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

417

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

418

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

419

# - global/urlMaps/url-map

420

}

421

422

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.

423

424

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.

425

426

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

427

428

Returns:

429

An object of the form:

430

431

{ # Represents an Operation resource.

432

#

433

# Google Compute Engine has three Operation resources:

434

#

435

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

436

#

437

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

438

#

439

# Operations can be global, regional or zonal.

440

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

441

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

442

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

443

#

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

{

452

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

453

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

454

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

},

],

},

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

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

{

477

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

478

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

479

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

480

{

481

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

482

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

483

},

484

],

485

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

486

},

Sai Cheemalapati

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

[diff] [blame]

487

],

Bu Sun Kim

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

[diff] [blame]

488

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

}</pre>

</div>

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

494

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

495

496

Args:

497

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

498

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

499

500

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

501

502

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.

503

504

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

505

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

506

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

507

508

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.

509

510

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

511

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.

512

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.

513

514

Returns:

515

An object of the form:

516

517

{ # Contains a list of TargetHttpsProxy resources.

518

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

519

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

520

{ # Represents a Target HTTPS Proxy resource.

521

#

522

# Google Compute Engine has two Target HTTPS Proxy resources:

523

#

524

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

525

#

526

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

527

#

528

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

529

#

530

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

531

"authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.

532

# Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.

533

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

534

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

535

# Refer to the Authorization resource for additional details.

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

# -

550

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

551

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

552

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

553

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

554

"A String",

555

],

556

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

557

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

558

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

559

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

560

# - global/urlMaps/url-map

561

},

562

],

563

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

564

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

565

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

566

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

567

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

568

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

569

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

570

{

571

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

572

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

573

},

574

],

575

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

},

}</pre>

</div>

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

582

<pre>Retrieves the next page of results.

583

584

Args:

585

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

586

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

587

588

Returns:

589

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

590

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

</pre>

</div>

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

596

<pre>Changes the Certificate Map for TargetHttpsProxy.

597

598

Args:

599

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

600

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)

601

body: object, The request body.

602

The object takes the form of:

603

604

{

605

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

Jon Wayne Parrott

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

[diff] [blame]

606

}

607

Bu Sun Kim

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

[diff] [blame]

608

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.

609

610

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.

611

612

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]

613

614

Returns:

615

An object of the form:

616

Bu Sun Kim

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

[diff] [blame]

617

{ # Represents an Operation resource.

618

#

Dan O'Meara

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

[diff] [blame]

619

# Google Compute Engine has three Operation resources:

620

#

621

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

622

#

Bu Sun Kim

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

[diff] [blame]

623

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

624

#

625

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

626

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

627

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

628

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

Bu Sun Kim

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

[diff] [blame]

629

#

Dan O'Meara

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

[diff] [blame]

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

{

638

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

639

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

640

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

},

],

},

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

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

Jon Wayne Parrott

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

[diff] [blame]

662

{

Bu Sun Kim

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

[diff] [blame]

663

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

664

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

665

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

Jon Wayne Parrott

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

[diff] [blame]

666

{

Bu Sun Kim

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

[diff] [blame]

667

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

668

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

Jon Wayne Parrott

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

[diff] [blame]

669

},

670

],

Bu Sun Kim

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

[diff] [blame]

671

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

Jon Wayne Parrott

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

[diff] [blame]

672

},

673

],

Bu Sun Kim

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

[diff] [blame]

674

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

679

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

680

<pre>Sets the QUIC override policy for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

681

682

Args:

Sai Cheemalapati

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

[diff] [blame]

683

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

Bu Sun Kim

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

[diff] [blame]

684

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]

685

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

686

The object takes the form of:

687

Sai Cheemalapati

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

[diff] [blame]

688

{

Bu Sun Kim

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

[diff] [blame]

689

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

Jon Wayne Parrott

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

[diff] [blame]

690

}

691

Bu Sun Kim

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

[diff] [blame]

692

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.

693

694

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.

695

696

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]

697

698

Returns:

699

An object of the form:

700

Bu Sun Kim

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

[diff] [blame]

701

{ # Represents an Operation resource.

702

#

Dan O'Meara

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

[diff] [blame]

703

# Google Compute Engine has three Operation resources:

704

#

705

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

706

#

Bu Sun Kim

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

[diff] [blame]

707

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

708

#

709

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

710

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

711

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

712

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

Bu Sun Kim

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

[diff] [blame]

713

#

Dan O'Meara

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

[diff] [blame]

714

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

715

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

716

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

717

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

718

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

719

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

720

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

Bu Sun Kim

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

[diff] [blame]

721

{

Bu Sun Kim

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

[diff] [blame]

722

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

723

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

724

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

Bu Sun Kim

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

[diff] [blame]

725

},

726

],

727

},

Bu Sun Kim

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

[diff] [blame]

728

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

729

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

730

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

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

745

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

746

{

747

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

748

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

749

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

750

{

751

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

752

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

753

},

754

],

755

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

756

},

757

],

758

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

763

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

764

<pre>Replaces SslCertificates for TargetHttpsProxy.

765

766

Args:

767

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

768

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]

769

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

770

The object takes the form of:

771

772

{

Bu Sun Kim

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

[diff] [blame]

773

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

774

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

779

780

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.

781

782

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

783

784

Returns:

785

An object of the form:

786

787

{ # Represents an Operation resource.

788

#

Dan O'Meara

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

[diff] [blame]

789

# Google Compute Engine has three Operation resources:

790

#

791

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

792

#

Bu Sun Kim

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

[diff] [blame]

793

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

794

#

795

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

796

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

797

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

798

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

Bu Sun Kim

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

[diff] [blame]

799

#

Dan O'Meara

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

[diff] [blame]

800

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

801

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

802

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

803

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

804

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

805

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

806

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

Bu Sun Kim

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

[diff] [blame]

807

{

Bu Sun Kim

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

[diff] [blame]

808

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

809

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

810

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

Bu Sun Kim

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

[diff] [blame]

811

},

812

],

813

},

Bu Sun Kim

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

[diff] [blame]

814

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

815

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

816

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

817

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

818

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

819

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

820

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

821

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

822

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

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

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

831

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

832

{

833

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

834

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

835

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

836

{

837

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

838

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

839

},

840

],

841

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

842

},

843

],

844

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

849

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

850

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

851

852

Args:

853

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

854

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]

855

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

856

The object takes the form of:

857

858

{

Bu Sun Kim

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

[diff] [blame]

859

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

860

}

861

862

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.

863

864

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.

865

866

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

867

868

Returns:

869

An object of the form:

870

871

{ # Represents an Operation resource.

872

#

Dan O'Meara

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

[diff] [blame]

873

# Google Compute Engine has three Operation resources:

874

#

875

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

876

#

Bu Sun Kim

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

[diff] [blame]

877

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

878

#

879

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

880

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

881

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

882

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

Bu Sun Kim

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

[diff] [blame]

883

#

Dan O'Meara

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

[diff] [blame]

884

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

885

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

886

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

887

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

888

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

889

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

890

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

Jon Wayne Parrott

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

[diff] [blame]

891

{

Bu Sun Kim

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

[diff] [blame]

892

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

893

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

894

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

Jon Wayne Parrott

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

[diff] [blame]

895

},

896

],

897

},

Bu Sun Kim

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

[diff] [blame]

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

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

911

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

912

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

913

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

914

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

915

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

916

{

917

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

918

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

919

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

920

{

921

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

922

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

923

},

924

],

925

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

926

},

927

],

928

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

933

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

Sai Cheemalapati

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

[diff] [blame]

934

<pre>Changes the URL map for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

935

936

Args:

Sai Cheemalapati

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

[diff] [blame]

937

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

938

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]

939

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

940

The object takes the form of:

941

Sai Cheemalapati

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

[diff] [blame]

942

{

Bu Sun Kim

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

[diff] [blame]

943

"urlMap": "A String",

Jon Wayne Parrott

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

[diff] [blame]

944

}

945

Bu Sun Kim

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

[diff] [blame]

946

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.

947

948

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.

949

950

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]

951

952

Returns:

953

An object of the form:

954

Bu Sun Kim

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

[diff] [blame]

955

{ # Represents an Operation resource.

956

#

Dan O'Meara

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

[diff] [blame]

957

# Google Compute Engine has three Operation resources:

958

#

959

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

960

#

Bu Sun Kim

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

[diff] [blame]

961

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

962

#

963

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

964

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

965

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

966

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

Bu Sun Kim

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

[diff] [blame]

967

#

Dan O'Meara

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

[diff] [blame]

968

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

969

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

970

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

971

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

972

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

973

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

974

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

Jon Wayne Parrott

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

[diff] [blame]

975

{

Bu Sun Kim

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

[diff] [blame]

976

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

977

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

978

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

Jon Wayne Parrott

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

[diff] [blame]

979

},

980

],

981

},

Bu Sun Kim