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

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

[diff] [blame]

79

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

80

81

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

82

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

83

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

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

85

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

86

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

87

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

Sai Cheemalapati

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

[diff] [blame]

88

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

Jon Wayne Parrott

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

[diff] [blame]

89

Sai Cheemalapati

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

Jon Wayne Parrott

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

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

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

Jon Wayne Parrott

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

[diff] [blame]

95

Bu Sun Kim

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

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

Jon Wayne Parrott

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

[diff] [blame]

98

99

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

100

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

101

Bu Sun Kim

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

[diff] [blame]

102

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

103

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

104

Bu Sun Kim

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

[diff] [blame]

105

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

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

Jon Wayne Parrott

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

[diff] [blame]

113

Dan O'Meara

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

Dan O'Meara

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

[diff] [blame]

117

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

Sai Cheemalapati

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

[diff] [blame]

118

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

119

Dan O'Meara

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

[diff] [blame]

120

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

Sai Cheemalapati

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

[diff] [blame]

121

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

Jon Wayne Parrott

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

[diff] [blame]

122

<h3>Method Details</h3>

123

Bu Sun Kim

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame]

125

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

126

127

Args:

128

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

Dan O'Meara

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

[diff] [blame]

129

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

Bu Sun Kim

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

[diff] [blame]

130

Dan O'Meara

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

132

Dan O'Meara

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

[diff] [blame]

133

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

Bu Sun Kim

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

[diff] [blame]

134

Bu Sun Kim

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

[diff] [blame]

135

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

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

[diff] [blame]

136

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

Bu Sun Kim

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

[diff] [blame]

137

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

138

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

139

140

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

141

142

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

143

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

yoshi-code-bot

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

[diff] [blame^]

144

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

Bu Sun Kim

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

[diff] [blame]

145

146

Returns:

147

An object of the form:

148

149

{

Yoshi Automation Bot

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

[diff] [blame]

150

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

151

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

152

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

153

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

154

{ # Represents a Target HTTPS Proxy resource.

155

#

156

# Google Compute Engine has two Target HTTPS Proxy resources:

157

#

158

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

159

#

160

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

161

#

162

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

163

#

164

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

165

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

166

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

167

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

168

# Refer to the AuthorizationPolicy resource for additional details.

169

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

170

# Note: This field currently has no impact.

171

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

172

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

173

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

174

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

175

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

176

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

177

"A String",

Bu Sun Kim

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

[diff] [blame]

178

],

Yoshi Automation Bot

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

[diff] [blame]

179

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

180

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

181

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

182

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

183

#

184

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

185

#

186

# The default is false.

187

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

188

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

189

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

190

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

191

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

Yoshi Automation Bot

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

[diff] [blame]

192

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

193

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

194

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

195

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

196

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

197

# If left blank, communications are not encrypted.

198

# Note: This field currently has no impact.

199

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

200

"A String",

201

],

202

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

203

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

204

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

205

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

206

# - global/urlMaps/url-map

Bu Sun Kim

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

[diff] [blame]

207

},

208

],

Yoshi Automation Bot

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

[diff] [blame]

209

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

210

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

211

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

212

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

213

{

214

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

215

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

216

},

217

],

218

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

219

},

Bu Sun Kim

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

[diff] [blame]

220

},

Yoshi Automation Bot

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

[diff] [blame]

221

},

222

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

223

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

224

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

225

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

226

"A String",

227

],

228

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

229

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

230

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

231

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

232

{

233

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

234

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

235

},

236

],

237

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

238

},

239

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

244

<pre>Retrieves the next page of results.

245

246

Args:

247

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

248

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

249

250

Returns:

Bu Sun Kim

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

[diff] [blame]

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

257

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

258

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

262

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

Sai Cheemalapati

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

[diff] [blame]

263

<pre>Deletes the specified TargetHttpsProxy resource.

Jon Wayne Parrott

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

[diff] [blame]

264

265

Args:

Sai Cheemalapati

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

[diff] [blame]

266

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

267

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

Bu Sun Kim

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

[diff] [blame]

268

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

269

270

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

271

272

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

Jon Wayne Parrott

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

[diff] [blame]

273

274

Returns:

275

An object of the form:

276

Bu Sun Kim

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

[diff] [blame]

277

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

278

#

279

# Google Compute Engine has three Operation resources:

280

#

281

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

282

#

283

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

284

#

285

# Operations can be global, regional or zonal.

286

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

287

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

288

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

289

#

290

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

291

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

292

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

293

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

294

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

