REST Resource: selection.v1.projects.selectedRoutes

Risorsa: SelectedRoute

Una SelectedRoute rappresenta una route specifica per la quale un cliente vuole recuperare periodicamente informazioni (ad es. la durata) per i casi d'uso contrattuali.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
Campi
name

string

Identificatore. Nome della risorsa SelectedRoute.

Formato: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

Facoltativo. Nome visualizzato della route. Questo è un campo facoltativo che può essere utilizzato dal cliente. Non deve essere univoco.
createTime

string (Timestamp format)

Solo output. Ora in cui è stata creata la route selezionata.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
state

enum (State)

Solo output. Lo stato della route selezionata.
routeAttributes

map (key: string, value: string)

Facoltativo. Gli attributi personalizzati per la route selezionata. L'aggiunta di questi attributi consente di filtrare o raggruppare le route quando si recuperano informazioni sulle route storiche e in tempo reale. Sono supportati fino a 10 attributi per route. Ogni chiave e valore deve essere una stringa non vuota e può contenere fino a 100 caratteri. Le chiavi non devono iniziare con goog.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Campo unione route_type. Al momento è supportata solo DynamicRoute. route_type può essere solo uno dei seguenti:
dynamicRoute

object (DynamicRoute)

La SelectedRoute è una route dinamica.
validationError

enum (ValidationError)

Solo output. L'errore di convalida per la route selezionata quando lo stato è STATE_INVALID.

DynamicRoute

Rappresenta una route con tappe (origine, destinazione e punti intermedi). La route effettiva passa sicuramente per tutte le tappe, ma potrebbe cambiare di volta in volta a causa delle diverse condizioni del traffico.

Rappresentazione JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Campi
origin

object (LatLng)

Obbligatorio. Posizione di origine della route.
destination

object (LatLng)

Obbligatorio. Posizione finale della route.
intermediates[]

object (LatLng)

Facoltativo. Un insieme di tappe intermedie lungo la route (esclusi i punti terminali). Sono sempre punti di passaggio. Sono supportate fino a 25 tappe intermedie. Se aggiunte correttamente, possono ridurre la variazione della route effettiva di volta in volta.

LatLng

Un oggetto che rappresenta una coppia di latitudine/longitudine. Viene espressa come una coppia di numeri a virgola mobile per rappresentare i gradi di latitudine e longitudine. Se non diversamente specificato, questo oggetto deve essere conforme allo standard WGS84. I valori devono rientrare negli intervalli normalizzati.

Rappresentazione JSON 
{
  "latitude": number,
  "longitude": number
}
Campi
latitude

number

La latitudine in gradi. Deve essere compresa nell'intervallo [-90.0, +90.0].
longitude

number

La longitudine in gradi. Deve essere compresa nell'intervallo [-180.0, +180.0].

Stato

Lo stato della route selezionata.

Enum
STATE_UNSPECIFIED Lo stato di questa route non è impostato.
STATE_SCHEDULING La route è stata creata e la pianificazione è in corso.
STATE_RUNNING La route è stata creata e ha una pianificazione attiva.
STATE_DELETING La route è stata contrassegnata per l'eliminazione.
STATE_VALIDATING La route è in fase di convalida.
STATE_INVALID La route non è valida in base a uno dei criteri di convalida.

ValidationError

L'errore di convalida per la route selezionata.

Enum
VALIDATION_ERROR_UNSPECIFIED L'errore di convalida di questa route non è impostato.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION La route non rientra nella giurisdizione del progetto.
VALIDATION_ERROR_LOW_ROAD_USAGE La route ha un basso utilizzo stradale (poche persone la percorrono).

Metodi

batchCreate

 Crea più risorse SelectedRoute e avvia una pianificazione per recuperare periodicamente le informazioni sulla cache per ciascuna delle route.

batchDelete

 Elimina più risorse SelectedRoute per il progetto specificato.

batchUpdate

 Aggiorna più risorse SelectedRoute come specificato dai relativi nomi.

create

 Crea una SelectedRoute e avvia una pianificazione per recuperare periodicamente le informazioni sulla cache per la route.

delete

 Elimina la SelectedRoute specificata per il progetto specificato.

get

 Recupera una SelectedRoute come specificato dal relativo nome.

list

 Elenca tutte le risorse SelectedRoute per il progetto specificato con la paginazione.

patch

 Aggiorna una SelectedRoute come specificato dal relativo nome.