AsyncModelConfig

  • AsyncModelConfig provides information for solving one optimization model asynchronously, specifying input and output configurations.

  • InputConfig defines the input data format and source, which can be a Google Cloud Storage location with a single object (file) using gcsSource.

  • OutputConfig specifies the output data format and destination, allowing results to be written to a designated Google Cloud Storage location using gcsDestination.

  • Supported data formats for both input and output include JSON and Protocol Buffers text format, selected using the dataFormat field.

  • Users can optionally provide a displayName for the model as an alias for tracking purposes.

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.