Java Reference

Java Reference

MPModelRequest.Builder

Detailed Description

Next id: 9.

Protobuf type

operations_research.MPModelRequest

Definition at line 949 of file MPModelRequest.java.

Public Member Functions

.lang.Override Builder clear ()
 
.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ()
 
.lang.Override com.google.ortools.linearsolver.MPModelRequest getDefaultInstanceForType ()
 
.lang.Override com.google.ortools.linearsolver.MPModelRequest build ()
 
.lang.Override com.google.ortools.linearsolver.MPModelRequest buildPartial ()
 
.lang.Override Builder clone ()
 
.lang.Override Builder setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder clearField (com.google.protobuf.Descriptors.FieldDescriptor field)
 
.lang.Override Builder clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)
 
.lang.Override Builder setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
 
.lang.Override Builder addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder mergeFrom (com.google.protobuf.Message other)
 
Builder mergeFrom (com.google.ortools.linearsolver.MPModelRequest other)
 
.lang.Override final boolean isInitialized ()
 
.lang.Override Builder mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
boolean hasModel ()
 
com.google.ortools.linearsolver.MPModelProto getModel ()
 
Builder setModel (com.google.ortools.linearsolver.MPModelProto value)
 
Builder setModel (com.google.ortools.linearsolver.MPModelProto.Builder builderForValue)
 
Builder mergeModel (com.google.ortools.linearsolver.MPModelProto value)
 
Builder clearModel ()
 
com.google.ortools.linearsolver.MPModelProto.Builder getModelBuilder ()
 
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...
 
Builder setSolverType (com.google.ortools.linearsolver.MPModelRequest.SolverType value)
 optional .operations_research.MPModelRequest.SolverType solver_type = 2; More...
 
Builder clearSolverType ()
 optional .operations_research.MPModelRequest.SolverType solver_type = 2; More...
 
.lang.Override boolean hasSolverTimeLimitSeconds ()
 
.lang.Override double getSolverTimeLimitSeconds ()
 
Builder setSolverTimeLimitSeconds (double value)
 
Builder clearSolverTimeLimitSeconds ()
 
.lang.Override boolean hasEnableInternalSolverOutput ()
 
.lang.Override boolean getEnableInternalSolverOutput ()
 
Builder setEnableInternalSolverOutput (boolean value)
 
Builder clearEnableInternalSolverOutput ()
 
boolean hasSolverSpecificParameters ()
 
java.lang.String getSolverSpecificParameters ()
 
com.google.protobuf.ByteString getSolverSpecificParametersBytes ()
 
Builder setSolverSpecificParameters (java.lang.String value)
 
Builder clearSolverSpecificParameters ()
 
Builder setSolverSpecificParametersBytes (com.google.protobuf.ByteString value)
 
boolean hasModelDelta ()
 
com.google.ortools.linearsolver.MPModelDeltaProto getModelDelta ()
 
Builder setModelDelta (com.google.ortools.linearsolver.MPModelDeltaProto value)
 
Builder setModelDelta (com.google.ortools.linearsolver.MPModelDeltaProto.Builder builderForValue)
 
Builder mergeModelDelta (com.google.ortools.linearsolver.MPModelDeltaProto value)
 
Builder clearModelDelta ()
 
com.google.ortools.linearsolver.MPModelDeltaProto.Builder getModelDeltaBuilder ()
 
com.google.ortools.linearsolver.MPModelDeltaProtoOrBuilder getModelDeltaOrBuilder ()
 
.lang.Override final Builder setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 
.lang.Override final Builder mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 

Protected Member Functions

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ()
 

Member Function Documentation

◆ addRepeatedField()

.lang.Override Builder addRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 1098 of file MPModelRequest.java.

◆ build()

.lang.Override com.google.ortools.linearsolver.MPModelRequest build ( )
inline

Definition at line 1021 of file MPModelRequest.java.

◆ buildPartial()

.lang.Override com.google.ortools.linearsolver.MPModelRequest buildPartial ( )
inline

Definition at line 1030 of file MPModelRequest.java.

◆ clear()

.lang.Override Builder clear ( )
inline

