AsyncModelConfig
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
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.
|
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[[["\u003cp\u003eAsyncModelConfig provides information for solving one optimization model asynchronously, specifying input and output configurations.\u003c/p\u003e\n"],["\u003cp\u003eInputConfig defines the input data format and source, which can be a Google Cloud Storage location with a single object (file) using \u003ccode\u003egcsSource\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eOutputConfig specifies the output data format and destination, allowing results to be written to a designated Google Cloud Storage location using \u003ccode\u003egcsDestination\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSupported data formats for both input and output include JSON and Protocol Buffers text format, selected using the \u003ccode\u003edataFormat\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eUsers can optionally provide a \u003ccode\u003edisplayName\u003c/code\u003e for the model as an alias for tracking purposes.\u003c/p\u003e\n"]]],["This content details configurations for asynchronous optimization model solutions. Key actions include defining `InputConfig` and `OutputConfig`. `InputConfig` specifies data format (`JSON` or `PROTO_TEXT`) and a Google Cloud Storage (GCS) source URI. `OutputConfig` sets the output data format and a GCS destination URI. Users provide a model display name and must specify input and output data formats, utilizing GCS for both input and output. Supported data formats are JSON or PROTO_TEXT.\n"],null,["# AsyncModelConfig\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [InputConfig](#InputConfig)\n - [JSON representation](#InputConfig.SCHEMA_REPRESENTATION)\n- [GcsSource](#GcsSource)\n - [JSON representation](#GcsSource.SCHEMA_REPRESENTATION)\n- [DataFormat](#DataFormat)\n- [OutputConfig](#OutputConfig)\n - [JSON representation](#OutputConfig.SCHEMA_REPRESENTATION)\n- [GcsDestination](#GcsDestination)\n - [JSON representation](#GcsDestination.SCHEMA_REPRESENTATION)\n\nInformation for solving one optimization model asynchronously.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"displayName\": string, \"inputConfig\": { object (/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#InputConfig) }, \"outputConfig\": { object (/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#OutputConfig) } } ``` |\n\n| Fields ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `displayName` | `string` Optional. User defined model name, can be used as alias by users to keep track of models. |\n| `inputConfig` | `object (`[InputConfig](/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#InputConfig)`)` Required. Information about the input model. |\n| `outputConfig` | `object (`[OutputConfig](/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#OutputConfig)`)` Required. The desired output location information. |\n\nInputConfig\n-----------\n\nSpecify an input for \\[locations.batchOptimizeTours\\]\\[google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours\\].\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"dataFormat\": enum (/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#DataFormat), // Union field `source` can be only one of the following: \"gcsSource\": { object (/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#GcsSource) } // End of list of possible types for union field `source`. } ``` |\n\n| Fields ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dataFormat` | `enum (`[DataFormat](/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#DataFormat)`)` Required. The input data format. |\n| Union field `source`. Required. `source` can be only one of the following: ||\n| `gcsSource` | `object (`[GcsSource](/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#GcsSource)`)` A Google Cloud Storage location. This must be a single object (file). |\n\nGcsSource\n---------\n\nThe Google Cloud Storage location where the input file will be read from.\n\n| JSON representation |\n|---------------------------|\n| ``` { \"uri\": string } ``` |\n\n| Fields ||\n|-------|-------------------------------------------------------------------------------------------------------|\n| `uri` | `string` Required. URI of a Google Cloud Storage object with the format `gs://bucket/path/to/object`. |\n\nDataFormat\n----------\n\nData formats for input and output files.\n\n| Enums ||\n|---------------------------|----------------------------------------------------------------------------------------------|\n| `DATA_FORMAT_UNSPECIFIED` | Invalid value, format must not be UNSPECIFIED. |\n| `JSON` | JavaScript Object Notation. |\n| `PROTO_TEXT` | Protocol Buffers text format. See \u003chttps://protobuf.dev/reference/protobuf/textformat-spec/\u003e |\n\nOutputConfig\n------------\n\nSpecify a destination for \\[locations.batchOptimizeTours\\]\\[google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours\\] results.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"dataFormat\": enum (/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#DataFormat), // Union field `destination` can be only one of the following: \"gcsDestination\": { object (/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#GcsDestination) } // End of list of possible types for union field `destination`. } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dataFormat` | `enum (`[DataFormat](/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#DataFormat)`)` Required. The output data format. |\n| Union field `destination`. Required. `destination` can be only one of the following: ||\n| `gcsDestination` | `object (`[GcsDestination](/maps/documentation/route-optimization/reference/rest/v1/AsyncModelConfig#GcsDestination)`)` The Google Cloud Storage location to write the output to. |\n\nGcsDestination\n--------------\n\nThe Google Cloud Storage location where the output file(s) will be written to.\n\n| JSON representation |\n|---------------------------|\n| ``` { \"uri\": string } ``` |\n\n| Fields ||\n|-------|----------------------------------------------|\n| `uri` | `string` Required. Google Cloud Storage URI. |"]]