295

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

296

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

Bu Sun Kim

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

[diff] [blame]

297

{

Yoshi Automation Bot

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

[diff] [blame]

298

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

299

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

300

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

Bu Sun Kim

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

[diff] [blame]

301

},

302

],

Yoshi Automation Bot

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

[diff] [blame]

303

},

304

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

305

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

306

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

307

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

308

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

yoshi-code-bot

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

[diff] [blame^]

309

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

310

#

311

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

312

#

313

# Example 1: Pack and unpack a message in C++.

314

#

315

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

316

#

317

# Example 2: Pack and unpack a message in Java.

318

#

319

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

320

#

321

# Example 3: Pack and unpack a message in Python.

322

#

323

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

324

#

325

# Example 4: Pack and unpack a message in Go

326

#

327

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

328

#

329

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

334

#

335

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

336

#

337

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

338

#

339

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

340

#

341

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

342

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

343

#

344

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

345

#

346

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

347

#

348

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

349

#

350

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

351

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

352

},

Yoshi Automation Bot

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

[diff] [blame]

353

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

yoshi-code-bot

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

[diff] [blame^]

354

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

Yoshi Automation Bot

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

[diff] [blame]

355

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

356

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

357

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

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

{

368

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

369

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

370

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

371

{

372

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

373

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

374

},

375

],

376

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

377

},

378

],

379

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

380

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

384

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

Bu Sun Kim

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

[diff] [blame]

385

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

386

387

Args:

Sai Cheemalapati

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

[diff] [blame]

388

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

389

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

Jon Wayne Parrott

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

[diff] [blame]

390

391

Returns:

392

An object of the form:

393

Dan O'Meara

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

[diff] [blame]

394

{ # Represents a Target HTTPS Proxy resource.

Yoshi Automation Bot

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

[diff] [blame]

395

#

396

# Google Compute Engine has two Target HTTPS Proxy resources:

397

#

398

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

399

#

400

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

401

#

402

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

403

#

404

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

405

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

406

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

407

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

408

# Refer to the AuthorizationPolicy resource for additional details.

409

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

410

# Note: This field currently has no impact.

411

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

412

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

413

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

414

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

415

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

416

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

417

"A String",

418

],

419

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

420

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

421

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

422

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

Bu Sun Kim

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

[diff] [blame]

423

#

Yoshi Automation Bot

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

[diff] [blame]

424

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

Bu Sun Kim

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

[diff] [blame]

425

#

Yoshi Automation Bot

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

[diff] [blame]

426

# The default is false.

427

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

428

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

429

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

430

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

431

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

Yoshi Automation Bot

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

[diff] [blame]

432

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

433

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

434

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

435

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

436

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

437

# If left blank, communications are not encrypted.

438

# Note: This field currently has no impact.

439

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

440

"A String",

441

],

442

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

443

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

444

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

445

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

446

# - global/urlMaps/url-map

447

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

451

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

Sai Cheemalapati

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

[diff] [blame]

452

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

453

454

Args:

Sai Cheemalapati

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

[diff] [blame]

455

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

Dan O'Meara

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

[diff] [blame]

456

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

457

The object takes the form of:

458

Dan O'Meara

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

[diff] [blame]

459

{ # Represents a Target HTTPS Proxy resource.

Bu Sun Kim

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

[diff] [blame]

460

#

461

# Google Compute Engine has two Target HTTPS Proxy resources:

462

#

463

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

464

#

465

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

466

#

467

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

468

#

469

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

470

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

471

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

472

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

473

# Refer to the AuthorizationPolicy resource for additional details.

474

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

475

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

476

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

477

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

478

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

Bu Sun Kim

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

[diff] [blame]

479

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

480

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

481

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

482

"A String",

483

],

Bu Sun Kim

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

[diff] [blame]

484

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

485

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

486

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

Bu Sun Kim

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

[diff] [blame]

487

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

488

#

489

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

490

#

491

# The default is false.

Bu Sun Kim

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

[diff] [blame]

492

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

493

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

494

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

495

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

496

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

Bu Sun Kim

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

[diff] [blame]

497

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

498

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

499

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

500

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

501

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

502

# If left blank, communications are not encrypted.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

503

# Note: This field currently has no impact.

Bu Sun Kim

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

[diff] [blame]

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

}

513

514

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.

515

516

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.

517

518

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

519

520

Returns:

521

An object of the form:

522

523

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

524

#

525

# Google Compute Engine has three Operation resources:

526

#

527

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

528

#

529

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

530

#

531

