google.cloud.optimization.v1.SkippedShipment.Reason
*/
class Reason extends \Google\Protobuf\Internal\Message
{
/**
* Refer to the comments of Code.
*
* Generated from protobuf field .google.cloud.optimization.v1.SkippedShipment.Reason.Code code = 1;
*/
private $code = 0;
/**
* If the reason is related to a shipment-vehicle incompatibility, this
* field provides the index of one relevant vehicle.
*
* Generated from protobuf field optional int32 example_vehicle_index = 2;
*/
private $example_vehicle_index = null;
/**
* If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
* capacity type that is exceeded.
*
* Generated from protobuf field string example_exceeded_capacity_type = 3;
*/
private $example_exceeded_capacity_type = '';
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type int $code
* Refer to the comments of Code.
* @type int $example_vehicle_index
* If the reason is related to a shipment-vehicle incompatibility, this
* field provides the index of one relevant vehicle.
* @type string $example_exceeded_capacity_type
* If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
* capacity type that is exceeded.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Optimization\V1\FleetRouting::initOnce();
parent::__construct($data);
}
/**
* Refer to the comments of Code.
*
* Generated from protobuf field .google.cloud.optimization.v1.SkippedShipment.Reason.Code code = 1;
* @return int
*/
public function getCode()
{
return $this->code;
}
/**
* Refer to the comments of Code.
*
* Generated from protobuf field .google.cloud.optimization.v1.SkippedShipment.Reason.Code code = 1;
* @param int $var
* @return $this
*/
public function setCode($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Optimization\V1\SkippedShipment\Reason\Code::class);
$this->code = $var;
return $this;
}
/**
* If the reason is related to a shipment-vehicle incompatibility, this
* field provides the index of one relevant vehicle.
*
* Generated from protobuf field optional int32 example_vehicle_index = 2;
* @return int
*/
public function getExampleVehicleIndex()
{
return isset($this->example_vehicle_index) ? $this->example_vehicle_index : 0;
}
public function hasExampleVehicleIndex()
{
return isset($this->example_vehicle_index);
}
public function clearExampleVehicleIndex()
{
unset($this->example_vehicle_index);
}
/**
* If the reason is related to a shipment-vehicle incompatibility, this
* field provides the index of one relevant vehicle.
*
* Generated from protobuf field optional int32 example_vehicle_index = 2;
* @param int $var
* @return $this
*/
public function setExampleVehicleIndex($var)
{
GPBUtil::checkInt32($var);
$this->example_vehicle_index = $var;
return $this;
}
/**
* If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
* capacity type that is exceeded.
*
* Generated from protobuf field string example_exceeded_capacity_type = 3;
* @return string
*/
public function getExampleExceededCapacityType()
{
return $this->example_exceeded_capacity_type;
}
/**
* If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
* capacity type that is exceeded.
*
* Generated from protobuf field string example_exceeded_capacity_type = 3;
* @param string $var
* @return $this
*/
public function setExampleExceededCapacityType($var)
{
GPBUtil::checkString($var, True);
$this->example_exceeded_capacity_type = $var;
return $this;
}
}