com.google.ortools.linearsolver.MPModelRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-or-tools Show documentation
Publishing Google OR-Tools as a Maven dependency
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: ortools/linear_solver/linear_solver.proto

package com.google.ortools.linearsolver;

public interface MPModelRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:operations_research.MPModelRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The model to be optimized by the server.
   * 
   *
   * optional .operations_research.MPModelProto model = 1;
   * @return Whether the model field is set.
   */
  boolean hasModel();
  /**
   *    * The model to be optimized by the server.
   * 
   *
   * optional .operations_research.MPModelProto model = 1;
   * @return The model.
   */
  com.google.ortools.linearsolver.MPModelProto getModel();
  /**
   *    * The model to be optimized by the server.
   * 
   *
   * optional .operations_research.MPModelProto model = 1;
   */
  com.google.ortools.linearsolver.MPModelProtoOrBuilder getModelOrBuilder();

  /**
   * optional .operations_research.MPModelRequest.SolverType solver_type = 2;
   * @return Whether the solverType field is set.
   */
  boolean hasSolverType();
  /**
   * optional .operations_research.MPModelRequest.SolverType solver_type = 2;
   * @return The solverType.
   */
  com.google.ortools.linearsolver.MPModelRequest.SolverType getSolverType();

  /**
   *    * Maximum time to be spent by the solver to solve 'model'. If the server is
   * busy and the RPC's deadline_left is less than this, it will immediately
   * give up and return an error, without even trying to solve.
   * The client can use this to have a guarantee on how much time the
   * solver will spend on the problem (unless it finds and proves
   * an optimal solution more quickly).
   * If not specified, the time limit on the solver is the RPC's deadline_left.
   * 
   *
   * optional double solver_time_limit_seconds = 3;
   * @return Whether the solverTimeLimitSeconds field is set.
   */
  boolean hasSolverTimeLimitSeconds();
  /**
   *    * Maximum time to be spent by the solver to solve 'model'. If the server is
   * busy and the RPC's deadline_left is less than this, it will immediately
   * give up and return an error, without even trying to solve.
   * The client can use this to have a guarantee on how much time the
   * solver will spend on the problem (unless it finds and proves
   * an optimal solution more quickly).
   * If not specified, the time limit on the solver is the RPC's deadline_left.
   * 
   *
   * optional double solver_time_limit_seconds = 3;
   * @return The solverTimeLimitSeconds.
   */
  double getSolverTimeLimitSeconds();

  /**
   *    * If this is set, then EnableOutput() will be set on the internal MPSolver
   * that solves the model.
   * WARNING: if you set this on a request to prod servers, it will be rejected
   * and yield the RPC Application Error code MPSOLVER_SOLVER_TYPE_UNAVAILABLE.
   * 
   *
   * optional bool enable_internal_solver_output = 4 [default = false];
   * @return Whether the enableInternalSolverOutput field is set.
   */
  boolean hasEnableInternalSolverOutput();
  /**
   *    * If this is set, then EnableOutput() will be set on the internal MPSolver
   * that solves the model.
   * WARNING: if you set this on a request to prod servers, it will be rejected
   * and yield the RPC Application Error code MPSOLVER_SOLVER_TYPE_UNAVAILABLE.
   * 
   *
   * optional bool enable_internal_solver_output = 4 [default = false];
   * @return The enableInternalSolverOutput.
   */
  boolean getEnableInternalSolverOutput();

  /**
   *    * Advanced usage. Solver-specific parameters in the solver's own format,
   * different for each solver. For example, if you use SCIP and you want to
   * stop the solve earlier than the time limit if it reached a solution that is
   * at most 1% away from the optimal, you can set this to "limits/gap=0.01".
   * Note however that there is no "security" mechanism in place so it is up to
   * the client to make sure that the given options don't make the solve
   * non thread safe or use up too much memory for instance.
   * If the option format is not understood by the solver, the request will be
   * rejected and yield an RPC Application error with code
   * MPSOLVER_MODEL_INVALID_SOLVER_PARAMETERS.
   * 
   *
   * optional string solver_specific_parameters = 5;
   * @return Whether the solverSpecificParameters field is set.
   */
  boolean hasSolverSpecificParameters();
  /**
   *    * Advanced usage. Solver-specific parameters in the solver's own format,
   * different for each solver. For example, if you use SCIP and you want to
   * stop the solve earlier than the time limit if it reached a solution that is
   * at most 1% away from the optimal, you can set this to "limits/gap=0.01".
   * Note however that there is no "security" mechanism in place so it is up to
   * the client to make sure that the given options don't make the solve
   * non thread safe or use up too much memory for instance.
   * If the option format is not understood by the solver, the request will be
   * rejected and yield an RPC Application error with code
   * MPSOLVER_MODEL_INVALID_SOLVER_PARAMETERS.
   * 
   *
   * optional string solver_specific_parameters = 5;
   * @return The solverSpecificParameters.
   */
  java.lang.String getSolverSpecificParameters();
  /**
   *    * Advanced usage. Solver-specific parameters in the solver's own format,
   * different for each solver. For example, if you use SCIP and you want to
   * stop the solve earlier than the time limit if it reached a solution that is
   * at most 1% away from the optimal, you can set this to "limits/gap=0.01".
   * Note however that there is no "security" mechanism in place so it is up to
   * the client to make sure that the given options don't make the solve
   * non thread safe or use up too much memory for instance.
   * If the option format is not understood by the solver, the request will be
   * rejected and yield an RPC Application error with code
   * MPSOLVER_MODEL_INVALID_SOLVER_PARAMETERS.
   * 
   *
   * optional string solver_specific_parameters = 5;
   * @return The bytes for solverSpecificParameters.
   */
  com.google.protobuf.ByteString
      getSolverSpecificParametersBytes();

  /**
   *    * Advanced usage: model "delta". If used, "model" must be unset. See the
   * definition of MPModelDeltaProto.
   * 
   *
   * optional .operations_research.MPModelDeltaProto model_delta = 8;
   * @return Whether the modelDelta field is set.
   */
  boolean hasModelDelta();
  /**
   *    * Advanced usage: model "delta". If used, "model" must be unset. See the
   * definition of MPModelDeltaProto.
   * 
   *
   * optional .operations_research.MPModelDeltaProto model_delta = 8;
   * @return The modelDelta.
   */
  com.google.ortools.linearsolver.MPModelDeltaProto getModelDelta();
  /**
   *    * Advanced usage: model "delta". If used, "model" must be unset. See the
   * definition of MPModelDeltaProto.
   * 
   *
   * optional .operations_research.MPModelDeltaProto model_delta = 8;
   */
  com.google.ortools.linearsolver.MPModelDeltaProtoOrBuilder getModelDeltaOrBuilder();
}