# Operations can be global, regional or zonal.

532

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

533

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

534

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

535

#

536

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

537

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

538

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

539

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

540

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

541

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

542

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

Bu Sun Kim

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

[diff] [blame]

543

{

Yoshi Automation Bot

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

[diff] [blame]

544

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

545

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

546

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

Bu Sun Kim

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

[diff] [blame]

547

},

Sai Cheemalapati

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

[diff] [blame]

548

],

Yoshi Automation Bot

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

[diff] [blame]

549

},

550

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

551

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

552

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

553

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

554

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

yoshi-code-bot

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

[diff] [blame^]

555

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

556

#

557

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

558

#

559

# Example 1: Pack and unpack a message in C++.

560

#

561

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

562

#

563

# Example 2: Pack and unpack a message in Java.

564

#

565

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

566

#

567

# Example 3: Pack and unpack a message in Python.

568

#

569

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

570

#

571

# Example 4: Pack and unpack a message in Go

572

#

573

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

574

#

575

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

580

#

581

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

582

#

583

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

584

#

585

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

586

#

587

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

588

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

589

#

590

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

591

#

592

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

593

#

594

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

595

#

596

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

597

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

598

},

Yoshi Automation Bot

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

[diff] [blame]

599

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

yoshi-code-bot

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

[diff] [blame^]

600

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

Yoshi Automation Bot

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

[diff] [blame]

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

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

{

614

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

615

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

616

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

617

{

618

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

619

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

620

},

621

],

622

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

623

},

624

],

625

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

626

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

631

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

632

633

Args:

634

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

635

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

636

637

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

638

639

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.

640

641

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

642

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

643

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

644

645

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.

646

647

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

648

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

yoshi-code-bot

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

[diff] [blame^]

649

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

Bu Sun Kim

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

[diff] [blame]

650

651

Returns:

652

An object of the form:

653

654

{ # Contains a list of TargetHttpsProxy resources.

Yoshi Automation Bot

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

[diff] [blame]

655

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

656

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

657

{ # Represents a Target HTTPS Proxy resource.

658

#

659

# Google Compute Engine has two Target HTTPS Proxy resources:

660

#

661

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

662

#

663

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

664

#

665

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

666

#

667

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

668

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

669

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

670

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

671

# Refer to the AuthorizationPolicy resource for additional details.

672

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

673

# Note: This field currently has no impact.

674

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

675

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

676

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

677

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

678

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

679

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

680

"A String",

681

],

682

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

683

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

684

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

685

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

Bu Sun Kim

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

[diff] [blame]

686

#

Yoshi Automation Bot

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

[diff] [blame]

687

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

Bu Sun Kim

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

[diff] [blame]

688

#

Yoshi Automation Bot

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

[diff] [blame]

689

# The default is false.

690

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

691

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

692

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

693

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

694

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

Yoshi Automation Bot

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

[diff] [blame]

695

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

696

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

697

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

698

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

699

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

700

# If left blank, communications are not encrypted.

701

# Note: This field currently has no impact.

702

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

703

"A String",

704

],

705

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

706

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

707

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

708

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

709

# - global/urlMaps/url-map

710

},

711

],

712

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

713

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

714

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

715

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

716

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

717

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

718

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

719

{

720

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

721

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

Bu Sun Kim

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

[diff] [blame]

722

},

723

],

Yoshi Automation Bot

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

[diff] [blame]

724

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

725

},

726

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

731

<pre>Retrieves the next page of results.

732

733

Args:

734

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

735

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

736

737

Returns:

738

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

739

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

744

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

745

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

746

747

Args:

748

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

749

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

750

body: object, The request body.

751

The object takes the form of:

752

753

{ # Represents a Target HTTPS Proxy resource.

754

#

755

# Google Compute Engine has two Target HTTPS Proxy resources:

756

#

757

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

758

#

759

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

760

#

761

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

762

#

763

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

764

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

765

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

766

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

767

# Refer to the AuthorizationPolicy resource for additional details.

768

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

769

# Note: This field currently has no impact.

770

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

771

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

772

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

773

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.

774

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

775

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

776

"A String",

777

],

778

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

779

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

780

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

781

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

782

#

783

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

784

#

785

# The default is false.

786

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

787

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

788

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

789

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

790

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

Bu Sun Kim

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

[diff] [blame]

791

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

792

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

793

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

794

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

795

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

796

# If left blank, communications are not encrypted.

797

# Note: This field currently has no impact.

798

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

799

"A String",

800

],

801

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

802

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

