Method: providers.vehicles.list

Retorna uma lista paginada de veículos associados a um provedor que corresponde às opções de solicitação.

Solicitação HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.

Parâmetros de consulta

Parâmetros
header

object (RequestHeader)

O cabeçalho de solicitação padrão do Fleet Engine.
pageSize

integer

O número máximo de veículos a serem retornados. Valor padrão: 100.
pageToken

string

O valor do nextPageToken fornecido por uma chamada anterior para vehicles.list para que você possa paginar por grupos de veículos. O valor será indefinido se os critérios de filtro da solicitação não forem iguais aos da chamada anterior para vehicles.list.
minimumCapacity

integer

Especifica a capacidade mínima exigida do veículo. Todos os veículos retornados terão um maximumCapacity maior ou igual a esse valor. Se definido, precisa ser maior ou igual a 0.
tripTypes[]

enum (TripType)

Restringe a resposta a veículos que aceitam pelo menos um dos tipos de viagem especificados.
maximumStaleness

string (Duration format)

Restringe a resposta aos veículos que enviaram atualizações de localização para o Fleet Engine no período especificado. Veículos parados que ainda estiverem transmitindo a localização não são considerados desatualizados. Se presente, precisa ser uma duração positiva válida.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
vehicleTypeCategories[]

enum (Category)

Obrigatório. Restringe a resposta a veículos com uma das categorias de tipo especificadas. A política UNKNOWN não é permitida.
requiredAttributes[]

string

Os autores da chamada podem formar operações lógicas complexas usando qualquer combinação dos campos requiredAttributes, requiredOneOfAttributes e requiredOneOfAttributeSets.

requiredAttributes é uma lista. O requiredOneOfAttributes usa uma mensagem que permite uma lista de listas. Em combinação, os dois campos permitem a composição dessa expressão:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

Restringe a resposta a veículos com os atributos especificados. Este campo é uma operação de conjunção/E. São permitidos no máximo 50 requiredAttributes. Esse número corresponde ao número máximo de atributos permitidos em um veículo. Cada string repetida precisa estar no formato "chave:valor".
requiredOneOfAttributes[]

string

Restringe a resposta a veículos com pelo menos um dos atributos especificados em cada VehicleAttributeList. Em cada lista, um veículo precisa corresponder a pelo menos um dos atributos. Esse campo é uma operação de disjunção/OR inclusiva em cada VehicleAttributeList e uma operação de conjunção/E em toda a coleção de VehicleAttributeList. Cada string repetida precisa estar no formato "chave1:valor1|chave2:valor2|chave3:valor3".
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets oferece mais funcionalidades.

Assim como requiredOneOfAttributes, requiredOneOfAttributeSets usa uma mensagem que permite uma lista de listas, permitindo expressões como esta:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

Restringe a resposta a veículos que correspondem a todos os atributos em uma VehicleAttributeList. Em cada lista, um veículo precisa corresponder a todos os atributos. Este campo é uma operação de conjunção/E em cada VehicleAttributeList e operação de disjunção/OU inclusiva em toda a coleção de VehicleAttributeList. Cada string repetida precisa estar no formato "chave1:valor1|chave2:valor2|chave3:valor3".
vehicleState

enum (VehicleState)

Restringe a resposta aos veículos que têm esse estado.
onTripOnly

boolean

Devolva apenas os veículos com as viagens atuais.
filter

string

Opcional. Uma consulta de filtro para aplicar na listagem de veículos. Acesse http://aip.dev/160 para ver exemplos da sintaxe de filtro.

Esse campo foi projetado para substituir os campos requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets. Se um valor não vazio for especificado aqui, os campos a seguir precisarão estar vazios: requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets.

Esse filtro funciona como uma cláusula "E" com outras restrições, como vehicleState ou onTripOnly.

As únicas consultas aceitas são em atributos de veículos (por exemplo, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). O número máximo de restrições permitido em uma consulta de filtro é 50.

Além disso, todos os atributos são armazenados como strings. Portanto, as únicas comparações compatíveis com os atributos são as de strings. Para comparação com valores numéricos ou booleanos, os valores precisam estar explicitamente entre aspas para serem tratados como strings (por exemplo, attributes.<key> = "10" ou attributes.<key> = "true").
viewport

object (Viewport)

Opcional. Um filtro que limita os veículos retornados àqueles cuja última localização conhecida estava na área retangular definida pela janela de visualização.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta de vehicles.list.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Campos
vehicles[]

object (Vehicle)

Veículos que correspondem aos critérios na solicitação. O número máximo de veículos retornados é determinado pelo campo pageSize na solicitação.
nextPageToken

string

Token para recuperar a próxima página de veículos ou vazio se não houver mais veículos que atendam aos critérios da solicitação.
totalSize

string (int64 format)

Obrigatório. Número total de veículos que correspondem aos critérios de solicitação em todas as páginas.

Janela de visualização

Uma janela de visualização de latitude e longitude, representada como dois pontos low e high diagonalmente opostos. Uma janela de visualização é considerada uma região fechada, ou seja, inclui seu limite. Os limites de latitude precisam variar entre -90 e 90 graus, inclusive, e os limites de longitude, entre -180 e 180 graus, inclusive. Vários casos incluem:

  • Se low = high, a janela de visualização consistirá nesse único ponto.

  • Se low.longitude > high.longitude, o intervalo de longitude será invertido (a janela de visualização cruza a linha de longitude de 180 graus).

  • Se low.longitude = -180 graus e high.longitude = 180 graus, a janela de visualização vai incluir todas as longitudes.

  • Se low.longitude = 180 graus e high.longitude = -180 graus, o intervalo de longitude vai ficar vazio.

  • Se low.latitude > high.latitude, o intervalo de latitude vai estar vazio.

low e high precisam ser preenchidos, e a caixa representada não pode estar vazia (conforme especificado pelas definições acima). Uma janela de visualização vazia resultará em um erro.

Por exemplo, esta janela de visualização abrange totalmente a cidade de Nova York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Representação JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campos
low

object (LatLng)

Obrigatório. O ponto inferior da janela de visualização.
high

object (LatLng)

Obrigatório. O ponto mais alto da janela de visualização.