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

2020-05-01 07:42:23 -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

Bu Sun Kim

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

[diff] [blame]

84

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

Jon Wayne Parrott

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

[diff] [blame]

85

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

86

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>

Jon Wayne Parrott

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

[diff] [blame]

91

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

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)</a></code></p>

Jon Wayne Parrott

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

[diff] [blame]

94

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

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

Dan O'Meara

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

[diff] [blame]

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Jon Wayne Parrott

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

[diff] [blame]

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Jon Wayne Parrott

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

[diff] [blame]

109

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

110

<h3>Method Details</h3>

111

Bu Sun Kim

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

[diff] [blame]

112

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

Dan O'Meara

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

[diff] [blame]

113

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

114

115

Args:

116

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

Dan O'Meara

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

[diff] [blame]

117

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

118

119

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

120

121

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.

122

Bu Sun Kim

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

[diff] [blame]

123

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]

124

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]

125

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

126

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

127

128

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.

129

130

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

131

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.

Dan O'Meara

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

[diff] [blame]

132

133

Returns:

134

An object of the form:

135

136

{

Bu Sun Kim

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

[diff] [blame]

137

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

138

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

139

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

140

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

141

{ # Represents a Target HTTPS Proxy resource.

142

#

143

# Google Compute Engine has two Target HTTPS Proxy resources:

144

#

145

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

146

#

147

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

148

#

149

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

150

#

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

# -

163

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

164

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

165

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

166

"A String",

167

],

168

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

169

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

170

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

171

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

172

# - global/urlMaps/url-map

173

},

174

],

175

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

176

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

177

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

178

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

Dan O'Meara

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

[diff] [blame]

179

{

Bu Sun Kim

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

[diff] [blame]

180

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

181

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

Dan O'Meara

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

[diff] [blame]

182

},

183

],

Bu Sun Kim

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

[diff] [blame]

184

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

Dan O'Meara

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

[diff] [blame]

185

},

Dan O'Meara

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

[diff] [blame]

186

},

187

},

Bu Sun Kim

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

[diff] [blame]

188

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

189

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

190

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

191

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

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

Dan O'Meara

2020-05-01 07:42:23 -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.

Dan O'Meara

2020-05-01 07:42:23 -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.

Dan O'Meara

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

[diff] [blame]

201

},

Dan O'Meara

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

[diff] [blame]

}</pre>

</div>

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

207

<pre>Retrieves the next page of results.

208

209

Args:

210

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

211

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

212

213

Returns:

Bu Sun Kim

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

[diff] [blame]

214

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

Dan O'Meara

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

[diff] [blame]

215

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

220

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

Jon Wayne Parrott

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

[diff] [blame]

221

<pre>Deletes the specified TargetHttpsProxy resource.

222

223

Args:

224

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

225

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

Bu Sun Kim

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

[diff] [blame]

226

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.

227

228

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.

229

230

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]

231

232

Returns:

233

An object of the form:

234

Bu Sun Kim

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

[diff] [blame]

235

{ # Represents an Operation resource.

236

#

Dan O'Meara

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

[diff] [blame]

237

# Google Compute Engine has three Operation resources:

238

#

239

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

240

#

Bu Sun Kim

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

[diff] [blame]

241

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

242

#

243

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

244

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

245

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

246

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

Bu Sun Kim

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

[diff] [blame]

247

#

Dan O'Meara

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

[diff] [blame]

248

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

249

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

250

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

251

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

252

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

253

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

254

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

Jon Wayne Parrott

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

[diff] [blame]

255

{

Bu Sun Kim

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

[diff] [blame]

256

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

257

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

258

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

Jon Wayne Parrott

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

[diff] [blame]

259

},

260

],

261

},

Bu Sun Kim

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

[diff] [blame]

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

{

280

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

281

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

282

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

283

{

284

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

285

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

286

},

287

],

288

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

289

},

290

],

291

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

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

Bu Sun Kim

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

[diff] [blame]

297

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

298

299

Args:

300

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

301

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

302

303

Returns:

304

An object of the form:

305

Dan O'Meara

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

[diff] [blame]

306

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

307

#

308

# Google Compute Engine has two Target HTTPS Proxy resources:

309

#

310

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

311

#

312

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

313

#

314

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

315

#

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

# -

328

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

329

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

330

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

331

"A String",

332

],

333

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

334

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

335

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

336

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

337

# - global/urlMaps/url-map

338

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

342

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

Jon Wayne Parrott

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

[diff] [blame]

343

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

344

345

Args:

346

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

Dan O'Meara

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

[diff] [blame]

347

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

348

