InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\BackupService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getBackupMetadata ($zap_trace_span=null, $accept_encoding='identity')
 
 getBackupMetadataWithHttpInfo ($zap_trace_span=null, $accept_encoding='identity')
 
 getBackupMetadataAsync ($zap_trace_span=null, $accept_encoding='identity')
 
 getBackupMetadataAsyncWithHttpInfo ($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)
 
 getBackupShardIdAsync ($shard_id, $zap_trace_span=null, $accept_encoding='identity', $since=null)
 
 getBackupShardIdAsyncWithHttpInfo ($shard_id, $zap_trace_span=null, $accept_encoding='identity', $since=null)
 

Protected Member Functions

 getBackupMetadataRequest ($zap_trace_span=null, $accept_encoding='identity')
 
 getBackupShardIdRequest ($shard_id, $zap_trace_span=null, $accept_encoding='identity', $since=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\BackupService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\BackupService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ 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_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\MetadataBackup|\InfluxDB2\Model\Error

◆ getBackupMetadataAsync()

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

Operation getBackupMetadataAsync

Download snapshot of all metadata in the server

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBackupMetadataAsyncWithHttpInfo()

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

Operation getBackupMetadataAsyncWithHttpInfo

Download snapshot of all metadata in the server

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBackupMetadataRequest()

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

Create request for operation 'getBackupMetadata'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\MetadataBackup|\InfluxDB2\Model\Error, 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_idThe shard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
\DateTime$sinceEarliest time to include in the snapshot. RFC3339 format. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getBackupShardIdAsync()

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

Operation getBackupShardIdAsync

Download snapshot of all TSM data in a shard

Parameters
int$shard_idThe shard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
\DateTime$sinceEarliest time to include in the snapshot. RFC3339 format. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBackupShardIdAsyncWithHttpInfo()

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

Operation getBackupShardIdAsyncWithHttpInfo

Download snapshot of all TSM data in a shard

Parameters
int$shard_idThe shard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
\DateTime$sinceEarliest time to include in the snapshot. RFC3339 format. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_idThe shard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
\DateTime$sinceEarliest time to include in the snapshot. RFC3339 format. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_idThe shard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
\DateTime$sinceEarliest time to include in the snapshot. RFC3339 format. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getConfig()

InfluxDB2\Service\BackupService::getConfig ( )
Returns
Configuration

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