com.influxdb.client.service

Interface RestoreService

public interface RestoreService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<RestoredBucketMappings>	postRestoreBucketMetadata(BucketMetadataManifest bucketMetadataManifest, String zapTraceSpan) Create a new bucket pre-seeded with shard info from a backup.
retrofit2.Call<Void>	postRestoreKV(File body, String zapTraceSpan, String contentEncoding, String contentType) Overwrite the embedded KV store on the server with a backed-up snapshot.
retrofit2.Call<Void>	postRestoreShardId(String shardID, File body, String zapTraceSpan, String contentEncoding, String contentType) Restore a TSM snapshot into a shard.
retrofit2.Call<Void>	postRestoreSQL(File body, String zapTraceSpan, String contentEncoding, String contentType) Overwrite the embedded SQL store on the server with a backed-up snapshot.

Method Detail

postRestoreBucketMetadata

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/restore/bucket-metadata")
retrofit2.Call<RestoredBucketMappings> postRestoreBucketMetadata(@Body
                                                                                                                                                                BucketMetadataManifest bucketMetadataManifest,
                                                                                                                                                                @Header(value="Zap-Trace-Span")
                                                                                                                                                                String zapTraceSpan)

Create a new bucket pre-seeded with shard info from a backup.

Parameters:

bucketMetadataManifest - Metadata manifest for a bucket. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<RestoredBucketMappings>

postRestoreKV

@Headers(value="Content-Type:text/plain")
 @POST(value="api/v2/restore/kv")
retrofit2.Call<Void> postRestoreKV(@Body
                                                                                                               File body,
                                                                                                               @Header(value="Zap-Trace-Span")
                                                                                                               String zapTraceSpan,
                                                                                                               @Header(value="Content-Encoding")
                                                                                                               String contentEncoding,
                                                                                                               @Header(value="Content-Type")
                                                                                                               String contentType)

Overwrite the embedded KV store on the server with a backed-up snapshot.

Parameters:

body - Full KV snapshot. (required)

zapTraceSpan - OpenTracing span context (optional)

contentEncoding - When present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to identity)

contentType - (optional, default to application/octet-stream)

Returns:

Call<Void>

postRestoreSQL

@Headers(value="Content-Type:text/plain")
 @POST(value="api/v2/restore/sql")
retrofit2.Call<Void> postRestoreSQL(@Body
                                                                                                                 File body,
                                                                                                                 @Header(value="Zap-Trace-Span")
                                                                                                                 String zapTraceSpan,
                                                                                                                 @Header(value="Content-Encoding")
                                                                                                                 String contentEncoding,
                                                                                                                 @Header(value="Content-Type")
                                                                                                                 String contentType)

Overwrite the embedded SQL store on the server with a backed-up snapshot.

Parameters:

body - Full SQL snapshot. (required)

zapTraceSpan - OpenTracing span context (optional)

contentEncoding - When present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to identity)

contentType - (optional, default to application/octet-stream)

Returns:

Call<Void>

postRestoreShardId

@Headers(value="Content-Type:text/plain")
 @POST(value="api/v2/restore/shards/{shardID}")
retrofit2.Call<Void> postRestoreShardId(@Path(value="shardID")
                                                                                                                                  String shardID,
                                                                                                                                  @Body
                                                                                                                                  File body,
                                                                                                                                  @Header(value="Zap-Trace-Span")
                                                                                                                                  String zapTraceSpan,
                                                                                                                                  @Header(value="Content-Encoding")
                                                                                                                                  String contentEncoding,
                                                                                                                                  @Header(value="Content-Type")
                                                                                                                                  String contentType)

Restore a TSM snapshot into a shard.

Parameters:

shardID - The shard ID. (required)

body - TSM snapshot. (required)

zapTraceSpan - OpenTracing span context (optional)

contentEncoding - When present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to identity)

contentType - (optional, default to application/octet-stream)

Returns:

Call<Void>