Class LoadCollectionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.milvus.grpc.LoadCollectionRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadCollectionRequestOrBuilder, Serializable

public final class LoadCollectionRequest extends com.google.protobuf.GeneratedMessageV3 implements LoadCollectionRequestOrBuilder

 Load collection data into query nodes, then you can do vector search on this collection.
 
Protobuf type milvus.proto.milvus.LoadCollectionRequest
See Also:
  • Field Details

    • BASE_FIELD_NUMBER

      public static final int BASE_FIELD_NUMBER
      See Also:
    • DB_NAME_FIELD_NUMBER

      public static final int DB_NAME_FIELD_NUMBER
      See Also:
    • COLLECTION_NAME_FIELD_NUMBER

      public static final int COLLECTION_NAME_FIELD_NUMBER
      See Also:
    • REPLICA_NUMBER_FIELD_NUMBER

      public static final int REPLICA_NUMBER_FIELD_NUMBER
      See Also:
    • RESOURCE_GROUPS_FIELD_NUMBER

      public static final int RESOURCE_GROUPS_FIELD_NUMBER
      See Also:
    • REFRESH_FIELD_NUMBER

      public static final int REFRESH_FIELD_NUMBER
      See Also:
    • LOAD_FIELDS_FIELD_NUMBER

      public static final int LOAD_FIELDS_FIELD_NUMBER
      See Also:
    • SKIP_LOAD_DYNAMIC_FIELD_FIELD_NUMBER

      public static final int SKIP_LOAD_DYNAMIC_FIELD_FIELD_NUMBER
      See Also:
    • LOAD_PARAMS_FIELD_NUMBER

      public static final int LOAD_PARAMS_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • hasBase

      public boolean hasBase()
       Not useful for now
       
      .milvus.proto.common.MsgBase base = 1;
      Specified by:
      hasBase in interface LoadCollectionRequestOrBuilder
      Returns:
      Whether the base field is set.
    • getBase

      public MsgBase getBase()
       Not useful for now
       
      .milvus.proto.common.MsgBase base = 1;
      Specified by:
      getBase in interface LoadCollectionRequestOrBuilder
      Returns:
      The base.
    • getBaseOrBuilder

      public MsgBaseOrBuilder getBaseOrBuilder()
       Not useful for now
       
      .milvus.proto.common.MsgBase base = 1;
      Specified by:
      getBaseOrBuilder in interface LoadCollectionRequestOrBuilder
    • getDbName

      public String getDbName()
      string db_name = 2;
      Specified by:
      getDbName in interface LoadCollectionRequestOrBuilder
      Returns:
      The dbName.
    • getDbNameBytes

      public com.google.protobuf.ByteString getDbNameBytes()
      string db_name = 2;
      Specified by:
      getDbNameBytes in interface LoadCollectionRequestOrBuilder
      Returns:
      The bytes for dbName.
    • getCollectionName

      public String getCollectionName()
       The collection name you want to load
       
      string collection_name = 3;
      Specified by:
      getCollectionName in interface LoadCollectionRequestOrBuilder
      Returns:
      The collectionName.
    • getCollectionNameBytes

      public com.google.protobuf.ByteString getCollectionNameBytes()
       The collection name you want to load
       
      string collection_name = 3;
      Specified by:
      getCollectionNameBytes in interface LoadCollectionRequestOrBuilder
      Returns:
      The bytes for collectionName.
    • getReplicaNumber

      public int getReplicaNumber()
       The replica number to load, default by 1
       
      int32 replica_number = 4;
      Specified by:
      getReplicaNumber in interface LoadCollectionRequestOrBuilder
      Returns:
      The replicaNumber.
    • getResourceGroupsList

      public com.google.protobuf.ProtocolStringList getResourceGroupsList()
       create replica used resource group
       
      repeated string resource_groups = 5;
      Specified by:
      getResourceGroupsList in interface LoadCollectionRequestOrBuilder
      Returns:
      A list containing the resourceGroups.
    • getResourceGroupsCount

      public int getResourceGroupsCount()
       create replica used resource group
       
      repeated string resource_groups = 5;
      Specified by:
      getResourceGroupsCount in interface LoadCollectionRequestOrBuilder
      Returns:
      The count of resourceGroups.
    • getResourceGroups

      public String getResourceGroups(int index)
       create replica used resource group
       
      repeated string resource_groups = 5;
      Specified by:
      getResourceGroups in interface LoadCollectionRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceGroups at the given index.
    • getResourceGroupsBytes

      public com.google.protobuf.ByteString getResourceGroupsBytes(int index)
       create replica used resource group
       
      repeated string resource_groups = 5;
      Specified by:
      getResourceGroupsBytes in interface LoadCollectionRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceGroups at the given index.
    • getRefresh

      public boolean getRefresh()
       Whether to enable refresh mode.
       
      bool refresh = 6;
      Specified by:
      getRefresh in interface LoadCollectionRequestOrBuilder
      Returns:
      The refresh.
    • getLoadFieldsList

      public com.google.protobuf.ProtocolStringList getLoadFieldsList()
       Field Partial Load fields list
       
      repeated string load_fields = 7;
      Specified by:
      getLoadFieldsList in interface LoadCollectionRequestOrBuilder
      Returns:
      A list containing the loadFields.
    • getLoadFieldsCount

      public int getLoadFieldsCount()
       Field Partial Load fields list
       
      repeated string load_fields = 7;
      Specified by:
      getLoadFieldsCount in interface LoadCollectionRequestOrBuilder
      Returns:
      The count of loadFields.
    • getLoadFields

      public String getLoadFields(int index)
       Field Partial Load fields list
       
      repeated string load_fields = 7;
      Specified by:
      getLoadFields in interface LoadCollectionRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The loadFields at the given index.
    • getLoadFieldsBytes

      public com.google.protobuf.ByteString getLoadFieldsBytes(int index)
       Field Partial Load fields list
       
      repeated string load_fields = 7;
      Specified by:
      getLoadFieldsBytes in interface LoadCollectionRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the loadFields at the given index.
    • getSkipLoadDynamicField

      public boolean getSkipLoadDynamicField()
       Field Partial load skip load dynamic fields 
       
      bool skip_load_dynamic_field = 8;
      Specified by:
      getSkipLoadDynamicField in interface LoadCollectionRequestOrBuilder
      Returns:
      The skipLoadDynamicField.
    • getLoadParamsCount

      public int getLoadParamsCount()
      Description copied from interface: LoadCollectionRequestOrBuilder
       Additional parameters for load
       
      map<string, string> load_params = 9;
      Specified by:
      getLoadParamsCount in interface LoadCollectionRequestOrBuilder
    • containsLoadParams

      public boolean containsLoadParams(String key)
       Additional parameters for load
       
      map<string, string> load_params = 9;
      Specified by:
      containsLoadParams in interface LoadCollectionRequestOrBuilder
    • getLoadParams

      @Deprecated public Map<String,String> getLoadParams()
      Deprecated.
      Use getLoadParamsMap() instead.
      Specified by:
      getLoadParams in interface LoadCollectionRequestOrBuilder
    • getLoadParamsMap

      public Map<String,String> getLoadParamsMap()
       Additional parameters for load
       
      map<string, string> load_params = 9;
      Specified by:
      getLoadParamsMap in interface LoadCollectionRequestOrBuilder
    • getLoadParamsOrDefault

      public String getLoadParamsOrDefault(String key, String defaultValue)
       Additional parameters for load
       
      map<string, string> load_params = 9;
      Specified by:
      getLoadParamsOrDefault in interface LoadCollectionRequestOrBuilder
    • getLoadParamsOrThrow

      public String getLoadParamsOrThrow(String key)
       Additional parameters for load
       
      map<string, string> load_params = 9;
      Specified by:
      getLoadParamsOrThrow in interface LoadCollectionRequestOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • 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.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • 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 LoadCollectionRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

      public static LoadCollectionRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

      public static LoadCollectionRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LoadCollectionRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LoadCollectionRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LoadCollectionRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LoadCollectionRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LoadCollectionRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public LoadCollectionRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static LoadCollectionRequest.Builder newBuilder()
    • newBuilder

      public static LoadCollectionRequest.Builder newBuilder(LoadCollectionRequest prototype)
    • toBuilder

      public LoadCollectionRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected LoadCollectionRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static LoadCollectionRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<LoadCollectionRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<LoadCollectionRequest> 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.GeneratedMessageV3
    • getDefaultInstanceForType

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