Configuring Timeouts | Ruby API Client V1 (Deprecated)

1
2
3
4
5
6
7
8
9
Algolia::Client.new({
  application_id: 'YourApplicationID',
  api_key: 'YourAdminAPIKey',
  connect_timeout: 2, # connection timeout in seconds
  receive_timeout: 30, # read timeout in seconds
  send_timeout: 30, # write timeout in seconds
  batch_timeout: 120,  # write timeout override for batches, in seconds
  search_timeout: 5    # read timeout override for queries, in seconds
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const client = algoliasearch(appId, apiKey, {
  timeouts: {
    connect: 2, // connection timeout in seconds
    read: 5, // read timeout in seconds
    write: 30 // write timeout in seconds
  }
});

const analytics = client.initAnalytics({
  timeouts: {
    connect: 2, // connection timeout in seconds
    read: 5, // read timeout in seconds
    write: 30 // write timeout in seconds
  }
});

const recommendation = client.initRecommendation({
  timeouts: {
    connect: 2, // connection timeout in seconds
    read: 5, // read timeout in seconds
    write: 30 // write timeout in seconds
  }
});

1
2
3
4
5
6
config = SearchConfig('YourApplicationID', 'YourAdminAPIKey')
config.connect_timeout = 2 # connection timeout in seconds
config.read_timeout = 5 # read timeout in seconds
config.write_timeout =  30 # write timeout in seconds

client = SearchClient.create_with_config(config)

1
2
3
4
5
let configuration = SearchConfiguration(applicationID: "YourApplicationID", apiKey: "YourAdminAPIKey")
  .set(\.readTimeout, to: 5) // read time out in seconds
  .set(\.writeTimeout, to: 30) // write time out in seconds

let client = SearchClient(configuration: configuration)

1
2
3
4
5
APIClient client = new ApiClient(...);
client.setConnectTimeout(2000); // connection timeout in milliseconds
client.setReadTimeout(30000); // read timeout in milliseconds
client.setSearchTimeout(5000) // read timeout for search requests in milliseconds
client.setHostDownDelay(5000); // delay before retrying a host we know was down, in milliseconds

1
2
3
4
5
6
7
var configuration = new SearchConfig("YourApplicationID", "YourAdminAPIKey")
{
  ConnectTimeout = 15, // connection timeout in seconds
  ReadTimeout = 5, // read timeout in seconds
  WriteTimeout = 30, // write timeout in seconds
  HostDownDelay = 300 // delay before retrying a host we know was down, in seconds (= 5 minutes)
};

1
2
3
4
5
6
7
8
9
SearchConfig configuration =
new SearchConfig.Builder("YourApplicationID", "YourAdminAPIKey")
  .setConnectTimeOut(2000) // connection timeout in milliseconds
  .setReadTimeOut(5000) // read timeout in milliseconds
  .setWriteTimeOut(30000) // write timeout in milliseconds
  .setHostDownDelay(300000) // delay before retrying a host we know was down, in milliseconds
  .build();

SearchClient client = DefaultSearchClient.create(configuration);

1
2
3
4
5
6
7
8
9
10
config := search.Configuration{
  AppID:        "YourApplicationID",
  APIKey:       "YourAdminAPIKey",
  ConnectTimeout: 2 * time.Second, // connection timeout in seconds
  ReadTimeout: 5 * time.Second, // read timeout in seconds
  WriteTimeout: 30 * time.Second, // write timeout in seconds
  HostDownDelay: 5 * 60 * time.Second // delay before retrying a host we know was down, in seconds (= 5 minutes)
}

client := search.NewClientWithConfig(config)

1
2
3
4
5
6
7
8
val configuration = AlgoliaClientConfiguration(
  httpConnectTimeoutMs = 2 * 1000, // connection timeout in milliseconds
  httpReadTimeoutMs = 2 * 1000, // read timeout in milliseconds
  httpRequestTimeoutMs = 2 * 1000, // write timeout in milliseconds
  dnsTimeoutMs = 2 * 100, // DNS connection timeout in milliseconds
  hostDownTimeoutMs = 5 * 60 * 1000 // delay before retrying a host we know was down, in milliseconds
)
new AlgoliaClient(applicationId, apiKey, configuration = configuration)

1
2
3
4
5
6
7
val configuration = ConfigurationSearch(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourAdminAPIKey"),
    readTimeout = 50, // read timeout in seconds
    writeTimeout = 30 // write timeout in seconds
)
ClientSearch(configuration)