Package google.maps.roads.selection.v1

Index

RoadsSelection

Service definition for the Roads Selection API.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

Creates multiple SelectedRoutes and starts a schedule to periodically retrieve cache information for each of the routes.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

Creates a SelectedRoute and starts a schedule to periodically retrieve cache information for the route.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

Deletes the specified SelectedRoute for the specified project.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

Gets a SelectedRoute as specified by its name.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

Lists all SelectedRoutes for the specified project with pagination.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

Request to create multiple SelectedRoutes.

Fields
parent

string

Optional. The project resource shared by all selected routes. Format: projects/{project} If this is set, the parent field in the CreateSelectedRouteRequest messages must either be empty or match this field.
requests[]

CreateSelectedRouteRequest

Required. The request message specifying the selected route to create. A maximum of 1000 selected routes can be created in a batch.

BatchCreateSelectedRoutesResponse

Response from creating multiple SelectedRoutes.

Fields
selected_routes[]

SelectedRoute

SelectedRoutes created.

CreateSelectedRouteRequest

Request to create a SelectedRoute.

Fields
parent

string

Required. The project that the SelectedRoute will be created under. Format: projects/{project}
selected_route

SelectedRoute

Required. The SelectedRoute to create.
selected_route_id

string

Optional. The ID to use for the SelectedRoute, which will become the final component of the SelectedRoute's resource name.

This value should be 4-63 characters, and valid characters are: "a-z", "A-Z", "0-9" or "-". If it is not provided or empty, a UUID will be generated after resource creation.

DeleteSelectedRouteRequest

Request to delete a SelectedRoute.

Fields
name

string

Required. The name of the SelectedRoute to delete. Format: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Request to get a SelectedRoute.

Fields
name

string

Required. The name of the SelectedRoute to retrieve. Format: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Request to list SelectedRoutes.

Fields
parent

string

Required. The parent, which is the project that all SelectedRoutes will be queried from. Format: projects/{project}/selectedRoutes
page_size

int32

Optional. The number of results that should be returned for a given page. If not set the default value is 100. When a value of 0 is given the value will be set to the default. The max value is 5000, any value above 5000 will be set to 5000.
page_token

string

Optional. A page token, received from a previous ListSelectedRoutes call.

ListSelectedRoutesResponse

Response that lists SelectedRoutes.

Fields
selected_routes[]

SelectedRoute

A page of SelectedRoutes stored in the project specified in the request.
next_page_token

string

Token that can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

SelectedRoute

A SelectedRoute represents a specific route that a customer wants to periodically retrieve information (e.g. duration) for contracted use cases.

Fields
name

string

Identifier. Resource name of the SelectedRoute.

Format: projects/{project}/selectedRoutes/{selected_route}
display_name

string

Optional. Display name of the route. This is an optional field that can be used by the customer. It does not have to be unique.
create_time

Timestamp

Output only. Time when the selected route was first created.
state

State

Output only. The state of the selected route.
route_attributes

map<string, string>

Optional. The custom attributes for the selected route. Adding them allows filtering / grouping of the routes when retrieving historical and real-time routes information. Up to 10 attributes are supported per route. Each key and value should be a non empty string and can have up to 100 characters. The keys must not start with "goog".
Union field route_type. Currently only DynamicRoute is supported. route_type can be only one of the following:
dynamic_route

DynamicRoute

The SelectedRoute is a dynamic route.
validation_error

ValidationError

Output only. The validation error for the selected route when the state is STATE_INVALID.

DynamicRoute

This represents a route with waypoints (origin, destination and intermediates). The actual route is guaranteed to pass all the waypoints, but it could change from time to time due to varying traffic condition.

Fields
origin

LatLng

Required. Origin location of the route.
destination

LatLng

Required. Ending location of the route.
intermediates[]

LatLng

Optional. A set of intermediate waypoints along the route (excluding terminal points). They are always passing-by points. Up to 25 intermediate waypoints are supported. Adding them properly can reduce the variation of actual route from time to time.

State

The state of the selected route.

Enums
STATE_UNSPECIFIED The state of this route is not set.
STATE_SCHEDULING The route has been created and is being scheduled.
STATE_RUNNING The route has been created and has an active schedule.
STATE_DELETING The route has been marked for deletion.
STATE_VALIDATING The route is in the process of being validated.
STATE_INVALID The route is invalid based on one of the validation criteria.

ValidationError

The validation error for the selected route.

Enums
VALIDATION_ERROR_UNSPECIFIED The validation error of this route is not set.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION The route is outside the jurisdiction of the project.
VALIDATION_ERROR_LOW_ROAD_USAGE The route has low road usage (very few people pass through it).