The object takes the form of:

349

Dan O'Meara

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

[diff] [blame]

350

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

351

#

352

# Google Compute Engine has two Target HTTPS Proxy resources:

353

#

354

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

355

#

356

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

357

#

358

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

359

#

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

# -

372

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

373

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

374

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

375

"A String",

376

],

377

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

378

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

379

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

380

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

381

# - global/urlMaps/url-map

382

}

Jon Wayne Parrott

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

[diff] [blame]

383

Bu Sun Kim

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

[diff] [blame]

384

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.

385

386

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.

387

388

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]

389

390

Returns:

391

An object of the form:

392

Bu Sun Kim

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

[diff] [blame]

393

{ # Represents an Operation resource.

394

#

Dan O'Meara

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

[diff] [blame]

395

# Google Compute Engine has three Operation resources:

396

#

397

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

398

#

Bu Sun Kim

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

[diff] [blame]

399

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

400

#

401

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

402

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

403

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

404

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

Bu Sun Kim

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

[diff] [blame]

405

#

Dan O'Meara

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

[diff] [blame]

406

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

407

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

408

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

409

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

410

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

411

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

412

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

Jon Wayne Parrott

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

[diff] [blame]

413

{

Bu Sun Kim

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

[diff] [blame]

414

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

415

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

416

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

Jon Wayne Parrott

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

[diff] [blame]

417

},

418

],

419

},

Bu Sun Kim

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

[diff] [blame]

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

{

438

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

439

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

440

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

441

{

442

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

443

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

444

},

445

],

446

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

447

},

448

],

449

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

Bu Sun Kim

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

[diff] [blame]

454

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

Jon Wayne Parrott

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

[diff] [blame]

455

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

456

457

Args:

458

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

Dan O'Meara

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

[diff] [blame]

459

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Jon Wayne Parrott

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

[diff] [blame]

460

Dan O'Meara

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

[diff] [blame]

461

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

Jon Wayne Parrott

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

[diff] [blame]

462

Dan O'Meara

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

[diff] [blame]

463

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Jon Wayne Parrott

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

[diff] [blame]

464

Bu Sun Kim

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

[diff] [blame]

465

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

466

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

467

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

468

469

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.

470

471

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

472

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.

Jon Wayne Parrott

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

[diff] [blame]

473

474

Returns:

475

An object of the form:

476

477

{ # Contains a list of TargetHttpsProxy resources.

Bu Sun Kim

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

[diff] [blame]

478

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

479

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

Dan O'Meara

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

[diff] [blame]

480

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

481

#

482

# Google Compute Engine has two Target HTTPS Proxy resources:

483

#

484

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

485

#

486

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

487

#

488

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

489

#

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

# -

502

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

503

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

504

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

505

"A String",

506

],

507

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

508

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

509

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

510

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

511

# - global/urlMaps/url-map

512

},

Jon Wayne Parrott

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

[diff] [blame]

513

],

Bu Sun Kim

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

[diff] [blame]

514

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

515

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

516

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

517

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

518

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

519

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

520

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

Bu Sun Kim

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

[diff] [blame]

521

{

Bu Sun Kim

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

[diff] [blame]

522

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

523

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

524

},

525

],

Bu Sun Kim

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

[diff] [blame]

526

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

527

},

Jon Wayne Parrott

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

[diff] [blame]

}</pre>

</div>

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

533

<pre>Retrieves the next page of results.

534

535

Args:

536

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

537

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

538

539

Returns:

Bu Sun Kim

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

[diff] [blame]

540

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

Jon Wayne Parrott

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

[diff] [blame]

541

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

546

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

547

<pre>Sets the QUIC override policy for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

548

549

Args:

550

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

Bu Sun Kim

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

[diff] [blame]

551

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]

552

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

553

The object takes the form of:

554

555

{

Bu Sun Kim

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

[diff] [blame]

556

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

Jon Wayne Parrott

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

[diff] [blame]

557

}

558

Bu Sun Kim

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

[diff] [blame]

559

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.

560

561

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.

562

563

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]

564

565

Returns:

566

An object of the form:

567

Bu Sun Kim

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

[diff] [blame]

568

{ # Represents an Operation resource.

569

#

Dan O'Meara

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

[diff] [blame]

570

# Google Compute Engine has three Operation resources:

571

#

572

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

573

#

Bu Sun Kim

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

[diff] [blame]

574

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

575

#

576

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

577

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

578

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

579

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

Bu Sun Kim

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

[diff] [blame]

580

#

Dan O'Meara

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

[diff] [blame]

581

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

582

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

583

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

584

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

585

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

586

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

587

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

Jon Wayne Parrott

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

[diff] [blame]

588

{

Bu Sun Kim

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

[diff] [blame]

589

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

590

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

591

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

Jon Wayne Parrott

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

[diff] [blame]

592

},

593

],

