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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 postRestoreBucketMetadata ($bucket_metadata_manifest, $zap_trace_span=null)
 
 postRestoreBucketMetadataWithHttpInfo ($bucket_metadata_manifest, $zap_trace_span=null)
 
 postRestoreBucketMetadataAsync ($bucket_metadata_manifest, $zap_trace_span=null)
 
 postRestoreBucketMetadataAsyncWithHttpInfo ($bucket_metadata_manifest, $zap_trace_span=null)
 
 postRestoreKV ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreKVWithHttpInfo ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreKVAsync ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreKVAsyncWithHttpInfo ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreSQL ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreSQLWithHttpInfo ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreSQLAsync ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreSQLAsyncWithHttpInfo ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreShardId ($shard_id, $body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreShardIdWithHttpInfo ($shard_id, $body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreShardIdAsync ($shard_id, $body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreShardIdAsyncWithHttpInfo ($shard_id, $body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 

Protected Member Functions

 postRestoreBucketMetadataRequest ($bucket_metadata_manifest, $zap_trace_span=null)
 
 postRestoreKVRequest ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreSQLRequest ($body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 postRestoreShardIdRequest ($shard_id, $body, $zap_trace_span=null, $content_encoding='identity', $content_type='application/octet-stream')
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\RestoreService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ postRestoreBucketMetadata()

InfluxDB2\Service\RestoreService::postRestoreBucketMetadata (   $bucket_metadata_manifest,
  $zap_trace_span = null 
)

Operation postRestoreBucketMetadata

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

Parameters
\InfluxDB2\Model\BucketMetadataManifest$bucket_metadata_manifestMetadata manifest for a bucket. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\RestoredBucketMappings|\InfluxDB2\Model\Error

◆ postRestoreBucketMetadataAsync()

InfluxDB2\Service\RestoreService::postRestoreBucketMetadataAsync (   $bucket_metadata_manifest,
  $zap_trace_span = null 
)

Operation postRestoreBucketMetadataAsync

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

Parameters
\InfluxDB2\Model\BucketMetadataManifest$bucket_metadata_manifestMetadata manifest for a bucket. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreBucketMetadataAsyncWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreBucketMetadataAsyncWithHttpInfo (   $bucket_metadata_manifest,
  $zap_trace_span = null 
)

Operation postRestoreBucketMetadataAsyncWithHttpInfo

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

Parameters
\InfluxDB2\Model\BucketMetadataManifest$bucket_metadata_manifestMetadata manifest for a bucket. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreBucketMetadataRequest()

InfluxDB2\Service\RestoreService::postRestoreBucketMetadataRequest (   $bucket_metadata_manifest,
  $zap_trace_span = null 
)
protected

Create request for operation 'postRestoreBucketMetadata'

Parameters
\InfluxDB2\Model\BucketMetadataManifest$bucket_metadata_manifestMetadata manifest for a bucket. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postRestoreBucketMetadataWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreBucketMetadataWithHttpInfo (   $bucket_metadata_manifest,
  $zap_trace_span = null 
)

Operation postRestoreBucketMetadataWithHttpInfo

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

Parameters
\InfluxDB2\Model\BucketMetadataManifest$bucket_metadata_manifestMetadata manifest for a bucket. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postRestoreKV()

InfluxDB2\Service\RestoreService::postRestoreKV (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreKV

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

Parameters
\SplFileObject$bodyFull KV snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_typecontent_type (optional, default to 'application/octet-stream')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postRestoreKVAsync()

InfluxDB2\Service\RestoreService::postRestoreKVAsync (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreKVAsync

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

Parameters
\SplFileObject$bodyFull KV snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreKVAsyncWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreKVAsyncWithHttpInfo (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreKVAsyncWithHttpInfo

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

Parameters
\SplFileObject$bodyFull KV snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreKVRequest()

InfluxDB2\Service\RestoreService::postRestoreKVRequest (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)
protected

Create request for operation 'postRestoreKV'

Parameters
\SplFileObject$bodyFull KV snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postRestoreKVWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreKVWithHttpInfo (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreKVWithHttpInfo

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

Parameters
\SplFileObject$bodyFull KV snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ postRestoreShardId()

InfluxDB2\Service\RestoreService::postRestoreShardId (   $shard_id,
  $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreShardId

Restore a TSM snapshot into a shard.

Parameters
string$shard_idThe shard ID. (required)
\SplFileObject$bodyTSM snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_typecontent_type (optional, default to 'application/octet-stream')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postRestoreShardIdAsync()

InfluxDB2\Service\RestoreService::postRestoreShardIdAsync (   $shard_id,
  $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreShardIdAsync

Restore a TSM snapshot into a shard.

Parameters
string$shard_idThe shard ID. (required)
\SplFileObject$bodyTSM snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreShardIdAsyncWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreShardIdAsyncWithHttpInfo (   $shard_id,
  $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreShardIdAsyncWithHttpInfo

Restore a TSM snapshot into a shard.

Parameters
string$shard_idThe shard ID. (required)
\SplFileObject$bodyTSM snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreShardIdRequest()

InfluxDB2\Service\RestoreService::postRestoreShardIdRequest (   $shard_id,
  $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)
protected

Create request for operation 'postRestoreShardId'

Parameters
string$shard_idThe shard ID. (required)
\SplFileObject$bodyTSM snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postRestoreShardIdWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreShardIdWithHttpInfo (   $shard_id,
  $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreShardIdWithHttpInfo

Restore a TSM snapshot into a shard.

Parameters
string$shard_idThe shard ID. (required)
\SplFileObject$bodyTSM snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ postRestoreSQL()

InfluxDB2\Service\RestoreService::postRestoreSQL (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreSQL

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

Parameters
\SplFileObject$bodyFull SQL snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_typecontent_type (optional, default to 'application/octet-stream')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postRestoreSQLAsync()

InfluxDB2\Service\RestoreService::postRestoreSQLAsync (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreSQLAsync

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

Parameters
\SplFileObject$bodyFull SQL snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreSQLAsyncWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreSQLAsyncWithHttpInfo (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreSQLAsyncWithHttpInfo

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

Parameters
\SplFileObject$bodyFull SQL snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postRestoreSQLRequest()

InfluxDB2\Service\RestoreService::postRestoreSQLRequest (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)
protected

Create request for operation 'postRestoreSQL'

Parameters
\SplFileObject$bodyFull SQL snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postRestoreSQLWithHttpInfo()

InfluxDB2\Service\RestoreService::postRestoreSQLWithHttpInfo (   $body,
  $zap_trace_span = null,
  $content_encoding = 'identity',
  $content_type = 'application/octet-stream' 
)

Operation postRestoreSQLWithHttpInfo

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

Parameters
\SplFileObject$bodyFull SQL snapshot. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$content_encodingWhen present, its value indicates to the database that compression is applied to the line-protocol body. (optional, default to 'identity')
string$content_type(optional, default to 'application/octet-stream')
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

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