Method: networks.shipments.path.commit

Confirma o caminho de uma remessa, indicando que não pode ser alterado no futuro, mesmo pelo usuário, exceto por força maior/ato de Deus indicado pelos métodosvehicle.makeUnavailable, hubs.makeUnavailable e rows.makeEsc. Esse método não é usado para marcar uma revisão específica de um caminho.

Solicitação HTTP

POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/shipments/*}/path:commit

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome da remessa cujo caminho precisa ser confirmado. Formato: "networks/{network}/shipments/{shipment}"

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{

  // Union field path_to_commit can be only one of the following:
  "completeShipmentPath": {
    object (PathToCommit)
  },
  "segments": {
    object (IncompletePathToCommit)
  }
  // End of list of possible types for union field path_to_commit.
}
Campos
Campo de união path_to_commit. Um ou mais caminhos que serão confirmados. path_to_commit pode ser apenas de um dos tipos a seguir:
completeShipmentPath

object (PathToCommit)

Os segmentos de um caminho de uma origem até um destino.
segments

object (IncompletePathToCommit)

Um subconjunto dos segmentos de um caminho de uma origem até um destino.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Path.

PathToCommit

Caminho completo sendo confirmado, da origem ao destino.

Representação JSON 
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Campos
segments[]

object (PathSegment)

Obrigatório. Os segmentos precisam estar em ordem, de uma origem para um destino.

IncompletePathToCommit

Parte do caminho que está sendo confirmado, ou seja, alguns segmentos entre a origem e o destino.

Representação JSON 
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Campos
segments[]

object (PathSegment)

Obrigatório. Um subconjunto dos segmentos de um caminho de uma origem até um destino.