803

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

804

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

805

# - global/urlMaps/url-map

806

}

807

808

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.

809

810

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.

811

812

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

813

814

Returns:

815

An object of the form:

816

817

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

818

#

819

# Google Compute Engine has three Operation resources:

820

#

821

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

822

#

823

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

824

#

825

# Operations can be global, regional or zonal.

826

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

827

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

828

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

829

#

830

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

831

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

832

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

833

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

834

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

835

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

836

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

Bu Sun Kim

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

[diff] [blame]

837

{

Yoshi Automation Bot

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

[diff] [blame]

838

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

839

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

840

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

Bu Sun Kim

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

[diff] [blame]

841

},

842

],

Yoshi Automation Bot

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

[diff] [blame]

843

},

844

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

845

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

846

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

847

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

848

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

yoshi-code-bot

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

[diff] [blame^]

849

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

850

#

851

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

852

#

853

# Example 1: Pack and unpack a message in C++.

854

#

855

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

856

#

857

# Example 2: Pack and unpack a message in Java.

858

#

859

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

860

#

861

# Example 3: Pack and unpack a message in Python.

862

#

863

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

864

#

865

# Example 4: Pack and unpack a message in Go

866

#

867

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

868

#

869

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

874

#

875

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

876

#

877

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

878

#

879

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

880

#

881

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

882

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

883

#

884

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

885

#

886

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

887

#

888

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

889

#

890

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

891

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

892

},

Yoshi Automation Bot

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

[diff] [blame]

893

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

yoshi-code-bot

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

[diff] [blame^]

894

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

Yoshi Automation Bot

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

[diff] [blame]

895

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

896

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

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

{

908

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

909

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

910

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

911

{

912

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

913

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

914

},

915

],

916

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

917

},

918

],

919

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

920

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

924

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

925

<pre>Changes the Certificate Map for TargetHttpsProxy.

926

927

Args:

928

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

929

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)

930

body: object, The request body.

931

The object takes the form of:

932

933

{

Yoshi Automation Bot

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

[diff] [blame]

934

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

935

}

Jon Wayne Parrott

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

[diff] [blame]

936

Bu Sun Kim

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

[diff] [blame]

937

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.

938

939

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.

940

941

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]

942

943

Returns:

944

An object of the form:

945

Bu Sun Kim

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

[diff] [blame]

946

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

947

#

948

# Google Compute Engine has three Operation resources:

949

#

950

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

951

#

952

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

953

#

954

# Operations can be global, regional or zonal.

955

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

956

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

957

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

958

#

959

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

960

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

961

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

962

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

963

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

964

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

965

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

Jon Wayne Parrott

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

[diff] [blame]

966

{

Yoshi Automation Bot

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

[diff] [blame]

967

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

968

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

969

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

Jon Wayne Parrott

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

[diff] [blame]

970

},

971

],

Yoshi Automation Bot

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

[diff] [blame]

972

},

973

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

974

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

975

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

976

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

977

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

yoshi-code-bot

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

[diff] [blame^]

978

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

979

#

980

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

981

#

982

# Example 1: Pack and unpack a message in C++.

983

#

984

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

985

#

986

# Example 2: Pack and unpack a message in Java.

987

#

988

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

989

#

990

# Example 3: Pack and unpack a message in Python.

991

#

992

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

993

#

994

# Example 4: Pack and unpack a message in Go

995

#

996

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

997

#

998

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1003

#

1004

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1005

#

1006

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1007

#

1008

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1009

#

1010

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1011

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1012

#

1013

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1014

#

1015

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1016

#

1017

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1018

#

1019

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1020

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1021

},

Yoshi Automation Bot

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

[diff] [blame]

1022

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

yoshi-code-bot

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

[diff] [blame^]

1023

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

Yoshi Automation Bot

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

[diff] [blame]

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

{

1037

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

1038

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

1039

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

1040

{

1041

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

1042

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

1043

},

1044

],

1045

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

1046

},

1047

],

1048

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

1049

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

1053

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

1054

<pre>Sets the QUIC override policy for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

1055

1056

Args:

Sai Cheemalapati

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

[diff] [blame]

1057

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

Bu Sun Kim

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

[diff] [blame]

1058

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]

1059

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

1060

The object takes the form of:

1061

Sai Cheemalapati

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

[diff] [blame]

1062

{

Yoshi Automation Bot

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

[diff] [blame]

1063

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

1064

}

Jon Wayne Parrott

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

[diff] [blame]

1065

Bu Sun Kim

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

