Class BackupService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

BackupService

Implements

IBackupService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class BackupService : object, IBackupService, IApiAccessor

Constructors

BackupService(Configuration)

Initializes a new instance of the BackupService class using Configuration object

Declaration

public BackupService(Configuration configuration = null)

Parameters

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

BackupService(String)

Initializes a new instance of the BackupService class.

Declaration

public BackupService(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

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

public 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

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

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

GetBackupKVAsyncWithIRestResponse(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

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

public 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

GetBackupKVWithIRestResponse(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

public RestResponse GetBackupKVWithIRestResponse(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of System.IO.Stream

Exceptions

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

GetBackupKVWithIRestResponseAsync(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

public async System.Threading.Tasks.Task<RestResponse> GetBackupKVWithIRestResponseAsync(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<RestResponse>	ApiResponse of System.IO.Stream

Exceptions

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

GetBackupKVWithRestRequest(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

public RestRequest GetBackupKVWithRestRequest(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestRequest	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

public 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

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

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

GetBackupMetadataAsyncWithIRestResponse(String, String, CancellationToken)

Download snapshot of all metadata in the server

Declaration

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

public 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

GetBackupMetadataWithIRestResponse(String, String)

Download snapshot of all metadata in the server

Declaration

public RestResponse GetBackupMetadataWithIRestResponse(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
RestResponse	ApiResponse of MetadataBackup

Exceptions

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

GetBackupMetadataWithIRestResponseAsync(String, String, CancellationToken)

Download snapshot of all metadata in the server

Declaration

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

Exceptions

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

GetBackupMetadataWithRestRequest(String, String)

Download snapshot of all metadata in the server

Declaration

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

public 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

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

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

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

Download snapshot of all TSM data in a shard

Declaration

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

public 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

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

Download snapshot of all TSM data in a shard

Declaration

public RestResponse GetBackupShardIdWithIRestResponse(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
RestResponse	ApiResponse of System.IO.Stream

Exceptions

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

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

Download snapshot of all TSM data in a shard

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBackupShardIdWithIRestResponseAsync(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<RestResponse>	ApiResponse of System.IO.Stream

Exceptions

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

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

Download snapshot of all TSM data in a shard

Declaration

public RestRequest GetBackupShardIdWithRestRequest(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
RestRequest	ApiResponse of System.IO.Stream

Exceptions

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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

IBackupService