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

<p class="firstline">Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.</p>

98

<h3>Method Details</h3>

99

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

100

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

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

105

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

106

<pre>Deletes the specified TargetGrpcProxy in the given scope

107

108

Args:

109

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

110

targetGrpcProxy: string, Name of the TargetGrpcProxy resource to delete. (required)

111

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.

112

113

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.

114

115

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

116

117

Returns:

118

An object of the form:

119

120

{ # Represents an Operation resource.

121

#

122

# Google Compute Engine has three Operation resources:

123

#

124

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

125

#

126

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

127

#

128

# Operations can be global, regional or zonal.

129

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

130

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

131

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

132

#

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

{

141

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

142

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

143

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

},

],

},

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

{

165

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

166

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

167

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

168

{

169

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

170

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

171

},

172

],

173

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

174

},

175

],

176

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

}</pre>

</div>

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

182

<pre>Returns the specified TargetGrpcProxy resource in the given scope.

183

184

Args:

185

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

186

targetGrpcProxy: string, Name of the TargetGrpcProxy resource to return. (required)

187

188

Returns:

189

An object of the form:

190

191

{ # Represents a Target gRPC Proxy resource.

192

#

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

193

# A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Global forwarding rules reference a target gRPC proxy. The Target gRPC Proxy references a URL map which specifies how traffic routes to gRPC backend services. (== resource_for {$api_version}.targetGrpcProxies ==)

Bu Sun Kim

d059ad8

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

[diff] [blame]

194

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

195

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

196

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

197

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

198

"kind": "compute#targetGrpcProxy", # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

199

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

200

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

201

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

202

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

203

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

Bu Sun Kim

d059ad8

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

[diff] [blame]

}</pre>

</div>

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

209

<pre>Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.

210

211

Args:

212

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

213

body: object, The request body.

214

The object takes the form of:

215

216

{ # Represents a Target gRPC Proxy resource.

217

#

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

218

# A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Global forwarding rules reference a target gRPC proxy. The Target gRPC Proxy references a URL map which specifies how traffic routes to gRPC backend services. (== resource_for {$api_version}.targetGrpcProxies ==)

Bu Sun Kim

d059ad8

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

[diff] [blame]

219

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

220

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

221

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

222

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

223

"kind": "compute#targetGrpcProxy", # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

224

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

225

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

226

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

227

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

228

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

Bu Sun Kim

d059ad8

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

[diff] [blame]

229

}

230

231

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.

232

233

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.

234

235

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

236

237

Returns:

238

An object of the form:

239

240

{ # Represents an Operation resource.

241

#

242

# Google Compute Engine has three Operation resources:

243

#

244

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

245

#

246

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

247

#

248

# Operations can be global, regional or zonal.

249

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

250

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

251

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

252

#

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

{

261

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

262

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

263

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

},

],

},

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

{

285

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

286

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

287

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

288

{

289

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

290

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

291

},

292

],

293

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

294

},

295

],

296

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

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

301

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

302

<pre>Lists the TargetGrpcProxies for a project in the given scope.

303

304

Args:

305

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

306

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

307

308

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

309

310

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.

311

312

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

313

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

314

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

315

316

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.

317

318

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

319

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

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

320

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

321

322

Returns:

323

An object of the form:

324

325

{

326

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

327

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

328

{ # Represents a Target gRPC Proxy resource.

329

#

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

330

# A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Global forwarding rules reference a target gRPC proxy. The Target gRPC Proxy references a URL map which specifies how traffic routes to gRPC backend services. (== resource_for {$api_version}.targetGrpcProxies ==)

Bu Sun Kim

d059ad8

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

[diff] [blame]

331

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

332

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

333

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

334

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

335

"kind": "compute#targetGrpcProxy", # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

336

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

337

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

338

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

339

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

340

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

Bu Sun Kim

d059ad8

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

[diff] [blame]

341

},

342

],

343

"kind": "compute#targetGrpcProxyList", # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

344

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

345

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

346

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

347

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

348

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

349

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

350

{

351

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

352

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

353

},

354

],

355

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

},

}</pre>

</div>

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

362

<pre>Retrieves the next page of results.

363

364

Args:

365

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

366

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

367

368

Returns:

369

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

370

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

</pre>

</div>

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

376

<pre>Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

377

378

Args:

379

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

380

targetGrpcProxy: string, Name of the TargetGrpcProxy resource to patch. (required)

381

body: object, The request body.

382

The object takes the form of:

383

384

{ # Represents a Target gRPC Proxy resource.

385

#

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

386

# A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Global forwarding rules reference a target gRPC proxy. The Target gRPC Proxy references a URL map which specifies how traffic routes to gRPC backend services. (== resource_for {$api_version}.targetGrpcProxies ==)

Bu Sun Kim

d059ad8

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

[diff] [blame]

387

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

388

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

389

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

390

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

391

"kind": "compute#targetGrpcProxy", # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

392

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

393

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

394

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

395

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

Dmitry Frenkel

3e17f89

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

[diff] [blame^]

396

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

Bu Sun Kim

d059ad8

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

[diff] [blame]

397

}

398

399

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.

400

401

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.

402

403

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

404

405

Returns:

406

An object of the form:

407

408

{ # Represents an Operation resource.

409

#

410

# Google Compute Engine has three Operation resources:

411

#

412

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

413

#

414

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

415

#

416

# Operations can be global, regional or zonal.

417

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

418

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

419

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

420

#

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

{

429

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

430

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

431

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

},

],

},

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

{

453

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

454

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

455

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

456

{

457

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

458

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

459

},

460

],

461

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

462

},

463

],