Interface IBackupService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IBackupService : IApiAccessor

Methods

GetBackupKV(String)

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.

Declaration

System.IO.Stream GetBackupKV(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
System.IO.Stream	System.IO.Stream

Exceptions

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

GetBackupKVAsync(String, CancellationToken)

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.

Declaration

System.Threading.Tasks.Task<System.IO.Stream> GetBackupKVAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<System.IO.Stream>	Task of System.IO.Stream

Exceptions

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

GetBackupKVAsyncWithHttpInfo(String, CancellationToken)

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.

Declaration

System.Threading.Tasks.Task<ApiResponse<System.IO.Stream>> GetBackupKVAsyncWithHttpInfo(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetBackupKVWithHttpInfo(String)

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.

Declaration

ApiResponse<System.IO.Stream> GetBackupKVWithHttpInfo(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.IO.Stream>	ApiResponse of System.IO.Stream

Exceptions

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

GetBackupMetadata(String, String)

Download snapshot of all metadata in the server

Declaration

MetadataBackup GetBackupMetadata(string zapTraceSpan = null, string acceptEncoding = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

Returns

Type	Description
MetadataBackup	MetadataBackup

Exceptions

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

GetBackupMetadataAsync(String, String, CancellationToken)

Download snapshot of all metadata in the server

Declaration

System.Threading.Tasks.Task<MetadataBackup> GetBackupMetadataAsync(string zapTraceSpan = null, string acceptEncoding = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetBackupMetadataAsyncWithHttpInfo(String, String, CancellationToken)

Download snapshot of all metadata in the server

Declaration

System.Threading.Tasks.Task<ApiResponse<MetadataBackup>> GetBackupMetadataAsyncWithHttpInfo(string zapTraceSpan = null, string acceptEncoding = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetBackupMetadataWithHttpInfo(String, String)

Download snapshot of all metadata in the server

Declaration

ApiResponse<MetadataBackup> GetBackupMetadataWithHttpInfo(string zapTraceSpan = null, string acceptEncoding = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

Returns

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

Exceptions

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

GetBackupShardId(Nullable<Int64>, String, String, Nullable<DateTime>)

Download snapshot of all TSM data in a shard

Declaration

System.IO.Stream GetBackupShardId(long? shardID, string zapTraceSpan = null, string acceptEncoding = null, DateTime? since = null)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	shardID	The shard ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.Nullable<DateTime>	since	Earliest time to include in the snapshot. RFC3339 format. (optional)

Returns

Type	Description
System.IO.Stream	System.IO.Stream

Exceptions

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

GetBackupShardIdAsync(Nullable<Int64>, String, String, Nullable<DateTime>, CancellationToken)

Download snapshot of all TSM data in a shard

Declaration

System.Threading.Tasks.Task<System.IO.Stream> GetBackupShardIdAsync(long? shardID, string zapTraceSpan = null, string acceptEncoding = null, DateTime? since = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	shardID	The shard ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.Nullable<DateTime>	since	Earliest time to include in the snapshot. RFC3339 format. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<System.IO.Stream>	Task of System.IO.Stream

Exceptions

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

GetBackupShardIdAsyncWithHttpInfo(Nullable<Int64>, String, String, Nullable<DateTime>, CancellationToken)

Download snapshot of all TSM data in a shard

Declaration

System.Threading.Tasks.Task<ApiResponse<System.IO.Stream>> GetBackupShardIdAsyncWithHttpInfo(long? shardID, string zapTraceSpan = null, string acceptEncoding = null, DateTime? since = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	shardID	The shard ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.Nullable<DateTime>	since	Earliest time to include in the snapshot. RFC3339 format. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetBackupShardIdWithHttpInfo(Nullable<Int64>, String, String, Nullable<DateTime>)

Download snapshot of all TSM data in a shard

Declaration

ApiResponse<System.IO.Stream> GetBackupShardIdWithHttpInfo(long? shardID, string zapTraceSpan = null, string acceptEncoding = null, DateTime? since = null)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	shardID	The shard ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.Nullable<DateTime>	since	Earliest time to include in the snapshot. RFC3339 format. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.IO.Stream>	ApiResponse of System.IO.Stream

Exceptions

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