Java Reference
Java Reference
Detailed Description
Next id: 9.
Protobuf type
Definition at line 13 of file MPModelRequest.java.
Classes | |
| class | Builder |
| enum | SolverType |
Public Member Functions | |
| .lang.Override final com.google.protobuf.UnknownFieldSet | getUnknownFields () |
| .lang.Override boolean | hasModel () |
| .lang.Override com.google.ortools.linearsolver.MPModelProto | getModel () |
| .lang.Override com.google.ortools.linearsolver.MPModelProtoOrBuilder | getModelOrBuilder () |
| .lang.Override boolean | hasSolverType () |
optional .operations_research.MPModelRequest.SolverType solver_type = 2; More... | |
| .lang.Override com.google.ortools.linearsolver.MPModelRequest.SolverType | getSolverType () |
optional .operations_research.MPModelRequest.SolverType solver_type = 2; More... | |
| .lang.Override boolean | hasSolverTimeLimitSeconds () |
| .lang.Override double | getSolverTimeLimitSeconds () |
| .lang.Override boolean | hasEnableInternalSolverOutput () |
| .lang.Override boolean | getEnableInternalSolverOutput () |
| .lang.Override boolean | hasSolverSpecificParameters () |
| .lang.Override java.lang.String | getSolverSpecificParameters () |
| .lang.Override com.google.protobuf.ByteString | getSolverSpecificParametersBytes () |
| .lang.Override boolean | hasModelDelta () |
| .lang.Override com.google.ortools.linearsolver.MPModelDeltaProto | getModelDelta () |
| .lang.Override com.google.ortools.linearsolver.MPModelDeltaProtoOrBuilder | getModelDeltaOrBuilder () |
| .lang.Override final boolean | isInitialized () |
| .lang.Override void | writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException |
| .lang.Override int | getSerializedSize () |
| .lang.Override boolean | equals (final java.lang.Object obj) |
| .lang.Override int | hashCode () |
| .lang.Override Builder | newBuilderForType () |
| .lang.Override Builder | toBuilder () |
| .lang.Override com.google.protobuf.Parser< MPModelRequest > | getParserForType () |
| .lang.Override com.google.ortools.linearsolver.MPModelRequest | getDefaultInstanceForType () |
Static Public Member Functions | |
| static final com.google.protobuf.Descriptors.Descriptor | getDescriptor () |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (java.io.InputStream input) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPModelRequest | parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPModelRequest | parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPModelRequest | parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static Builder | newBuilder () |
| static Builder | newBuilder (com.google.ortools.linearsolver.MPModelRequest prototype) |
| static com.google.ortools.linearsolver.MPModelRequest | getDefaultInstance () |
| static com.google.protobuf.Parser< MPModelRequest > | parser () |
Static Public Attributes | |
| static final int | MODEL_FIELD_NUMBER = 1 |
| static final int | SOLVER_TYPE_FIELD_NUMBER = 2 |
| static final int | SOLVER_TIME_LIMIT_SECONDS_FIELD_NUMBER = 3 |
| static final int | ENABLE_INTERNAL_SOLVER_OUTPUT_FIELD_NUMBER = 4 |
| static final int | SOLVER_SPECIFIC_PARAMETERS_FIELD_NUMBER = 5 |
| static final int | MODEL_DELTA_FIELD_NUMBER = 8 |
| .lang.Deprecated static final com.google.protobuf.Parser< MPModelRequest > | PARSER |
Protected Member Functions | |
| .lang.Override java.lang.Object | newInstance (UnusedPrivateParameter unused) |
| .lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable | internalGetFieldAccessorTable () |
| .lang.Override Builder | newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
Member Function Documentation
◆ equals()
|
inline |
Definition at line 771 of file MPModelRequest.java.
◆ getDefaultInstance()
|
inlinestatic |
Definition at line 1858 of file MPModelRequest.java.
◆ getDefaultInstanceForType()
|
inline |
Definition at line 1883 of file MPModelRequest.java.
◆ getDescriptor()
|
inlinestatic |
Definition at line 132 of file MPModelRequest.java.
◆ getEnableInternalSolverOutput()
|
inline |
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];
- Returns
- The enableInternalSolverOutput.
Implements MPModelRequestOrBuilder.
Definition at line 569 of file MPModelRequest.java.
◆ getModel()
|
inline |
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
- Returns
- The model.
Implements MPModelRequestOrBuilder.
Definition at line 467 of file MPModelRequest.java.
◆ getModelDelta()
|
inline |
Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
- Returns
- The modelDelta.
Implements MPModelRequestOrBuilder.
Definition at line 685 of file MPModelRequest.java.
◆ getModelDeltaOrBuilder()
|
inline |
Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
Implements MPModelRequestOrBuilder.
Definition at line 697 of file MPModelRequest.java.
◆ getModelOrBuilder()
|
inline |
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
Implements MPModelRequestOrBuilder.
Definition at line 478 of file MPModelRequest.java.
◆ getParserForType()
|
inline |
Definition at line 1878 of file MPModelRequest.java.
◆ getSerializedSize()
|
inline |
Definition at line 737 of file MPModelRequest.java.
◆ getSolverSpecificParameters()
|
inline |
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;
- Returns
- The solverSpecificParameters.
Implements MPModelRequestOrBuilder.
Definition at line 614 of file MPModelRequest.java.
◆ getSolverSpecificParametersBytes()
|
inline |
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;
- Returns
- The bytes for solverSpecificParameters.
Implements MPModelRequestOrBuilder.
Definition at line 647 of file MPModelRequest.java.
◆ getSolverTimeLimitSeconds()
|
inline |
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;
- Returns
- The solverTimeLimitSeconds.
Implements MPModelRequestOrBuilder.
Definition at line 536 of file MPModelRequest.java.
◆ getSolverType()
|
inline |
optional .operations_research.MPModelRequest.SolverType solver_type = 2;
- Returns
- The solverType.
Implements MPModelRequestOrBuilder.
Definition at line 495 of file MPModelRequest.java.
◆ getUnknownFields()
|
inline |
Definition at line 36 of file MPModelRequest.java.
◆ hasEnableInternalSolverOutput()
|
inline |
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];
- Returns
- Whether the enableInternalSolverOutput field is set.
Implements MPModelRequestOrBuilder.
Definition at line 554 of file MPModelRequest.java.
◆ hashCode()
|
inline |
Definition at line 815 of file MPModelRequest.java.
◆ hasModel()
|
inline |
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
- Returns
- Whether the model field is set.
Implements MPModelRequestOrBuilder.
Definition at line 455 of file MPModelRequest.java.
◆ hasModelDelta()
|
inline |
Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
- Returns
- Whether the modelDelta field is set.
Implements MPModelRequestOrBuilder.
Definition at line 672 of file MPModelRequest.java.
◆ hasSolverSpecificParameters()
|
inline |
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;
- Returns
- Whether the solverSpecificParameters field is set.
Implements MPModelRequestOrBuilder.
Definition at line 593 of file MPModelRequest.java.
◆ hasSolverTimeLimitSeconds()
|
inline |
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;
- Returns
- Whether the solverTimeLimitSeconds field is set.
Implements MPModelRequestOrBuilder.
Definition at line 518 of file MPModelRequest.java.
◆ hasSolverType()
|
inline |
optional .operations_research.MPModelRequest.SolverType solver_type = 2;
- Returns
- Whether the solverType field is set.
Implements MPModelRequestOrBuilder.
Definition at line 488 of file MPModelRequest.java.
◆ internalGetFieldAccessorTable()
|
inlineprotected |
Definition at line 138 of file MPModelRequest.java.
◆ isInitialized()
|
inline |
Definition at line 703 of file MPModelRequest.java.
◆ newBuilder() [1/2]
|
inlinestatic |
Definition at line 924 of file MPModelRequest.java.
◆ newBuilder() [2/2]
|
inlinestatic |
Definition at line 927 of file MPModelRequest.java.
◆ newBuilderForType() [1/2]
|
inline |
Definition at line 923 of file MPModelRequest.java.
◆ newBuilderForType() [2/2]
|
inlineprotected |
Definition at line 937 of file MPModelRequest.java.
◆ newInstance()
|
inlineprotected |
Definition at line 29 of file MPModelRequest.java.
◆ parseDelimitedFrom() [1/2]
|
inlinestatic |
Definition at line 896 of file MPModelRequest.java.
◆ parseDelimitedFrom() [2/2]
|
inlinestatic |
Definition at line 901 of file MPModelRequest.java.
◆ parseFrom() [1/10]
|
inlinestatic |
Definition at line 874 of file MPModelRequest.java.
◆ parseFrom() [2/10]
|
inlinestatic |
Definition at line 878 of file MPModelRequest.java.
◆ parseFrom() [3/10]
|
inlinestatic |
Definition at line 863 of file MPModelRequest.java.
◆ parseFrom() [4/10]
|
inlinestatic |
Definition at line 868 of file MPModelRequest.java.
◆ parseFrom() [5/10]
|
inlinestatic |
Definition at line 908 of file MPModelRequest.java.
◆ parseFrom() [6/10]
|
inlinestatic |
Definition at line 914 of file MPModelRequest.java.
◆ parseFrom() [7/10]
|
inlinestatic |
Definition at line 884 of file MPModelRequest.java.
◆ parseFrom() [8/10]
|
inlinestatic |
Definition at line 889 of file MPModelRequest.java.
◆ parseFrom() [9/10]
|
inlinestatic |
Definition at line 852 of file MPModelRequest.java.
◆ parseFrom() [10/10]
|
inlinestatic |
Definition at line 857 of file MPModelRequest.java.
◆ parser()
|
inlinestatic |
Definition at line 1873 of file MPModelRequest.java.
◆ toBuilder()
|
inline |
Definition at line 931 of file MPModelRequest.java.
◆ writeTo()
|
inline |
Definition at line 713 of file MPModelRequest.java.
Member Data Documentation
◆ ENABLE_INTERNAL_SOLVER_OUTPUT_FIELD_NUMBER
|
static |
Definition at line 540 of file MPModelRequest.java.
◆ MODEL_DELTA_FIELD_NUMBER
|
static |
Definition at line 660 of file MPModelRequest.java.
◆ MODEL_FIELD_NUMBER
|
static |
Definition at line 444 of file MPModelRequest.java.
◆ PARSER
|
static |
Definition at line 1863 of file MPModelRequest.java.
◆ SOLVER_SPECIFIC_PARAMETERS_FIELD_NUMBER
|
static |
Definition at line 573 of file MPModelRequest.java.
◆ SOLVER_TIME_LIMIT_SECONDS_FIELD_NUMBER
|
static |
Definition at line 501 of file MPModelRequest.java.
◆ SOLVER_TYPE_FIELD_NUMBER
|
static |
Definition at line 482 of file MPModelRequest.java.
The documentation for this class was generated from the following file: