routes

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

Overview

Name	routes
Type	Resource
Id	google.datastream.routes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
createTime	string (google-datetime)	Output only. The create time of the resource.
destinationAddress	string	Required. Destination address for connection
destinationPort	integer (int32)	Destination port for connection
displayName	string	Required. Display name.
labels	object	Labels.
updateTime	string (google-datetime)	Output only. The update time of the resource.

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
createTime	string (google-datetime)	Output only. The create time of the resource.
destinationAddress	string	Required. Destination address for connection
destinationPort	integer (int32)	Destination port for connection
displayName	string	Required. Display name.
labels	object	Labels.
updateTime	string (google-datetime)	Output only. The update time of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateConnectionsId, routesId		Use this method to get details about a route.
list	select	projectsId, locationsId, privateConnectionsId	pageSize, pageToken, filter, orderBy	Use this method to list routes created for a private connectivity configuration in a project and location.
create	insert	projectsId, locationsId, privateConnectionsId	routeId, requestId	Use this method to create a route for a private connectivity configuration in a project and location.
delete	delete	projectsId, locationsId, privateConnectionsId, routesId	requestId	Use this method to delete a route.

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
locationsId	string
privateConnectionsId	string
projectsId	string
routesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
routeId	string

SELECT examples

get

Use this method to get details about a route.

SELECT
name,
createTime,
destinationAddress,
destinationPort,
displayName,
labels,
updateTime
FROM google.datastream.routes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateConnectionsId = '{{ privateConnectionsId }}' -- required
AND routesId = '{{ routesId }}' -- required;

list

Use this method to list routes created for a private connectivity configuration in a project and location.

SELECT
name,
createTime,
destinationAddress,
destinationPort,
displayName,
labels,
updateTime
FROM google.datastream.routes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateConnectionsId = '{{ privateConnectionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Use this method to create a route for a private connectivity configuration in a project and location.

INSERT INTO google.datastream.routes (
data__labels,
data__displayName,
data__destinationAddress,
data__destinationPort,
projectsId,
locationsId,
privateConnectionsId,
routeId,
requestId
)
SELECT 
'{{ labels }}',
'{{ displayName }}',
'{{ destinationAddress }}',
{{ destinationPort }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateConnectionsId }}',
'{{ routeId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: routes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the routes resource.
    - name: locationsId
      value: string
      description: Required parameter for the routes resource.
    - name: privateConnectionsId
      value: string
      description: Required parameter for the routes resource.
    - name: labels
      value: object
      description: >
        Labels.
        
    - name: displayName
      value: string
      description: >
        Required. Display name.
        
    - name: destinationAddress
      value: string
      description: >
        Required. Destination address for connection
        
    - name: destinationPort
      value: integer
      description: >
        Destination port for connection
        
    - name: routeId
      value: string
    - name: requestId
      value: string

DELETE examples

delete

Use this method to delete a route.

DELETE FROM google.datastream.routes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateConnectionsId = '{{ privateConnectionsId }}' --required
AND routesId = '{{ routesId }}' --required
AND requestId = '{{ requestId }}';