Virtual Private Cloud API, gRPC: GatewayService.Update
Updates the specified gateway.
gRPC request
rpc Update (UpdateGatewayRequest) returns (operation.Operation)
UpdateGatewayRequest
{
"gatewayId": "string",
"updateMask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"labels": "string",
// Includes only one of the fields `sharedEgressGatewaySpec`
"sharedEgressGatewaySpec": "SharedEgressGatewaySpec"
// end of the list of possible fields
}
Field |
Description |
gatewayId |
string Required field. ID of the gateway to update. To get the gateway ID make a GatewayService.List request. |
updateMask |
Field mask that specifies which attributes of the Gateway should be updated. |
name |
string New name for the gateway. |
description |
string New description of the gateway. |
labels |
string Gateway labels as Existing set of labels is completely replaced by the provided set, so if you just want
|
sharedEgressGatewaySpec |
Includes only one of the fields New Gateway configuration specification |
SharedEgressGatewaySpec
Field |
Description |
Empty |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"gatewayId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
// Includes only one of the fields `sharedEgressGateway`
"sharedEgressGateway": "SharedEgressGateway"
// end of the list of possible fields
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateGatewayMetadata
Field |
Description |
gatewayId |
string ID of the Gateway that is being updated. |
Gateway
A Gateway resource. For more information, see Gateway.
Field |
Description |
id |
string ID of the gateway. Generated at creation time. |
folderId |
string ID of the folder that the gateway belongs to. |
createdAt |
Creation timestamp. |
name |
string Name of the gateway. |
description |
string Description of the gateway. 0-256 characters long. |
labels |
string Gateway labels as |
sharedEgressGateway |
Includes only one of the fields Gateway specification |
SharedEgressGateway
Shared Egress Gateway configuration
Field |
Description |
Empty |