Class MPModelProto.Annotation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.linearsolver.MPModelProto.Annotation
All Implemented Interfaces:
MPModelProto.AnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
MPModelProto
public static final class MPModelProto.Annotation extends com.google.protobuf.GeneratedMessage implements MPModelProto.AnnotationOrBuilder
 Annotations can be freely added by users who want to attach arbitrary
 payload to the model's variables or constraints.
Protobuf type operations_research.MPModelProto.Annotation
See Also:

  • Field Details

    • TARGET_TYPE_FIELD_NUMBER

      public static final int TARGET_TYPE_FIELD_NUMBER
      See Also:

    • TARGET_INDEX_FIELD_NUMBER

      public static final int TARGET_INDEX_FIELD_NUMBER
      See Also:

    • TARGET_NAME_FIELD_NUMBER

      public static final int TARGET_NAME_FIELD_NUMBER
      See Also:

    • PAYLOAD_KEY_FIELD_NUMBER

      public static final int PAYLOAD_KEY_FIELD_NUMBER
      See Also:

    • PAYLOAD_VALUE_FIELD_NUMBER

      public static final int PAYLOAD_VALUE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasTargetType

      public boolean hasTargetType()
      optional .operations_research.MPModelProto.Annotation.TargetType target_type = 1;
      Specified by:
      hasTargetType in interface MPModelProto.AnnotationOrBuilder
      Returns:
      Whether the targetType field is set.

    • getTargetType

      public MPModelProto.Annotation.TargetType getTargetType()
      optional .operations_research.MPModelProto.Annotation.TargetType target_type = 1;
      Specified by:
      getTargetType in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The targetType.

    • hasTargetIndex

      public boolean hasTargetIndex()
       If both `target_index` and `target_name` are set, they must point to the
 same entity.
      optional int32 target_index = 2;
      Specified by:
      hasTargetIndex in interface MPModelProto.AnnotationOrBuilder
      Returns:
      Whether the targetIndex field is set.

    • getTargetIndex

      public int getTargetIndex()
       If both `target_index` and `target_name` are set, they must point to the
 same entity.
      optional int32 target_index = 2;
      Specified by:
      getTargetIndex in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The targetIndex.

    • hasTargetName

      public boolean hasTargetName()
       Alternate to index. Assumes uniqueness.
      optional string target_name = 3;
      Specified by:
      hasTargetName in interface MPModelProto.AnnotationOrBuilder
      Returns:
      Whether the targetName field is set.

    • getTargetName

      public String getTargetName()
       Alternate to index. Assumes uniqueness.
      optional string target_name = 3;
      Specified by:
      getTargetName in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The targetName.

    • getTargetNameBytes

      public com.google.protobuf.ByteString getTargetNameBytes()
       Alternate to index. Assumes uniqueness.
      optional string target_name = 3;
      Specified by:
      getTargetNameBytes in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The bytes for targetName.

    • hasPayloadKey

      public boolean hasPayloadKey()
       The payload is a (key, value) string pair. Depending on the use cases,
 one of the two may be omitted.
      optional string payload_key = 4;
      Specified by:
      hasPayloadKey in interface MPModelProto.AnnotationOrBuilder
      Returns:
      Whether the payloadKey field is set.

    • getPayloadKey

      public String getPayloadKey()
       The payload is a (key, value) string pair. Depending on the use cases,
 one of the two may be omitted.
      optional string payload_key = 4;
      Specified by:
      getPayloadKey in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The payloadKey.

    • getPayloadKeyBytes

      public com.google.protobuf.ByteString getPayloadKeyBytes()
       The payload is a (key, value) string pair. Depending on the use cases,
 one of the two may be omitted.
      optional string payload_key = 4;
      Specified by:
      getPayloadKeyBytes in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The bytes for payloadKey.

    • hasPayloadValue

      public boolean hasPayloadValue()
      optional string payload_value = 5;
      Specified by:
      hasPayloadValue in interface MPModelProto.AnnotationOrBuilder
      Returns:
      Whether the payloadValue field is set.

    • getPayloadValue

      public String getPayloadValue()
      optional string payload_value = 5;
      Specified by:
      getPayloadValue in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The payloadValue.

    • getPayloadValueBytes

      public com.google.protobuf.ByteString getPayloadValueBytes()
      optional string payload_value = 5;
      Specified by:
      getPayloadValueBytes in interface MPModelProto.AnnotationOrBuilder
      Returns:
      The bytes for payloadValue.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static MPModelProto.Annotation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MPModelProto.Annotation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MPModelProto.Annotation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPModelProto.Annotation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public MPModelProto.Annotation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static MPModelProto.Annotation.Builder newBuilder()

    • newBuilder

      public static MPModelProto.Annotation.Builder newBuilder(MPModelProto.Annotation prototype)

    • toBuilder

      public MPModelProto.Annotation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected MPModelProto.Annotation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MPModelProto.Annotation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MPModelProto.Annotation> parser()

    • getParserForType

      public com.google.protobuf.Parser<MPModelProto.Annotation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public MPModelProto.Annotation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder