Partially update a task

Partially updates a task by its ID.

Required ACL: addObject, deleteIndex, editSettings

Usage

C#

// Initialize the client
var client = new IngestionClient(
  new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);

// Call the API
var response = await client.UpdateTaskAsync(
  "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  new TaskUpdate { Enabled = false, Cron = "* * * * *" }
);

// print the response
Console.WriteLine(response);

// Initialize the client
final client = IngestionClient(
    appId: 'ALGOLIA_APPLICATION_ID',
    apiKey: 'ALGOLIA_API_KEY',
    region: 'ALGOLIA_APPLICATION_REGION');

// Call the API
final response = await client.updateTask(
  taskID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  taskUpdate: TaskUpdate(
    enabled: false,
    cron: "* * * * *",
  ),
);

// print the response
print(response);

// Initialize the client with your application region, eg. ingestion.ALGOLIA_APPLICATION_REGION
client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", ingestion.US)
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

// Call the API
response, err := client.UpdateTask(client.NewApiUpdateTaskRequest(
  "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  ingestion.NewEmptyTaskUpdate().SetEnabled(false).SetCron("* * * * *")))
if err != nil {
  // handle the eventual error
  panic(err)
}


// print the response
print(response)

// Initialize the client
IngestionClient client = new IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");

// Call the API
TaskUpdateResponse response = client.updateTask(
  "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  new TaskUpdate().setEnabled(false).setCron("* * * * *")
);

// print the response
System.out.println(response);

// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIngestion({ region: 'us' });

// Call the API
const response = await client.updateTask({
  taskID: '6c02aeb1-775e-418e-870b-1faccd4b2c0f',
  taskUpdate: { enabled: false, cron: '* * * * *' },
});


// print the response
console.log(response);

// Initialize the client
val client =
  IngestionClient(
    appId = "ALGOLIA_APPLICATION_ID",
    apiKey = "ALGOLIA_API_KEY",
    region = "ALGOLIA_APPLICATION_REGION",
  )

// Call the API
var response =
  client.updateTask(
    taskID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
    taskUpdate = TaskUpdate(enabled = false, cron = "* * * * *"),
  )


// print the response
println(response)

// Initialize the client
$client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');

// Call the API
$response = $client->updateTask(
    '6c02aeb1-775e-418e-870b-1faccd4b2c0f',
    ['enabled' => false,
        'cron' => '* * * * *',
    ],
);


// print the response
var_dump($response);

# Initialize the client
# In an asynchronous context, you can use IngestionClient instead, which exposes the exact same methods.
client = IngestionClientSync(
    "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)

# Call the API
response = client.update_task(
    task_id="6c02aeb1-775e-418e-870b-1faccd4b2c0f",
    task_update={
        "enabled": False,
        "cron": "* * * * *",
    },
)


# print the response
print(response)

# Initialize the client
client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")

# Call the API
response = client.update_task(
  "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  Algolia::Ingestion::TaskUpdate.new(enabled: false, cron: "* * * * *")
)


# print the response
puts(response)

// Initialize the client
val client = IngestionClient(
  appId = "ALGOLIA_APPLICATION_ID",
  apiKey = "ALGOLIA_API_KEY",
  region = "ALGOLIA_APPLICATION_REGION"
)

// Call the API
val response = Await.result(
  client.updateTask(
    taskID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
    taskUpdate = TaskUpdate(
      enabled = Some(false),
      cron = Some("* * * * *")
    )
  ),
  Duration(100, "sec")
)

// print the response
println(response)

// Initialize the client
let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)

// Call the API
let response = try await client.updateTask(
    taskID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
    taskUpdate: TaskUpdate(cron: "* * * * *", enabled: false)
)

// print the response
print(response)

See the full API reference

For more details about input parameters and response fields.