Class RestoreService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

RestoreService

Implements

IRestoreService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class RestoreService : object, IRestoreService, IApiAccessor

Constructors

RestoreService(Configuration)

Initializes a new instance of the RestoreService class using Configuration object

Declaration

public RestoreService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

RestoreService(String)

Initializes a new instance of the RestoreService class.

Declaration

public RestoreService(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
IDictionary<System.String, System.String>	Dictionary of HTTP header

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

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

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

Declaration

public 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

public async 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

public async 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

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreBucketIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

PostRestoreBucketIDWithIRestResponse(String, Byte[], String, String)

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

Declaration

public RestResponse PostRestoreBucketIDWithIRestResponse(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
RestResponse	ApiResponse of byte[]

Exceptions

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

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreBucketIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of byte[]

Exceptions

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

PostRestoreBucketIDWithRestRequest(String, Byte[], String, String)

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

Declaration

public RestRequest PostRestoreBucketIDWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

PostRestoreBucketMetadataAsyncWithIRestResponse(BucketMetadataManifest, String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreBucketMetadataAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

PostRestoreBucketMetadataWithIRestResponse(BucketMetadataManifest, String)

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

Declaration

public RestResponse PostRestoreBucketMetadataWithIRestResponse(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
RestResponse	ApiResponse of RestoredBucketMappings

Exceptions

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

PostRestoreBucketMetadataWithIRestResponseAsync(BucketMetadataManifest, String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreBucketMetadataWithIRestResponseAsync(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<RestResponse>	ApiResponse of RestoredBucketMappings

Exceptions

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

PostRestoreBucketMetadataWithRestRequest(BucketMetadataManifest, String)

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

Declaration

public RestRequest PostRestoreBucketMetadataWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreKVAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

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

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

Declaration

public RestResponse PostRestoreKVWithIRestResponse(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
RestResponse	ApiResponse of PostRestoreKVResponse

Exceptions

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

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreKVWithIRestResponseAsync(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<RestResponse>	ApiResponse of PostRestoreKVResponse

Exceptions

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

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

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

Declaration

public RestRequest PostRestoreKVWithRestRequest(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
RestRequest	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

public 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

public 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

public async 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

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

Restore a TSM snapshot into a shard.

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreShardIdAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

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

Restore a TSM snapshot into a shard.

Declaration

public RestResponse PostRestoreShardIdWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

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

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

Restore a TSM snapshot into a shard.

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreShardIdWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

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

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

Restore a TSM snapshot into a shard.

Declaration

public RestRequest PostRestoreShardIdWithRestRequest(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
RestRequest	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

public 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

public 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

public async 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

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreSQLAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

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

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

Declaration

public RestResponse PostRestoreSQLWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

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

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostRestoreSQLWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

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

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

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

Declaration

public RestRequest PostRestoreSQLWithRestRequest(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
RestRequest	ApiResponse of Object(void)

Exceptions

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

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

IRestoreService