REST Resource: selection.v1.projects.selectedRoutes

Ressource : SelectedRoute

Une SelectedRoute représente une route spécifique pour laquelle un client souhaite récupérer périodiquement 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 la SelectedRoute.

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

string

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la route sélectionnée a été créée pour la première fois.

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. Leur ajout permet de filtrer ou de regrouper les routes lors de la récupération d'informations historiques et en temps réel. Jusqu'à 10 attributs sont acceptés par route. 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 "key": value paires. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Champ d'union route_type. Actuellement, seul DynamicRoute est accepté. La route_type ne peut être qu'un des éléments suivants :
dynamicRoute

object (DynamicRoute)

La SelectedRoute est une route dynamique.
validationError

enum (ValidationError)

Uniquement en sortie. Erreur de validation de la route sélectionnée lorsque l'état est STATE_INVALID.

DynamicRoute

Représente une route avec des points de repère (origine, destination et intermédiaires). La route réelle passe obligatoirement par tous les points de repère, mais elle 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. Point de départ de la route.
destination

object (LatLng)

Obligatoire. Point d'arrivée de la route.
intermediates[]

object (LatLng)

Facultatif. Ensemble de points de repère intermédiaires le long de la route (à l'exclusion des points de terminaison). Il s'agit toujours de points de passage. Jusqu'à 25 points de repère intermédiaires sont acceptés. Leur ajout approprié peut réduire la variation de la route réelle de temps en temps.

LatLng

Objet représentant une paire latitude/longitude. Elle est exprimée sous la forme d'une paire de nombres à virgule flottante double précision pour représenter la latitude et la longitude en degrés. 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 planification 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 en fonction de l'un des critères de validation.

ValidationError

Erreur de validation de 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 La route se trouve en dehors de la juridiction du projet.
VALIDATION_ERROR_LOW_ROAD_USAGE La route est peu utilisée (très peu de personnes y passent).

Méthodes

batchCreate

 Crée plusieurs ressources SelectedRoute et démarre une planification pour récupérer périodiquement les informations de cache de chacune des routes.

batchDelete

 Supprime plusieurs ressources SelectedRoute pour le projet spécifié.

batchUpdate

 Met à jour plusieurs ressources SelectedRoute comme spécifié par leur nom.

create

 Crée une SelectedRoute et démarre une planification pour récupérer périodiquement les informations de cache de la route.

delete

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

get

 Récupère une SelectedRoute comme spécifié par son nom.

list

 Répertorie toutes les ressources SelectedRoute pour le projet spécifié avec pagination.

patch

 Met à jour une SelectedRoute comme spécifié par son nom.