[diff] [blame]

1066

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.

1067

1068

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.

1069

1070

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]

1071

1072

Returns:

1073

An object of the form:

1074

Bu Sun Kim

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

[diff] [blame]

1075

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1076

#

1077

# Google Compute Engine has three Operation resources:

1078

#

1079

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

1080

#

1081

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

1082

#

1083

# Operations can be global, regional or zonal.

1084

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

1085

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

1086

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

1087

#

1088

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

1089

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

1090

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

1091

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

1092

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

1093

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

1094

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

Bu Sun Kim

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

[diff] [blame]

1095

{

Yoshi Automation Bot

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

[diff] [blame]

1096

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

1097

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

1098

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

Bu Sun Kim

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

[diff] [blame]

1099

},

1100

],

Yoshi Automation Bot

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

[diff] [blame]

1101

},

1102

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

1103

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

1104

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

1105

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

1106

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

yoshi-code-bot

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

[diff] [blame^]

1107

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1108

#

1109

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1110

#

1111

# Example 1: Pack and unpack a message in C++.

1112

#

1113

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1114

#

1115

# Example 2: Pack and unpack a message in Java.

1116

#

1117

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1118

#

1119

# Example 3: Pack and unpack a message in Python.

1120

#

1121

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1122

#

1123

# Example 4: Pack and unpack a message in Go

1124

#

1125

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1126

#

1127

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1132

#

1133

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1134

#

1135

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1136

#

1137

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1138

#

1139

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1140

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1141

#

1142

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1143

#

1144

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1145

#

1146

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1147

#

1148

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1149

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1150

},

Yoshi Automation Bot

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

[diff] [blame]

1151

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

yoshi-code-bot

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

[diff] [blame^]

1152

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

Yoshi Automation Bot

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

[diff] [blame]

1153

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

1154

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

1155

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

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

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

1165

{

1166

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

1167

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

1168

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

1169

{

1170

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

1171

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

1172

},

1173

],

1174

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

1175

},

1176

],

1177

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

1178

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1182

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

1183

<pre>Replaces SslCertificates for TargetHttpsProxy.

1184

1185

Args:

1186

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

1187

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]

1188

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1189

The object takes the form of:

1190

1191

{

Yoshi Automation Bot

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

[diff] [blame]

1192

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

1193

"A String",

1194

],

1195

}

Bu Sun Kim

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

[diff] [blame]

1196

1197

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.

1198

1199

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.

1200

1201

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

1202

1203

Returns:

1204

An object of the form:

1205

1206

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1207

#

1208

# Google Compute Engine has three Operation resources:

1209

#

1210

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

1211

#

1212

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

1213

#

1214

# Operations can be global, regional or zonal.

1215

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

1216

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

1217

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

1218

#

1219

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

1220

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

1221

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

1222

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

1223

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

1224

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

1225

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

Bu Sun Kim

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

[diff] [blame]

1226

{

Yoshi Automation Bot

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

[diff] [blame]

1227

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

1228

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

1229

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

Bu Sun Kim

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

[diff] [blame]

1230

},

1231

],

Yoshi Automation Bot

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

[diff] [blame]

1232

},

1233

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

1234

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

1235

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

1236

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

1237

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

yoshi-code-bot

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

[diff] [blame^]

1238

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1239

#

1240

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1241

#

1242

# Example 1: Pack and unpack a message in C++.

1243

#

1244

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1245

#

1246

# Example 2: Pack and unpack a message in Java.

1247

#

1248

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1249

#

1250

# Example 3: Pack and unpack a message in Python.

1251

#

1252

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1253

#

1254

# Example 4: Pack and unpack a message in Go

1255

#

1256

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1257

#

1258

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1263

#

1264

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1265

#

1266

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1267

#

1268

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1269

#

1270

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1271

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1272

#

1273

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1274

#

1275

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1276

#

1277

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1278

#

1279

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1280

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1281

},

Yoshi Automation Bot

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

[diff] [blame]

1282

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

yoshi-code-bot

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

[diff] [blame^]

1283

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

Yoshi Automation Bot

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

[diff] [blame]

1284

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

1285

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

1286

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

1287

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

1288

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

1289

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

1290

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

1291

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

1292

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

1293

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

1294

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

1295

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

1296

{

1297

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

1298

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

1299

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

1300

{

1301

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

1302

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

1303

},

1304

],

1305

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

1306

},

1307

],

1308

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

1309

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1313

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

1314

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

1315

1316

Args:

1317

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

1318

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]

1319

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1320

