Package io.weaviate.client.v1.backup.api

Class BackupCanceler

java.lang.Object

io.weaviate.client.base.BaseClient<Void>

io.weaviate.client.v1.backup.api.BackupCanceler

All Implemented Interfaces:

ClientResult<Void>

public class BackupCanceler
extends BaseClient<Void>
implements ClientResult<Void>

BackupCanceler can cancel an in-progress backup by ID.

Canceling backups which have successfully completed before being interrupted is not supported and will result in an error.

Field Summary

Fields inherited from class io.weaviate.client.base.BaseClient

config, serializer

Constructor Summary

Constructors

Constructor	Description
BackupCanceler(HttpClient client, Config config)

Method Summary

Modifier and Type	Method	Description
Result<Void>	run()
BackupCanceler	withBackend(String backend)
BackupCanceler	withBackupId(String backupId)
BackupCanceler	withBucket(String bucket)
BackupCanceler	withPath(String path)

Methods inherited from class io.weaviate.client.base.BaseClient

getWeaviateErrorResponse, sendDeleteRequest, sendGetRequest, sendHeadRequest, sendHttpRequest, sendPatchRequest, sendPostRequest, sendPutRequest, toResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BackupCanceler

public BackupCanceler(HttpClient client,
 Config config)

Method Details

withBackend

public BackupCanceler withBackend(String backend)

withBucket

public BackupCanceler withBucket(String bucket)

withPath

public BackupCanceler withPath(String path)

withBackupId

public BackupCanceler withBackupId(String backupId)

run

public Result<Void> run()

Specified by:

run in interface ClientResult<Void>