Package io.milvus.param.partition

Class LoadPartitionsParam.Builder

java.lang.Object
io.milvus.param.partition.LoadPartitionsParam.Builder
Enclosing class:
LoadPartitionsParam
public static final class LoadPartitionsParam.Builder extends Object
Builder for LoadPartitionsParam class.

  • Method Details

    • withDatabaseName

      public LoadPartitionsParam.Builder withDatabaseName(String databaseName)
      Sets the database name. database name can be nil.
      Parameters:
      databaseName - database name
      Returns:
      Builder

    • withCollectionName

      public LoadPartitionsParam.Builder withCollectionName(@NonNull @NonNull String collectionName)
      Sets the collection name. Collection name cannot be empty or null.
      Parameters:
      collectionName - collection name
      Returns:
      Builder

    • withPartitionNames

      public LoadPartitionsParam.Builder withPartitionNames(@NonNull @NonNull List<String> partitionNames)
      Sets the partition names list. Partition names list cannot be null or empty.
      Parameters:
      partitionNames - partition names list
      Returns:
      Builder

    • addPartitionName

      public LoadPartitionsParam.Builder addPartitionName(@NonNull @NonNull String partitionName)
      Adds a partition by name. Partition name cannot be empty or null.
      Parameters:
      partitionName - partition name
      Returns:
      Builder

    • withSyncLoad

      public LoadPartitionsParam.Builder withSyncLoad(@NonNull @NonNull Boolean syncLoad)
      Enables sync mode for load action. With sync mode enabled, the client keeps waiting until all segments of the partition are successfully loaded.

      Without sync mode disabled, client returns at once after the loadPartitions() is called.

      Parameters:
      syncLoad - Boolean.TRUE is sync mode, Boolean.FALSE is not
      Returns:
      Builder

    • withSyncLoadWaitingInterval

      public LoadPartitionsParam.Builder withSyncLoadWaitingInterval(@NonNull @NonNull Long milliseconds)
      Sets the waiting interval for sync mode. In sync mode, the client constantly checks partition load state by interval. Interval must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_INTERVAL.
      Parameters:
      milliseconds - interval
      Returns:
      Builder
      See Also:

    • withSyncLoadWaitingTimeout

      public LoadPartitionsParam.Builder withSyncLoadWaitingTimeout(@NonNull @NonNull Long seconds)
      Sets the timeout value for sync mode. Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_TIMEOUT.
      Parameters:
      seconds - time out value for sync mode
      Returns:
      Builder
      See Also:

    • withReplicaNumber

      public LoadPartitionsParam.Builder withReplicaNumber(@NonNull @NonNull Integer replicaNumber)
      Specify replica number to load
      Parameters:
      replicaNumber - replica number
      Returns:
      Builder

    • withRefresh

      public LoadPartitionsParam.Builder withRefresh(@NonNull @NonNull Boolean refresh)
      Whether to enable refresh mode. Refresh mode renews the segment list of this collection before loading. This flag must be set to FALSE when first time call the loadPartitions(). After loading a collection, call loadPartitions() again with refresh=TRUE, the server will look for new segments that are not loaded yet and tries to load them up.
      Parameters:
      refresh - Boolean.TRUE is refresh mode, Boolean.FALSE is not
      Returns:
      Builder

    • withResourceGroups

      public LoadPartitionsParam.Builder withResourceGroups(@NonNull @NonNull List<String> resourceGroups)
      Specify the target resource groups to load the replicas. If not specified, the replicas will be loaded into the default resource group.
      Parameters:
      resourceGroups - a List of String
      Returns:
      Builder

    • build

      public LoadPartitionsParam build() throws ParamException
      Verifies parameters and creates a new LoadPartitionsParam instance.
      Returns:
      LoadPartitionsParam
      Throws:
      ParamException