gateway_advertised_routes

Creates, updates, deletes, gets or lists a gateway_advertised_routes resource.

Overview

Name	gateway_advertised_routes
Type	Resource
Id	google.networkconnectivity.gateway_advertised_routes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}
createTime	string (google-datetime)	Output only. The time the gateway advertised route was created.
description	string	An optional description of the 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.
labels	object	Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
priority	integer (int32)	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	string	Optional. The recipient of this advertised route. (RECIPIENT_UNSPECIFIED, ADVERTISE_TO_HUB)
state	string	Output only. The current lifecycle state of this gateway advertised route. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, ACCEPTING, REJECTING, UPDATING, INACTIVE, OBSOLETE, FAILED)
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 unique_id.
updateTime	string (google-datetime)	Output only. The time the gateway advertised route was last updated.

list

Name	Datatype	Description
name	string	Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}
createTime	string (google-datetime)	Output only. The time the gateway advertised route was created.
description	string	An optional description of the 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.
labels	object	Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
priority	integer (int32)	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	string	Optional. The recipient of this advertised route. (RECIPIENT_UNSPECIFIED, ADVERTISE_TO_HUB)
state	string	Output only. The current lifecycle state of this gateway advertised route. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, ACCEPTING, REJECTING, UPDATING, INACTIVE, OBSOLETE, FAILED)
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 unique_id.
updateTime	string (google-datetime)	Output only. The time the gateway advertised route was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, spokesId, gatewayAdvertisedRoutesId		Get a GatewayAdvertisedRoute
list	select	projectsId, locationsId, spokesId	orderBy, pageToken, filter, pageSize	List GatewayAdvertisedRoutes
create	insert	projectsId, locationsId, spokesId	gatewayAdvertisedRouteId, requestId	Create a GatewayAdvertisedRoute
patch	update	projectsId, locationsId, spokesId, gatewayAdvertisedRoutesId	updateMask, requestId	Update a GatewayAdvertisedRoute
delete	delete	projectsId, locationsId, spokesId, gatewayAdvertisedRoutesId	requestId	Delete a GatewayAdvertisedRoute

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
gatewayAdvertisedRoutesId	string
locationsId	string
projectsId	string
spokesId	string
filter	string
gatewayAdvertisedRouteId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get a GatewayAdvertisedRoute

SELECT
name,
createTime,
description,
ipRange,
labels,
priority,
recipient,
state,
uniqueId,
updateTime
FROM google.networkconnectivity.gateway_advertised_routes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND spokesId = '{{ spokesId }}' -- required
AND gatewayAdvertisedRoutesId = '{{ gatewayAdvertisedRoutesId }}' -- required
;

list

List GatewayAdvertisedRoutes

SELECT
name,
createTime,
description,
ipRange,
labels,
priority,
recipient,
state,
uniqueId,
updateTime
FROM google.networkconnectivity.gateway_advertised_routes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND spokesId = '{{ spokesId }}' -- required
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Create a GatewayAdvertisedRoute

INSERT INTO google.networkconnectivity.gateway_advertised_routes (
data__labels,
data__priority,
data__description,
data__ipRange,
data__recipient,
data__name,
projectsId,
locationsId,
spokesId,
gatewayAdvertisedRouteId,
requestId
)
SELECT 
'{{ labels }}',
{{ priority }},
'{{ description }}',
'{{ ipRange }}',
'{{ recipient }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ spokesId }}',
'{{ gatewayAdvertisedRouteId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: gateway_advertised_routes
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the gateway_advertised_routes resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the gateway_advertised_routes resource.
  - name: spokesId
    value: "{{ spokesId }}"
    description: Required parameter for the gateway_advertised_routes resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
  - name: priority
    value: {{ priority }}
    description: |
      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.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of the gateway advertised route.
  - name: ipRange
    value: "{{ ipRange }}"
    description: |
      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`.
  - name: recipient
    value: "{{ recipient }}"
    description: |
      Optional. The recipient of this advertised route.
    valid_values: ['RECIPIENT_UNSPECIFIED', 'ADVERTISE_TO_HUB']
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}`
  - name: gatewayAdvertisedRouteId
    value: "{{ gatewayAdvertisedRouteId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Update a GatewayAdvertisedRoute

UPDATE google.networkconnectivity.gateway_advertised_routes
SET 
data__labels = '{{ labels }}',
data__priority = {{ priority }},
data__description = '{{ description }}',
data__ipRange = '{{ ipRange }}',
data__recipient = '{{ recipient }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND spokesId = '{{ spokesId }}' --required
AND gatewayAdvertisedRoutesId = '{{ gatewayAdvertisedRoutesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete a GatewayAdvertisedRoute

DELETE FROM google.networkconnectivity.gateway_advertised_routes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND spokesId = '{{ spokesId }}' --required
AND gatewayAdvertisedRoutesId = '{{ gatewayAdvertisedRoutesId }}' --required
AND requestId = '{{ requestId }}'
;