The object takes the form of:

1321

1322

{

Yoshi Automation Bot

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

[diff] [blame]

1323

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

1324

}

Bu Sun Kim

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

[diff] [blame]

1325

1326

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.

1327

1328

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.

1329

1330

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

1331

1332

Returns:

1333

An object of the form:

1334

1335

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1336

#

1337

# Google Compute Engine has three Operation resources:

1338

#

1339

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

1340

#

1341

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

1342

#

1343

# Operations can be global, regional or zonal.

1344

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

1345

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

1346

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

1347

#

1348

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

1349

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

1350

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

1351

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

1352

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

1353

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

1354

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

Bu Sun Kim

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

[diff] [blame]

1355

{

Yoshi Automation Bot

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

[diff] [blame]

1356

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

1357

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

1358

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

Bu Sun Kim

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

[diff] [blame]

1359

},

1360

],

Yoshi Automation Bot

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

[diff] [blame]

1361

},

1362

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

1363

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

1364

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

1365

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

1366

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

yoshi-code-bot

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

[diff] [blame^]

1367

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1368

#

1369

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1370

#

1371

# Example 1: Pack and unpack a message in C++.

1372

#

1373

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1374

#

1375

# Example 2: Pack and unpack a message in Java.

1376

#

1377

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1378

#

1379

# Example 3: Pack and unpack a message in Python.

1380

#

1381

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1382

#

1383

# Example 4: Pack and unpack a message in Go

1384

#

1385

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1386

#

1387

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1392

#

1393

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1394

#

1395

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1396

#

1397

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1398

#

1399

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1400

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1401

#

1402

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1403

#

1404

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1405

#

1406

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1407

#

1408

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1409

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1410

},

Yoshi Automation Bot

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

[diff] [blame]

1411

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

yoshi-code-bot

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

[diff] [blame^]

1412

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

Yoshi Automation Bot

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

[diff] [blame]

1413

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

1414

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

1415

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

1416

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

1417

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

1418

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

1419

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

1420

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

1421

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

1422

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

1423

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

1424

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

1425

{

1426

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

1427

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

1428

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

1429

{

1430

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

1431

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

1432

},

1433

],

1434

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

1435

},

1436

],

1437

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

1438

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

1442

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

Sai Cheemalapati

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

[diff] [blame]

1443

<pre>Changes the URL map for TargetHttpsProxy.

Jon Wayne Parrott

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

[diff] [blame]

1444

1445

Args:

Sai Cheemalapati

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

[diff] [blame]

1446

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

1447

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]

1448

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

1449

The object takes the form of:

1450

Sai Cheemalapati

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

[diff] [blame]

1451

{

Yoshi Automation Bot

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

[diff] [blame]

1452

"urlMap": "A String",

1453

}

Jon Wayne Parrott

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

[diff] [blame]

1454

Bu Sun Kim

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

[diff] [blame]

1455

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.

1456

1457

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.

1458

1459

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]

1460

1461

Returns:

1462

An object of the form:

1463

Bu Sun Kim

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

[diff] [blame]

1464

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1465

#

1466

# Google Compute Engine has three Operation resources:

1467

#

1468

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

1469

#

1470

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

1471

#

1472

# Operations can be global, regional or zonal.

1473

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

1474

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

1475

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

1476

#

1477

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

1478

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

1479

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

1480

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

1481

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

1482

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

1483

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

Bu Sun Kim

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

[diff] [blame]

1484

{

Yoshi Automation Bot

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

[diff] [blame]

1485

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

1486

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

1487

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

Bu Sun Kim

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

[diff] [blame]

1488

},

1489

],

Yoshi Automation Bot

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

[diff] [blame]

1490

},

1491

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

1492

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

1493

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

1494

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

1495

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

yoshi-code-bot

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

[diff] [blame^]

1496

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1497

#

1498

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1499

#

1500

# Example 1: Pack and unpack a message in C++.

1501

#

1502

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1503

#

1504

# Example 2: Pack and unpack a message in Java.

1505

#

1506

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1507

#

1508

# Example 3: Pack and unpack a message in Python.

1509

#

1510

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1511

#

1512

# Example 4: Pack and unpack a message in Go

1513

#

1514

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1515

#

1516

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1521

#

1522

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1523

#

1524

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1525

#

1526

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1527

#

1528

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1529

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1530

#

1531

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1532

#

1533

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1534

#

1535

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1536

#

1537

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1538

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1539

},

Yoshi Automation Bot

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

[diff] [blame]

1540

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1541

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot