Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Virtual Private Cloud API, gRPC: GatewayService.Update

Written by
Updated at December 17, 2024

Updates the specified gateway.

gRPC request

rpc Update (UpdateGatewayRequest) returns (operation.Operation)

UpdateGatewayRequest

{
  "gateway_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  // Includes only one of the fields `shared_egress_gateway_spec`
  "shared_egress_gateway_spec": "SharedEgressGatewaySpec"
  // end of the list of possible fields
}

Field

Description

gateway_id

string

Required field. ID of the gateway to update.

To get the gateway ID make a GatewayService.List request.

update_mask

google.protobuf.FieldMask

Field mask that specifies which attributes of the Gateway should be updated.

name

string

New name for the gateway.
The name must be unique within the folder.

description

string

New description of the gateway.

labels

object (map<string, string>)

Gateway labels as key:value pairs.

Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label:

  1. Get the current set of labels with a GatewayService.Get request.
  2. Add or remove a label in this set.
  3. Send the new set in this field.

shared_egress_gateway_spec

SharedEgressGatewaySpec

Includes only one of the fields shared_egress_gateway_spec.

New Gateway configuration specification

SharedEgressGatewaySpec

Field

Description

Empty

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "gateway_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    // Includes only one of the fields `shared_egress_gateway`
    "shared_egress_gateway": "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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateGatewayMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Gateway

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateGatewayMetadata

Field

Description

gateway_id

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.

folder_id

string

ID of the folder that the gateway belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the gateway.
The name is unique within the folder.
Value must match the regular expression \\|[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description

string

Description of the gateway. 0-256 characters long.

labels

object (map<string, string>)

Gateway labels as key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_./\\@0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.

shared_egress_gateway

SharedEgressGateway

Includes only one of the fields shared_egress_gateway.

Gateway specification

SharedEgressGateway

Shared Egress Gateway configuration

Field

Description

Empty
Previous
Create
Next
Delete