AsyncModelConfig

  • This content describes the configuration for asynchronously solving an optimization model, which includes defining input and output specifications.

  • The InputConfig object requires a specified DataFormat and can use a GcsSource to read input data from a Google Cloud Storage location.

  • The OutputConfig object also mandates a DataFormat and uses GcsDestination to specify the Google Cloud Storage location for writing the results.

  • GcsSource and GcsDestination both use a uri field to pinpoint the specific Google Cloud Storage object or location, respectively.

  • Supported DataFormat options include JSON and PROTO_TEXT, which define how data is structured for both input and output.

Information for solving one optimization model asynchronously.

JSON representation 
{
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "outputConfig": {
    object (OutputConfig)
  }
}
Fields
displayName

string

Optional. User defined model name, can be used as alias by users to keep track of models.
inputConfig

object (InputConfig)

Required. Information about the input model.
outputConfig

object (OutputConfig)

Required. The desired output location information.

InputConfig

Specify an input for [locations.batchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours].

JSON representation 
{
  "dataFormat": enum (DataFormat),

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  }
  // End of list of possible types for union field source.
}
Fields
dataFormat

enum (DataFormat)

Required. The input data format.
Union field source. Required. source can be only one of the following:
gcsSource

object (GcsSource)

A Google Cloud Storage location. This must be a single object (file).

GcsSource

The Google Cloud Storage location where the input file will be read from.

JSON representation 
{
  "uri": string
}
Fields
uri

string

Required. URI of a Google Cloud Storage object with the format gs://bucket/path/to/object.

DataFormat

Data formats for input and output files.

Enums
DATA_FORMAT_UNSPECIFIED Invalid value, format must not be UNSPECIFIED.
JSON JavaScript Object Notation.
PROTO_TEXT Protocol Buffers text format. See https://protobuf.dev/reference/protobuf/textformat-spec/

OutputConfig

Specify a destination for [locations.batchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours] results.

JSON representation 
{
  "dataFormat": enum (DataFormat),

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object (GcsDestination)
  }
  // End of list of possible types for union field destination.
}
Fields
dataFormat

enum (DataFormat)

Required. The output data format.
Union field destination. Required. destination can be only one of the following:
gcsDestination

object (GcsDestination)

The Google Cloud Storage location to write the output to.

GcsDestination

The Google Cloud Storage location where the output file(s) will be written to.

JSON representation 
{
  "uri": string
}
Fields
uri

string

Required. Google Cloud Storage URI.