REST Resource: projects.locations.spokes.gatewayAdvertisedRoutes

Resource: GatewayAdvertisedRoute

A gateway advertised route is a route that a gateway spoke advertises somewhere.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "uniqueId": string,
  "state": enum (State),
  "ipRange": string,
  "recipient": enum (Recipient),
  "priority": integer
}
Fields
name

string

Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{projectNumber}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gatewayAdvertisedRouteId}

createTime

string (Timestamp format)

Output only. The time the gateway advertised route was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time the gateway advertised route was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

An optional description of the gateway advertised route.

uniqueId

string

Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.

state

enum (State)

Output only. The current lifecycle state of this gateway advertised route.

ipRange

string

Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

recipient

enum (Recipient)

Optional. The recipient of this advertised route.

priority

integer

Optional. The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

Recipient

The recipient of an advertised route.

Enums
RECIPIENT_UNSPECIFIED No recipient specified. By default routes are advertised to the hub.
ADVERTISE_TO_HUB Advertises a route toward the hub. Other spokes reachable from this spoke will receive the route.

Methods

create

Create a GatewayAdvertisedRoute

delete

Delete a GatewayAdvertisedRoute

get

Get a GatewayAdvertisedRoute

list

List GatewayAdvertisedRoutes

patch

Update a GatewayAdvertisedRoute