594

},

Bu Sun Kim

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

[diff] [blame]

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

{

613

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

614

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

615

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

616

{

617

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

618

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

619

},

620

],

621

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

622

},

623

],

624

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

629

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

630

<pre>Replaces SslCertificates for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

631

632

Args:

633

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

Bu Sun Kim

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

[diff] [blame]

634

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]

635

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

636

The object takes the form of:

637

638

{

Bu Sun Kim

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

[diff] [blame]

639

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

640

"A String",

Bu Sun Kim

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

[diff] [blame]

641

],

Jon Wayne Parrott

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

[diff] [blame]

642

}

643

Bu Sun Kim

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

[diff] [blame]

644

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.

645

646

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.

647

648

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]

649

650

Returns:

651

An object of the form:

652

Bu Sun Kim

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

[diff] [blame]

653

{ # Represents an Operation resource.

654

#

Dan O'Meara

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

[diff] [blame]

655

# Google Compute Engine has three Operation resources:

656

#

657

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

658

#

Bu Sun Kim

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

[diff] [blame]

659

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

660

#

661

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

662

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

663

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

664

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

Bu Sun Kim

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

[diff] [blame]

665

#

Dan O'Meara

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

[diff] [blame]

666

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

667

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

668

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

669

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

670

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

671

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

672

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

Bu Sun Kim

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

[diff] [blame]

673

{

Bu Sun Kim

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

[diff] [blame]

674

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

675

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

676

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

Bu Sun Kim

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

[diff] [blame]

677

},

678

],

679

},

Bu Sun Kim

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

[diff] [blame]

680

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

681

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

682

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

683

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

684

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

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

697

{

698

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

699

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

700

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

701

{

702

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

703

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

704

},

705

],

706

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

707

},

708

],

709

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

714

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

715

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

716

717

Args:

718

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

719

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]

720

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

721

The object takes the form of:

722

723

{

Bu Sun Kim

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

[diff] [blame]

724

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

725

}

726

727

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.

728

729

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.

730

731

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

732

733

Returns:

734

An object of the form:

735

736

{ # Represents an Operation resource.

737

#

Dan O'Meara

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

[diff] [blame]

738

# Google Compute Engine has three Operation resources:

739

#

740

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

741

#

Bu Sun Kim

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

[diff] [blame]

742

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

743

#

744

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

745

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

746

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

747

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

Bu Sun Kim

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

[diff] [blame]

748

#

Dan O'Meara

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

[diff] [blame]

749

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

750

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

751

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

752

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

753

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

754

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

755

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

Bu Sun Kim

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

[diff] [blame]

756

{

Bu Sun Kim

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

[diff] [blame]

757

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

758

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

759

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

Bu Sun Kim

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

[diff] [blame]

760

},

761

],

762

},

Bu Sun Kim

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

[diff] [blame]

763

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

764

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

765

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

766

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

767

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

768

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

769

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

770

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

771

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

772

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

773

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

774

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

775

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

776

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

777

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

778

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

779

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

780

{

781

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

782

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

783

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

784

{

785

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

786

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

787

},

788

],

789

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

790

},

791

],

792

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

797

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

Bu Sun Kim

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

[diff] [blame]

798

<pre>Changes the URL map for TargetHttpsProxy.

799

800

Args:

801

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

802

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]

803

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

804

The object takes the form of:

805

806

{

Bu Sun Kim

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

[diff] [blame]

807

"urlMap": "A String",

Bu Sun Kim

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

[diff] [blame]

808

}

809

810

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.

811

812

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.

813

814

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

815

816

Returns:

817

An object of the form:

818

819

{ # Represents an Operation resource.

820

#

Dan O'Meara

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

[diff] [blame]

821

# Google Compute Engine has three Operation resources:

822

#

823

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

824

#

Bu Sun Kim

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

[diff] [blame]

825

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

826

#

827

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

828

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

829

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

830

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

Bu Sun Kim

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

[diff] [blame]

831

#

Dan O'Meara

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

[diff] [blame]

832

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

833

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

834

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

835

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

836

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

837

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

838

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

Jon Wayne Parrott

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

[diff] [blame]

839

{

Bu Sun Kim

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

[diff] [blame]

840

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

841

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

842

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

Jon Wayne Parrott

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

[diff] [blame]

843

},

844

],

845

},

Bu Sun Kim