Package com.influxdb.client.service

Interface RestoreService

public interface RestoreService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<byte[]>	postRestoreBucketID(String bucketID, byte[] body, String zapTraceSpan, String contentType)	Deprecated.
retrofit2.Call<RestoredBucketMappings>	postRestoreBucketMetadata(BucketMetadataManifest bucketMetadataManifest, String zapTraceSpan)	Create a new bucket pre-seeded with shard info from a backup.
retrofit2.Call<PostRestoreKVResponse>	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 Details

postRestoreBucketID

@Deprecated
@Headers("Content-Type:text/plain")
@POST("api/v2/restore/bucket/{bucketID}")
retrofit2.Call<byte[]> postRestoreBucketID(@Path("bucketID")
 String bucketID,
 @Body
 byte[] body,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Content-Type")
 String contentType)

Deprecated.

Overwrite storage metadata for a bucket with shard info from a backup.

Parameters:

bucketID - The bucket ID. (required)

body - Database info serialized as protobuf. (required)

zapTraceSpan - OpenTracing span context (optional)

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

Returns:

Call<byte[]>

postRestoreBucketMetadata

@Headers("Content-Type:application/json")
@POST("api/v2/restore/bucketMetadata")
retrofit2.Call<RestoredBucketMappings> postRestoreBucketMetadata(@Body
 BucketMetadataManifest bucketMetadataManifest,
 @Header("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("Content-Type:text/plain")
@POST("api/v2/restore/kv")
retrofit2.Call<PostRestoreKVResponse> postRestoreKV(@Body
 File body,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Content-Encoding")
 String contentEncoding,
 @Header("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 - The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to identity)

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

Returns:

Call<PostRestoreKVResponse>

postRestoreSQL

@Headers("Content-Type:text/plain")
@POST("api/v2/restore/sql")
retrofit2.Call<Void> postRestoreSQL(@Body
 File body,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Content-Encoding")
 String contentEncoding,
 @Header("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 - The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to identity)

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

Returns:

Call<Void>

postRestoreShardId

@Headers("Content-Type:text/plain")
@POST("api/v2/restore/shards/{shardID}")
retrofit2.Call<Void> postRestoreShardId(@Path("shardID")
 String shardID,
 @Body
 File body,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Content-Encoding")
 String contentEncoding,
 @Header("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 - The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to identity)

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

Returns:

Call<Void>