Class LoadCollectionParam.Builder

Method Detail

• withCollectionName

  public LoadCollectionParam.Builder withCollectionName​(@NonNull
                                                        @NonNull java.lang.String collectionName)

  Sets the collection name. Collection name cannot be empty or null.

  Parameters:

  collectionName - collection name

  Returns:

  Builder

• withSyncLoad

  public LoadCollectionParam.Builder withSyncLoad​(@NonNull
                                                  @NonNull java.lang.Boolean syncLoad)

  Enable sync mode for load action. With sync mode enabled, the client keeps waiting until all segments of the collection successfully loaded. If sync mode disabled, client returns at once after the loadCollection() is called.

  Parameters:

  syncLoad - Boolean.TRUE is sync mode, Boolean.FALSE is not

  Returns:

  Builder

• withSyncLoadWaitingInterval

  public LoadCollectionParam.Builder withSyncLoadWaitingInterval​(@NonNull
                                                                 @NonNull java.lang.Long milliseconds)

  Sets waiting interval in sync mode. With sync mode enabled, the client will constantly check collection load state by interval. Interval must be greater than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_INTERVAL.

  Parameters:

  milliseconds - interval

  Returns:

  Builder

  See Also:

  Constant

• withSyncLoadWaitingTimeout

  public LoadCollectionParam.Builder withSyncLoadWaitingTimeout​(@NonNull
                                                                @NonNull java.lang.Long seconds)

  Sets timeout value for the 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:

  Constant

• build

  public LoadCollectionParam build()
                            throws ParamException

  Verifies parameters and creates a new LoadCollectionParam instance.

  Returns:

  LoadCollectionParam

  Throws:

  ParamException