REST Resource: selection.v1.projects.selectedRoutes

Ressource : SelectedRoute

SelectedRoute représente un itinéraire spécifique pour lequel un client souhaite récupérer régulièrement des informations (par exemple, la durée) pour des cas d'utilisation contractuels.

Représentation 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)
}
Champs
name

string

Identifiant. Nom de ressource de SelectedRoute.

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

string

Facultatif. Nom à afficher de la route. Il s'agit d'un champ facultatif que le client peut utiliser. Il ne doit pas forcément être unique.
createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle l'itinéraire sélectionné a été créé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
state

enum (State)

Uniquement en sortie. État de la route sélectionnée.
routeAttributes

map (key: string, value: string)

Facultatif. Attributs personnalisés de la route sélectionnée. L'ajout de ces informations permet de filtrer / regrouper les itinéraires lors de la récupération des informations historiques et en temps réel. Jusqu'à 10 attributs sont acceptés par itinéraire. Chaque clé et valeur doit être une chaîne non vide et peut comporter jusqu'à 100 caractères. Les clés ne doivent pas commencer par "goog".

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Champ d'union route_type. Pour le moment, seul DynamicRoute est pris en charge. La route_type ne peut être qu'un des éléments suivants :
dynamicRoute

object (DynamicRoute)

SelectedRoute est une route dynamique.
validationError

enum (ValidationError)

Uniquement en sortie. Erreur de validation de l'itinéraire sélectionné lorsque l'état est STATE_INVALID.

DynamicRoute

Il s'agit d'un itinéraire avec des points de cheminement (origine, destination et points intermédiaires). L'itinéraire réel est garanti de passer par tous les points de cheminement, mais il peut changer de temps en temps en raison des conditions de circulation variables.

Représentation JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Champs
origin

object (LatLng)

Obligatoire. Lieu de départ de l'itinéraire.
destination

object (LatLng)

Obligatoire. Emplacement d'arrivée de l'itinéraire.
intermediates[]

object (LatLng)

Facultatif. Ensemble de points de cheminement intermédiaires sur l'itinéraire (à l'exclusion des points de départ et d'arrivée). Il s'agit toujours de points de passage. Vous pouvez ajouter jusqu'à 25 points de cheminement intermédiaires. Si vous les ajoutez correctement, vous pourrez réduire la variation de l'itinéraire réel de temps en temps.

LatLng

Objet représentant une paire latitude/longitude. Cette valeur est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].
longitude

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

État

État de la route sélectionnée.

Enums
STATE_UNSPECIFIED L'état de cette route n'est pas défini.
STATE_SCHEDULING La route a été créée et est en cours de planification.
STATE_RUNNING La route a été créée et dispose d'une programmation active.
STATE_DELETING La route a été marquée pour suppression.
STATE_VALIDATING La route est en cours de validation.
STATE_INVALID La route n'est pas valide selon l'un des critères de validation.

ValidationError

Erreur de validation pour la route sélectionnée.

Enums
VALIDATION_ERROR_UNSPECIFIED L'erreur de validation de cette route n'est pas définie.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION L'itinéraire se trouve en dehors de la juridiction du projet.
VALIDATION_ERROR_LOW_ROAD_USAGE La route est peu fréquentée (très peu de personnes l'empruntent).

Méthodes

batchCreate

 Crée plusieurs SelectedRoutes et lance une planification pour récupérer périodiquement les informations du cache pour chacun des itinéraires.

create

 Crée un SelectedRoute et lance une planification pour récupérer périodiquement les informations du cache pour l'itinéraire.

delete

 Supprime la SelectedRoute spécifiée pour le projet spécifié.

get

 Obtient un SelectedRoute tel que spécifié par son nom.

list

 Répertorie tous les SelectedRoutes pour le projet spécifié avec pagination.