Definition at line 984 of file MPModelRequest.java.

◆ clearEnableInternalSolverOutput()

Builder clearEnableInternalSolverOutput ( )
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
This builder for chaining.

Definition at line 1503 of file MPModelRequest.java.

◆ clearField()

.lang.Override Builder clearField ( com.google.protobuf.Descriptors.FieldDescriptor  field)
inline

Definition at line 1082 of file MPModelRequest.java.

◆ clearModel()

Builder clearModel ( )
inline
The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Definition at line 1263 of file MPModelRequest.java.

◆ clearModelDelta()

Builder clearModelDelta ( )
inline
Advanced usage: model "delta". If used, "model" must be unset. See the
definition of MPModelDeltaProto.

optional .operations_research.MPModelDeltaProto model_delta = 8;

Definition at line 1776 of file MPModelRequest.java.

◆ clearOneof()

.lang.Override Builder clearOneof ( com.google.protobuf.Descriptors.OneofDescriptor  oneof)
inline

Definition at line 1087 of file MPModelRequest.java.

◆ clearSolverSpecificParameters()

Builder clearSolverSpecificParameters ( )
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
This builder for chaining.

Definition at line 1637 of file MPModelRequest.java.

◆ clearSolverTimeLimitSeconds()

Builder clearSolverTimeLimitSeconds ( )
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
This builder for chaining.

Definition at line 1436 of file MPModelRequest.java.

◆ clearSolverType()

Builder clearSolverType ( )
inline

optional .operations_research.MPModelRequest.SolverType solver_type = 2;

Returns
This builder for chaining.

Definition at line 1357 of file MPModelRequest.java.

◆ clone()

.lang.Override Builder clone ( )
inline

Definition at line 1072 of file MPModelRequest.java.

◆ getDefaultInstanceForType()

.lang.Override com.google.ortools.linearsolver.MPModelRequest getDefaultInstanceForType ( )
inline

Definition at line 1016 of file MPModelRequest.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ( )
inlinestatic

Definition at line 954 of file MPModelRequest.java.

◆ getDescriptorForType()

.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ( )
inline

Definition at line 1011 of file MPModelRequest.java.

◆ getEnableInternalSolverOutput()

.lang.Override boolean 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 1471 of file MPModelRequest.java.

◆ getModel()

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Returns
The model.

Implements MPModelRequestOrBuilder.

Definition at line 1187 of file MPModelRequest.java.

◆ getModelBuilder()

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Definition at line 1280 of file MPModelRequest.java.

◆ getModelDelta()

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 1696 of file MPModelRequest.java.

◆ getModelDeltaBuilder()

Advanced usage: model "delta". If used, "model" must be unset. See the
definition of MPModelDeltaProto.

optional .operations_research.MPModelDeltaProto model_delta = 8;

Definition at line 1794 of file MPModelRequest.java.

◆ getModelDeltaOrBuilder()

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 1807 of file MPModelRequest.java.

◆ getModelOrBuilder()

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Implements MPModelRequestOrBuilder.

Definition at line 1292 of file MPModelRequest.java.

◆ getSolverSpecificParameters()

java.lang.String 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 1548 of file MPModelRequest.java.

◆ getSolverSpecificParametersBytes()

com.google.protobuf.ByteString 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 1580 of file MPModelRequest.java.

◆ getSolverTimeLimitSeconds()

.lang.Override double 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 1398 of file MPModelRequest.java.

◆ getSolverType()

.lang.Override com.google.ortools.linearsolver.MPModelRequest.SolverType getSolverType ( )
inline

optional .operations_research.MPModelRequest.SolverType solver_type = 2;

Returns
The solverType.

Implements MPModelRequestOrBuilder.

Definition at line 1334 of file MPModelRequest.java.

◆ hasEnableInternalSolverOutput()

.lang.Override boolean 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 1456 of file MPModelRequest.java.

◆ hasModel()

boolean 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 1176 of file MPModelRequest.java.

◆ hasModelDelta()

boolean 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 1684 of file MPModelRequest.java.

◆ hasSolverSpecificParameters()

