REST Resource: selection.v1.projects.selectedRoutes

Risorsa: SelectedRoute

Un oggetto SelectedRoute rappresenta un percorso specifico per il 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,
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a request:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError)
}
Campi
name

string

Identificatore. Nome risorsa di SelectedRoute.

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

string

Facoltativo. Nome visualizzato dell'itinerario. Questo è un campo facoltativo che può essere utilizzato dal cliente. Non deve essere univoco. La lunghezza è limitata a 100 caratteri (conteggiati in punti di codice Unicode).
createTime

string (Timestamp format)

Solo output. Ora in cui è stato creato per la prima volta l'itinerario selezionato.

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 dell'itinerario selezionato.
routeAttributes

map (key: string, value: string)

Facoltativo. Gli attributi personalizzati per la route selezionata. L'aggiunta consente di filtrare o raggruppare i percorsi durante il recupero delle informazioni storiche e in tempo reale. Sono supportati fino a 25 attributi per percorso. Ogni chiave e valore deve essere una stringa non vuota e può contenere fino a 100 caratteri (conteggiati in punti di codice Unicode). Le chiavi non devono iniziare con goog.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Al momento è supportato solo DynamicRoute. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una richiesta verrà impostato al massimo uno dei campi:
dynamicRoute

object (DynamicRoute)

SelectedRoute è una route dinamica.
Fine dei campi che si escludono a vicenda.
validationError

enum (ValidationError)

Solo output. L'errore di convalida per l'itinerario selezionato quando lo stato è STATE_INVALID.

DynamicRoute

Rappresenta un percorso con tappe intermedie (punto di partenza, destinazione e tappe intermedie). È garantito che il percorso effettivo passi per tutti i waypoint, 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. Località di partenza dell'itinerario.
destination

object (LatLng)

Obbligatorio. Posizione di arrivo del percorso.
intermediates[]

object (LatLng)

Facoltativo. Un insieme di tappe intermedie lungo il percorso (esclusi i punti terminali). Sono sempre punti di passaggio. Sono supportate fino a 25 tappe intermedie. Se vengono aggiunti correttamente, possono ridurre la variazione del percorso effettivo di volta in volta.

LatLng

Un oggetto che rappresenta una coppia latitudine/longitudine. Questi valori sono espressi come una coppia di numeri double 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 compreso nell'intervallo [-90,0, +90,0].
longitude

number

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

Stato

Lo stato dell'itinerario selezionato.

Enum
STATE_UNSPECIFIED Lo stato di questa route non è impostato.
STATE_SCHEDULING La route è stata creata ed è in fase di pianificazione.
STATE_RUNNING La route è stata creata e ha una pianificazione attiva.
STATE_DELETING La route è stata contrassegnata per l'eliminazione.
STATE_VALIDATING Il percorso è 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 Il percorso non rientra nella giurisdizione del progetto.
VALIDATION_ERROR_LOW_ROAD_USAGE Il percorso ha un basso utilizzo della strada (pochissime persone lo percorrono).

Metodi

batchCreate

 Crea più risorse SelectedRoute e avvia una pianificazione per recuperare periodicamente le informazioni sulla cache per ciascuno dei percorsi.

batchDelete

 Elimina più risorse SelectedRoute per il progetto specificato.

batchUpdate

 Aggiorna più risorse SelectedRoute come specificato dai relativi nomi.

create

 Crea un oggetto SelectedRoute e avvia una pianificazione per recuperare periodicamente le informazioni della cache per l'itinerario.

delete

 Elimina la SelectedRoute specificata per il progetto specificato.

get

 Recupera un oggetto SelectedRoute specificato dal nome.

list

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

patch

 Aggiorna un oggetto SelectedRoute in base al nome.