Package com.influxdb.client.service

Interface BackupService

public interface BackupService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<okhttp3.ResponseBody>	getBackupKV(String zapTraceSpan)	Deprecated.
retrofit2.Call<MetadataBackup>	getBackupMetadata(String zapTraceSpan, String acceptEncoding)	Download snapshot of all metadata in the server
retrofit2.Call<okhttp3.ResponseBody>	getBackupShardId(Long shardID, String zapTraceSpan, String acceptEncoding, OffsetDateTime since)	Download snapshot of all TSM data in a shard

Method Details

getBackupKV

@Deprecated
@GET("api/v2/backup/kv")
retrofit2.Call<okhttp3.ResponseBody> getBackupKV(@Header("Zap-Trace-Span")
 String zapTraceSpan)

Deprecated.

Download snapshot of metadata stored in the server's embedded KV store. Should not be used in versions greater than 2.1.x, as it doesn't include metadata stored in embedded SQL.

Parameters:

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResponseBody>

getBackupMetadata

@GET("api/v2/backup/metadata")
retrofit2.Call<MetadataBackup> getBackupMetadata(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Accept-Encoding")
 String acceptEncoding)

Download snapshot of all metadata in the server

Parameters:

zapTraceSpan - OpenTracing span context (optional)

acceptEncoding - Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

Returns:

Call<MetadataBackup>

getBackupShardId

@GET("api/v2/backup/shards/{shardID}")
retrofit2.Call<okhttp3.ResponseBody> getBackupShardId(@Path("shardID")
 Long shardID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Accept-Encoding")
 String acceptEncoding,
 @Query("since")
 OffsetDateTime since)

Download snapshot of all TSM data in a shard

Parameters:

shardID - The shard ID. (required)

zapTraceSpan - OpenTracing span context (optional)

acceptEncoding - Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

since - Earliest time to include in the snapshot. RFC3339 format. (optional)

Returns:

Call<ResponseBody>