Reference documentation and code samples for the Google Cloud Optimization V1 Client class AsyncModelConfig.
Information for solving one optimization model asynchronously.
Generated from protobuf message google.cloud.optimization.v1.BatchOptimizeToursRequest.AsyncModelConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ display_name |
string
User defined model name, can be used as alias by users to keep track of models. |
↳ input_config |
Google\Cloud\Optimization\V1\InputConfig
Required. Information about the input model. |
↳ output_config |
Google\Cloud\Optimization\V1\OutputConfig
Required. The desired output location information. |
↳ enable_checkpoints |
bool
If this is set, the model will be solved in the checkpoint mode. In this mode, the input model can have a deadline longer than 30 mins without the risk of interruption. The model will be solved in multiple short-running stages. Each stage generates an intermediate checkpoint and stores it in the user's Cloud Storage buckets. The checkpoint mode should be preferred over allow_large_deadline_despite_interruption_risk since it prevents the risk of interruption. |
getDisplayName
User defined model name, can be used as alias by users to keep track of models.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
User defined model name, can be used as alias by users to keep track of models.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputConfig
Required. Information about the input model.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Optimization\V1\InputConfig|null | |
hasInputConfig
clearInputConfig
setInputConfig
Required. Information about the input model.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Optimization\V1\InputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputConfig
Required. The desired output location information.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Optimization\V1\OutputConfig|null | |
hasOutputConfig
clearOutputConfig
setOutputConfig
Required. The desired output location information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Optimization\V1\OutputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableCheckpoints
If this is set, the model will be solved in the checkpoint mode. In this mode, the input model can have a deadline longer than 30 mins without the risk of interruption. The model will be solved in multiple short-running stages. Each stage generates an intermediate checkpoint and stores it in the user's Cloud Storage buckets. The checkpoint mode should be preferred over allow_large_deadline_despite_interruption_risk since it prevents the risk of interruption.
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableCheckpoints
If this is set, the model will be solved in the checkpoint mode. In this mode, the input model can have a deadline longer than 30 mins without the risk of interruption. The model will be solved in multiple short-running stages. Each stage generates an intermediate checkpoint and stores it in the user's Cloud Storage buckets. The checkpoint mode should be preferred over allow_large_deadline_despite_interruption_risk since it prevents the risk of interruption.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |