InfluxDB2\Service\BackupService Class Reference

Public Member Functions
	__construct (DefaultApi $defaultApi)
	getBackupKV ($zap_trace_span=null)
	getBackupKVWithHttpInfo ($zap_trace_span=null)
	getBackupMetadata ($zap_trace_span=null, $accept_encoding='identity')
	getBackupMetadataWithHttpInfo ($zap_trace_span=null, $accept_encoding='identity')
	getBackupShardId ($shard_id, $zap_trace_span=null, $accept_encoding='identity', $since=null)
	getBackupShardIdWithHttpInfo ($shard_id, $zap_trace_span=null, $accept_encoding='identity', $since=null)

Protected Member Functions
	getBackupKVRequest ($zap_trace_span=null)
	getBackupMetadataRequest ($zap_trace_span=null, $accept_encoding='identity')
	getBackupShardIdRequest ($shard_id, $zap_trace_span=null, $accept_encoding='identity', $since=null)

Protected Attributes
	$defaultApi
	$headerSelector

Constructor & Destructor Documentation

__construct()

InfluxDB2\Service\BackupService::__construct

(

DefaultApi

$defaultApi

)

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

getBackupKV()

InfluxDB2\Service\BackupService::getBackupKV

(

$zap_trace_span = null

)

Operation getBackupKV

Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x.

Parameters

string

$zap_trace_span

OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\SplFileObject|string

getBackupKVRequest()

InfluxDB2\Service\BackupService::getBackupKVRequest ( $zap_trace_span = null )

protected

Create request for operation 'getBackupKV'

Parameters

string

$zap_trace_span

OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getBackupKVWithHttpInfo()

InfluxDB2\Service\BackupService::getBackupKVWithHttpInfo

(

$zap_trace_span = null

)

Operation getBackupKVWithHttpInfo

Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x.

Parameters

string

$zap_trace_span

OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

getBackupMetadata()

InfluxDB2\Service\BackupService::getBackupMetadata	(		$zap_trace_span = null,
			$accept_encoding = 'identity' )

Operation getBackupMetadata

Download snapshot of all metadata in the server

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$accept_encoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\MetadataBackup|string

getBackupMetadataRequest()

InfluxDB2\Service\BackupService::getBackupMetadataRequest ( $zap_trace_span = null, $accept_encoding = 'identity' )

protected

Create request for operation 'getBackupMetadata'

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$accept_encoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getBackupMetadataWithHttpInfo()

InfluxDB2\Service\BackupService::getBackupMetadataWithHttpInfo	(		$zap_trace_span = null,
			$accept_encoding = 'identity' )

Operation getBackupMetadataWithHttpInfo

Download snapshot of all metadata in the server

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$accept_encoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

array of \InfluxDB2\Model\MetadataBackup|string, HTTP status code, HTTP response headers (array of strings)

getBackupShardId()

InfluxDB2\Service\BackupService::getBackupShardId	(		$shard_id,
			$zap_trace_span = null,
			$accept_encoding = 'identity',
			$since = null )

Operation getBackupShardId

Download snapshot of all TSM data in a shard

Parameters

int	$shard_id	The shard ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$accept_encoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')
\DateTime	$since	The earliest time RFC3339 date/time format to include in the snapshot. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\SplFileObject|\InfluxDB2\Model\Error|string

getBackupShardIdRequest()

InfluxDB2\Service\BackupService::getBackupShardIdRequest ( $shard_id, $zap_trace_span = null, $accept_encoding = 'identity', $since = null )

protected

Create request for operation 'getBackupShardId'

Parameters

int	$shard_id	The shard ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$accept_encoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')
\DateTime	$since	The earliest time RFC3339 date/time format to include in the snapshot. (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getBackupShardIdWithHttpInfo()

InfluxDB2\Service\BackupService::getBackupShardIdWithHttpInfo	(		$shard_id,
			$zap_trace_span = null,
			$accept_encoding = 'identity',
			$since = null )

Operation getBackupShardIdWithHttpInfo

Download snapshot of all TSM data in a shard

Parameters

int	$shard_id	The shard ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$accept_encoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')
\DateTime	$since	The earliest time RFC3339 date/time format to include in the snapshot. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

array of \SplFileObject|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

---

The documentation for this class was generated from the following file:

• src/InfluxDB2/Service/BackupService.php