public final class MPModelRequest extends com.google.protobuf.GeneratedMessage implements MPModelRequestOrBuilder
Next id: 18.Protobuf type
operations_research.MPModelRequest
Modifier and Type | Class and Description |
---|---|
static class |
MPModelRequest.Builder
Next id: 18.
|
static class |
MPModelRequest.SolverType
The solver type, which will select a specific implementation, and will also
impact the interpretation of the model (i.e. are we solving the problem
as a mixed integer program or are we relaxing it as a continuous linear
program?).
|
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
ENABLE_INTERNAL_SOLVER_OUTPUT_FIELD_NUMBER |
static int |
IGNORE_SOLVER_SPECIFIC_PARAMETERS_FAILURE_FIELD_NUMBER |
static int |
MODEL_DELTA_FIELD_NUMBER |
static int |
MODEL_FIELD_NUMBER |
static int |
POPULATE_ADDITIONAL_SOLUTIONS_UP_TO_FIELD_NUMBER |
static int |
SOLVER_SPECIFIC_PARAMETERS_FIELD_NUMBER |
static int |
SOLVER_TIME_LIMIT_SECONDS_FIELD_NUMBER |
static int |
SOLVER_TYPE_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
static MPModelRequest |
getDefaultInstance() |
MPModelRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getEnableInternalSolverOutput()
If this is set, then EnableOutput() will be set on the internal MPSolver
that solves the model.
|
boolean |
getIgnoreSolverSpecificParametersFailure()
optional bool ignore_solver_specific_parameters_failure = 9 [default = false]; |
MPModelProto |
getModel()
The model to be optimized by the server.
|
MPModelDeltaProto |
getModelDelta()
Advanced usage: model "delta".
|
MPModelDeltaProtoOrBuilder |
getModelDeltaOrBuilder()
Advanced usage: model "delta".
|
MPModelProtoOrBuilder |
getModelOrBuilder()
The model to be optimized by the server.
|
com.google.protobuf.Parser<MPModelRequest> |
getParserForType() |
int |
getPopulateAdditionalSolutionsUpTo()
Controls the recovery of additional solutions, if any, saved by the
underlying solver back in the MPSolutionResponse.additional_solutions.
|
int |
getSerializedSize() |
java.lang.String |
getSolverSpecificParameters()
Advanced usage.
|
com.google.protobuf.ByteString |
getSolverSpecificParametersBytes()
Advanced usage.
|
double |
getSolverTimeLimitSeconds()
Maximum time to be spent by the solver to solve 'model'.
|
MPModelRequest.SolverType |
getSolverType()
optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING]; |
boolean |
hasEnableInternalSolverOutput()
If this is set, then EnableOutput() will be set on the internal MPSolver
that solves the model.
|
int |
hashCode() |
boolean |
hasIgnoreSolverSpecificParametersFailure()
optional bool ignore_solver_specific_parameters_failure = 9 [default = false]; |
boolean |
hasModel()
The model to be optimized by the server.
|
boolean |
hasModelDelta()
Advanced usage: model "delta".
|
boolean |
hasPopulateAdditionalSolutionsUpTo()
Controls the recovery of additional solutions, if any, saved by the
underlying solver back in the MPSolutionResponse.additional_solutions.
|
boolean |
hasSolverSpecificParameters()
Advanced usage.
|
boolean |
hasSolverTimeLimitSeconds()
Maximum time to be spent by the solver to solve 'model'.
|
boolean |
hasSolverType()
optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING]; |
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static MPModelRequest.Builder |
newBuilder() |
static MPModelRequest.Builder |
newBuilder(MPModelRequest prototype) |
MPModelRequest.Builder |
newBuilderForType() |
protected MPModelRequest.Builder |
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) |
static MPModelRequest |
parseDelimitedFrom(java.io.InputStream input) |
static MPModelRequest |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MPModelRequest |
parseFrom(byte[] data) |
static MPModelRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MPModelRequest |
parseFrom(java.nio.ByteBuffer data) |
static MPModelRequest |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MPModelRequest |
parseFrom(com.google.protobuf.ByteString data) |
static MPModelRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MPModelRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static MPModelRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MPModelRequest |
parseFrom(java.io.InputStream input) |
static MPModelRequest |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<MPModelRequest> |
parser() |
MPModelRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashFields, toString
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int MODEL_FIELD_NUMBER
public static final int SOLVER_TYPE_FIELD_NUMBER
public static final int SOLVER_TIME_LIMIT_SECONDS_FIELD_NUMBER
public static final int ENABLE_INTERNAL_SOLVER_OUTPUT_FIELD_NUMBER
public static final int SOLVER_SPECIFIC_PARAMETERS_FIELD_NUMBER
public static final int IGNORE_SOLVER_SPECIFIC_PARAMETERS_FAILURE_FIELD_NUMBER
public static final int MODEL_DELTA_FIELD_NUMBER
public static final int POPULATE_ADDITIONAL_SOLUTIONS_UP_TO_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessage
public boolean hasModel()
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
hasModel
in interface MPModelRequestOrBuilder
public MPModelProto getModel()
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
getModel
in interface MPModelRequestOrBuilder
public MPModelProtoOrBuilder getModelOrBuilder()
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
getModelOrBuilder
in interface MPModelRequestOrBuilder
public boolean hasSolverType()
optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];
hasSolverType
in interface MPModelRequestOrBuilder
public MPModelRequest.SolverType getSolverType()
optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];
getSolverType
in interface MPModelRequestOrBuilder
public 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;
hasSolverTimeLimitSeconds
in interface MPModelRequestOrBuilder
public double getSolverTimeLimitSeconds()
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;
getSolverTimeLimitSeconds
in interface MPModelRequestOrBuilder
public 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];
hasEnableInternalSolverOutput
in interface MPModelRequestOrBuilder
public boolean getEnableInternalSolverOutput()
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];
getEnableInternalSolverOutput
in interface MPModelRequestOrBuilder
public 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, unless you have set ignore_solver_specific_parameters_failure=true (in which case they are simply ignored).
optional string solver_specific_parameters = 5;
hasSolverSpecificParameters
in interface MPModelRequestOrBuilder
public 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, unless you have set ignore_solver_specific_parameters_failure=true (in which case they are simply ignored).
optional string solver_specific_parameters = 5;
getSolverSpecificParameters
in interface MPModelRequestOrBuilder
public com.google.protobuf.ByteString getSolverSpecificParametersBytes()
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, unless you have set ignore_solver_specific_parameters_failure=true (in which case they are simply ignored).
optional string solver_specific_parameters = 5;
getSolverSpecificParametersBytes
in interface MPModelRequestOrBuilder
public boolean hasIgnoreSolverSpecificParametersFailure()
optional bool ignore_solver_specific_parameters_failure = 9 [default = false];
hasIgnoreSolverSpecificParametersFailure
in interface MPModelRequestOrBuilder
public boolean getIgnoreSolverSpecificParametersFailure()
optional bool ignore_solver_specific_parameters_failure = 9 [default = false];
getIgnoreSolverSpecificParametersFailure
in interface MPModelRequestOrBuilder
public boolean hasModelDelta()
Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
hasModelDelta
in interface MPModelRequestOrBuilder
public MPModelDeltaProto getModelDelta()
Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
getModelDelta
in interface MPModelRequestOrBuilder
public MPModelDeltaProtoOrBuilder getModelDeltaOrBuilder()
Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
getModelDeltaOrBuilder
in interface MPModelRequestOrBuilder
public boolean hasPopulateAdditionalSolutionsUpTo()
Controls the recovery of additional solutions, if any, saved by the underlying solver back in the MPSolutionResponse.additional_solutions. The repeated field will be length min(populate_addition_solutions_up_to, #additional_solutions_available_in_underlying_solver) These additional solutions may have a worse objective than the main solution returned in the response.
optional int32 populate_additional_solutions_up_to = 11 [default = 0];
hasPopulateAdditionalSolutionsUpTo
in interface MPModelRequestOrBuilder
public int getPopulateAdditionalSolutionsUpTo()
Controls the recovery of additional solutions, if any, saved by the underlying solver back in the MPSolutionResponse.additional_solutions. The repeated field will be length min(populate_addition_solutions_up_to, #additional_solutions_available_in_underlying_solver) These additional solutions may have a worse objective than the main solution returned in the response.
optional int32 populate_additional_solutions_up_to = 11 [default = 0];
getPopulateAdditionalSolutionsUpTo
in interface MPModelRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessage
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessage
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessage
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static MPModelRequest parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static MPModelRequest parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static MPModelRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static MPModelRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static MPModelRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static MPModelRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static MPModelRequest parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static MPModelRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static MPModelRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static MPModelRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static MPModelRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static MPModelRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public MPModelRequest.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static MPModelRequest.Builder newBuilder()
public static MPModelRequest.Builder newBuilder(MPModelRequest prototype)
public MPModelRequest.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected MPModelRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.AbstractMessage
public static MPModelRequest getDefaultInstance()
public static com.google.protobuf.Parser<MPModelRequest> parser()
public com.google.protobuf.Parser<MPModelRequest> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessage
public MPModelRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2025. All rights reserved.