boolean 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 1528 of file MPModelRequest.java.

◆ hasSolverTimeLimitSeconds()

.lang.Override boolean 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 1380 of file MPModelRequest.java.

◆ hasSolverType()

.lang.Override boolean hasSolverType ( )
inline

optional .operations_research.MPModelRequest.SolverType solver_type = 2;

Returns
Whether the solverType field is set.

Implements MPModelRequestOrBuilder.

Definition at line 1326 of file MPModelRequest.java.

◆ internalGetFieldAccessorTable()

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ( )
inlineprotected

Definition at line 960 of file MPModelRequest.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )
inline

Definition at line 1141 of file MPModelRequest.java.

◆ mergeFrom() [1/3]

Definition at line 1113 of file MPModelRequest.java.

◆ mergeFrom() [2/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.CodedInputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inline

Definition at line 1146 of file MPModelRequest.java.

◆ mergeFrom() [3/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.Message  other)
inline

Definition at line 1104 of file MPModelRequest.java.

◆ mergeModel()

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Definition at line 1239 of file MPModelRequest.java.

◆ mergeModelDelta()

Advanced usage: model "delta". If used, "model" must be unset. See the
definition of MPModelDeltaProto.

optional .operations_research.MPModelDeltaProto model_delta = 8;

Definition at line 1751 of file MPModelRequest.java.

◆ mergeUnknownFields()

.lang.Override final Builder mergeUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 1843 of file MPModelRequest.java.

◆ setEnableInternalSolverOutput()

Builder setEnableInternalSolverOutput ( boolean  value)
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];

Parameters
valueThe enableInternalSolverOutput to set.
Returns
This builder for chaining.

Definition at line 1486 of file MPModelRequest.java.

◆ setField()

.lang.Override Builder setField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 1076 of file MPModelRequest.java.

◆ setModel() [1/2]

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Definition at line 1201 of file MPModelRequest.java.

◆ setModel() [2/2]

Builder setModel ( com.google.ortools.linearsolver.MPModelProto.Builder  builderForValue)
inline
The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Definition at line 1221 of file MPModelRequest.java.

◆ setModelDelta() [1/2]

Advanced usage: model "delta". If used, "model" must be unset. See the
definition of MPModelDeltaProto.

optional .operations_research.MPModelDeltaProto model_delta = 8;

Definition at line 1711 of file MPModelRequest.java.

◆ setModelDelta() [2/2]

Builder setModelDelta ( com.google.ortools.linearsolver.MPModelDeltaProto.Builder  builderForValue)
inline
Advanced usage: model "delta". If used, "model" must be unset. See the
definition of MPModelDeltaProto.

optional .operations_research.MPModelDeltaProto model_delta = 8;

Definition at line 1732 of file MPModelRequest.java.

◆ setRepeatedField()

.lang.Override Builder setRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
int  index,
java.lang.Object  value 
)
inline

Definition at line 1092 of file MPModelRequest.java.

◆ setSolverSpecificParameters()

Builder setSolverSpecificParameters ( java.lang.String  value)
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;

Parameters
valueThe solverSpecificParameters to set.
Returns
This builder for chaining.

Definition at line 1610 of file MPModelRequest.java.

◆ setSolverSpecificParametersBytes()

Builder setSolverSpecificParametersBytes ( com.google.protobuf.ByteString  value)
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;

Parameters
valueThe bytes for solverSpecificParameters to set.
Returns
This builder for chaining.

Definition at line 1661 of file MPModelRequest.java.

◆ setSolverTimeLimitSeconds()

Builder setSolverTimeLimitSeconds ( double  value)
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;

Parameters
valueThe solverTimeLimitSeconds to set.
Returns
This builder for chaining.

Definition at line 1416 of file MPModelRequest.java.

◆ setSolverType()

optional .operations_research.MPModelRequest.SolverType solver_type = 2;

Parameters
valueThe solverType to set.
Returns
This builder for chaining.

Definition at line 1344 of file MPModelRequest.java.

◆ setUnknownFields()

.lang.Override final Builder setUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 1837 of file MPModelRequest.java.


The documentation for this class was generated from the following file: