REST Resource: selection.v1.projects.selectedRoutes

Resource: SelectedRoute

SelectedRoute mewakili rute tertentu yang ingin diambil informasinya (misalnya, durasi) secara berkala oleh pelanggan untuk kasus penggunaan yang dikontrak.

Representasi 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 response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
Kolom
name

string

ID. Nama resource SelectedRoute.

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

string

Opsional. Nama tampilan rute. Kolom ini bersifat opsional dan dapat digunakan oleh pelanggan. Nama ini tidak harus unik. Panjangnya dibatasi hingga 100 karakter (dihitung dalam poin kode Unicode).
createTime

string (Timestamp format)

Hanya output. Waktu saat rute yang dipilih pertama kali dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
state

enum (State)

Hanya output. Status rute yang dipilih.
routeAttributes

map (key: string, value: string)

Opsional. Atribut kustom untuk rute yang dipilih. Menambahkan tag memungkinkan pemfilteran atau pengelompokan rute saat mengambil informasi rute historis dan real-time. Maksimal 25 atribut didukung per rute. Setiap kunci dan nilai harus berupa string yang tidak kosong dan dapat memiliki hingga 100 karakter (dihitung dalam poin kode Unicode). Kunci tidak boleh diawali dengan goog.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Hanya DynamicRoute yang didukung. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
dynamicRoute

object (DynamicRoute)

SelectedRoute adalah rute dinamis.
Akhir kolom yang saling eksklusif.
validationError

enum (ValidationError)

Hanya output. Error validasi untuk rute yang dipilih saat statusnya adalah STATE_INVALID.
dynamicRouting

boolean

Opsional. Jika disetel ke true, rute yang dipilih dapat mengubah rute secara dinamis berdasarkan lalu lintas real-time sesuai dengan titik jalan input. Jika ditetapkan ke false, rute yang dipilih akan menjadi rute tetap yang tidak terpengaruh oleh lalu lintas langsung dan mengikuti jalur yang tidak memperhitungkan lalu lintas yang dihitung pada waktu pembuatan. Jika dihilangkan, nilainya akan ditetapkan secara default ke false yang menunjukkan bahwa rute tersebut adalah rute tetap.

DynamicRoute

Ini mewakili rute dengan titik jalan (asal, tujuan, dan perantara). Rute sebenarnya dijamin akan melewati semua titik jalan. Jika dynamicRouting ditetapkan ke false, rute sebenarnya akan tetap sama, terlepas dari kondisi lalu lintas. Jika tidak, jika dynamicRouting ditetapkan ke true, rute sebenarnya dapat berubah berdasarkan kondisi lalu lintas.

Representasi JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Kolom
origin

object (LatLng)

Wajib. Lokasi asal rute.
destination

object (LatLng)

Wajib. Lokasi akhir rute.
intermediates[]

object (LatLng)

Opsional. Kumpulan titik jalan perantara di sepanjang rute (tidak termasuk titik terminal). Titik tersebut selalu merupakan titik yang dilewati. Maksimal 25 titik jalan perantara didukung. Menambahkannya dengan benar dapat mengurangi variasi rute sebenarnya dari waktu ke waktu.

LatLng

Objek yang merepresentasikan pasangan garis lintang/bujur. Objek ini dinyatakan sebagai pasangan double untuk mewakili derajat lintang dan derajat bujur. Kecuali jika ditentukan lain, objek ini harus sesuai dengan standar WGS84. Nilai harus berada dalam rentang yang dinormalisasi.

Representasi JSON 
{
  "latitude": number,
  "longitude": number
}
Kolom
latitude

number

Lintang dalam derajat. Harus dalam rentang [-90.0, +90.0].
longitude

number

Bujur dalam derajat. Harus dalam rentang [-180.0, +180.0].

Negara Bagian

Status rute yang dipilih.

Enum
STATE_UNSPECIFIED Status rute ini tidak ditetapkan.
STATE_SCHEDULING Rute telah dibuat dan sedang dijadwalkan.
STATE_RUNNING Rute telah dibuat dan memiliki jadwal aktif.
STATE_DELETING Rute telah ditandai untuk dihapus.
STATE_VALIDATING Rute sedang dalam proses validasi.
STATE_INVALID Rute tidak valid berdasarkan salah satu kriteria validasi.

ValidationError

Error validasi untuk rute yang dipilih.

Enum
VALIDATION_ERROR_UNSPECIFIED Error validasi rute ini tidak ditetapkan.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION Rute tersebut berada di luar yurisdiksi project.
VALIDATION_ERROR_LOW_ROAD_USAGE Rute tersebut memiliki penggunaan jalan yang rendah (sangat sedikit orang yang melewatinya).

Metode

batchCreate

 Membuat beberapa resource SelectedRoute dan memulai jadwal untuk mengambil informasi cache secara berkala untuk setiap rute.

batchDelete

 Menghapus beberapa resource SelectedRoute untuk project yang ditentukan.

batchUpdate

 Memperbarui beberapa resource SelectedRoute seperti yang ditentukan oleh namanya.

create

 Membuat SelectedRoute dan memulai jadwal untuk mengambil informasi cache secara berkala untuk rute tersebut.

delete

 Menghapus SelectedRoute yang ditentukan untuk project yang ditentukan.

get

 Mendapatkan SelectedRoute seperti yang ditentukan oleh namanya.

list

 Mencantumkan semua resource SelectedRoute untuk project yang ditentukan dengan penomoran halaman.

patch

 Memperbarui SelectedRoute seperti yang ditentukan oleh namanya.