Google Cloud Optimization V1 Client - Class AsyncModelConfig (0.1.9)

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
NameDescription
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
TypeDescription
string

setDisplayName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInputConfig

Required. Information about the input model.

Returns
TypeDescription
Google\Cloud\Optimization\V1\InputConfig|null

hasInputConfig

clearInputConfig

setInputConfig

Required. Information about the input model.

Parameter
NameDescription
var Google\Cloud\Optimization\V1\InputConfig
Returns
TypeDescription
$this

getOutputConfig

Required. The desired output location information.

Returns
TypeDescription
Google\Cloud\Optimization\V1\OutputConfig|null

hasOutputConfig

clearOutputConfig

setOutputConfig

Required. The desired output location information.

Parameter
NameDescription
var Google\Cloud\Optimization\V1\OutputConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this