Interface IRestoreService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IRestoreService : IApiAccessor

Methods

PostRestoreBucketID(String, Byte[], String, String)

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

Declaration

byte[] PostRestoreBucketID(string bucketID, byte[] body, string zapTraceSpan = null, string contentType = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.Byte[]	body	Database info serialized as protobuf.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional, default to application/octet-stream)

Returns

Type	Description
System.Byte[]	byte[]

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreBucketIDAsync(String, Byte[], String, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task<byte[]> PostRestoreBucketIDAsync(string bucketID, byte[] body, string zapTraceSpan = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.Byte[]	body	Database info serialized as protobuf.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<System.Byte[]>	Task of byte[]

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreBucketIDAsyncWithHttpInfo(String, Byte[], String, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task<ApiResponse<byte[]>> PostRestoreBucketIDAsyncWithHttpInfo(string bucketID, byte[] body, string zapTraceSpan = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.Byte[]	body	Database info serialized as protobuf.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Byte[]>>	Task of ApiResponse (byte[])

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreBucketIDWithHttpInfo(String, Byte[], String, String)

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

Declaration

ApiResponse<byte[]> PostRestoreBucketIDWithHttpInfo(string bucketID, byte[] body, string zapTraceSpan = null, string contentType = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.Byte[]	body	Database info serialized as protobuf.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional, default to application/octet-stream)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Byte[]>	ApiResponse of byte[]

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreBucketMetadata(BucketMetadataManifest, String)

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

Declaration

RestoredBucketMappings PostRestoreBucketMetadata(BucketMetadataManifest bucketMetadataManifest, string zapTraceSpan = null)

Parameters

Type	Name	Description
BucketMetadataManifest	bucketMetadataManifest	Metadata manifest for a bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestoredBucketMappings	RestoredBucketMappings

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreBucketMetadataAsync(BucketMetadataManifest, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task<RestoredBucketMappings> PostRestoreBucketMetadataAsync(BucketMetadataManifest bucketMetadataManifest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
BucketMetadataManifest	bucketMetadataManifest	Metadata manifest for a bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestoredBucketMappings>	Task of RestoredBucketMappings

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreBucketMetadataAsyncWithHttpInfo(BucketMetadataManifest, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task<ApiResponse<RestoredBucketMappings>> PostRestoreBucketMetadataAsyncWithHttpInfo(BucketMetadataManifest bucketMetadataManifest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
BucketMetadataManifest	bucketMetadataManifest	Metadata manifest for a bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<RestoredBucketMappings>>	Task of ApiResponse (RestoredBucketMappings)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreBucketMetadataWithHttpInfo(BucketMetadataManifest, String)

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

Declaration

ApiResponse<RestoredBucketMappings> PostRestoreBucketMetadataWithHttpInfo(BucketMetadataManifest bucketMetadataManifest, string zapTraceSpan = null)

Parameters

Type	Name	Description
BucketMetadataManifest	bucketMetadataManifest	Metadata manifest for a bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<RestoredBucketMappings>	ApiResponse of RestoredBucketMappings

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreKV(System.IO.Stream, String, String, String)

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

Declaration

PostRestoreKVResponse PostRestoreKV(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full KV snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)

Returns

Type	Description
PostRestoreKVResponse	PostRestoreKVResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreKVAsync(System.IO.Stream, String, String, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task<PostRestoreKVResponse> PostRestoreKVAsync(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full KV snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<PostRestoreKVResponse>	Task of PostRestoreKVResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreKVAsyncWithHttpInfo(System.IO.Stream, String, String, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task<ApiResponse<PostRestoreKVResponse>> PostRestoreKVAsyncWithHttpInfo(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full KV snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<PostRestoreKVResponse>>	Task of ApiResponse (PostRestoreKVResponse)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreKVWithHttpInfo(System.IO.Stream, String, String, String)

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

Declaration

ApiResponse<PostRestoreKVResponse> PostRestoreKVWithHttpInfo(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full KV snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<PostRestoreKVResponse>	ApiResponse of PostRestoreKVResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreShardId(String, System.IO.Stream, String, String, String)

Restore a TSM snapshot into a shard.

Declaration

void PostRestoreShardId(string shardID, System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null)

Parameters

Type	Name	Description
System.String	shardID	The shard ID.
System.IO.Stream	body	TSM snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreShardIdAsync(String, System.IO.Stream, String, String, String, CancellationToken)

Restore a TSM snapshot into a shard.

Declaration

System.Threading.Tasks.Task PostRestoreShardIdAsync(string shardID, System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	shardID	The shard ID.
System.IO.Stream	body	TSM snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreShardIdAsyncWithHttpInfo(String, System.IO.Stream, String, String, String, CancellationToken)

Restore a TSM snapshot into a shard.

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> PostRestoreShardIdAsyncWithHttpInfo(string shardID, System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	shardID	The shard ID.
System.IO.Stream	body	TSM snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreShardIdWithHttpInfo(String, System.IO.Stream, String, String, String)

Restore a TSM snapshot into a shard.

Declaration

ApiResponse<object> PostRestoreShardIdWithHttpInfo(string shardID, System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null)

Parameters

Type	Name	Description
System.String	shardID	The shard ID.
System.IO.Stream	body	TSM snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreSQL(System.IO.Stream, String, String, String)

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

Declaration

void PostRestoreSQL(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full SQL snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreSQLAsync(System.IO.Stream, String, String, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task PostRestoreSQLAsync(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full SQL snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreSQLAsyncWithHttpInfo(System.IO.Stream, String, String, String, CancellationToken)

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

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> PostRestoreSQLAsyncWithHttpInfo(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full SQL snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRestoreSQLWithHttpInfo(System.IO.Stream, String, String, String)

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

Declaration

ApiResponse<object> PostRestoreSQLWithHttpInfo(System.IO.Stream body, string zapTraceSpan = null, string contentEncoding = null, string contentType = null)

Parameters

Type	Name	Description
System.IO.Stream	body	Full SQL snapshot.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	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)
System.String	contentType	(optional, default to application/octet-stream)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call