Public Member Functions
	__construct (DefaultApi $defaultApi)

	postRestoreBucketID ($bucket_id, $body, $zap_trace_span=null, $content_type='application/octet-stream')

	postRestoreBucketIDWithHttpInfo ($bucket_id, $body, $zap_trace_span=null, $content_type='application/octet-stream')

	postRestoreBucketMetadata ($bucket_metadata_manifest, $zap_trace_span=null)

	postRestoreBucketMetadataWithHttpInfo ($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')

	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')

	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')

Protected Member Functions
	postRestoreBucketIDRequest ($bucket_id, $body, $zap_trace_span=null, $content_type='application/octet-stream')

	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')

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\RestoreService::__construct ( DefaultApi $defaultApi )

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ postRestoreBucketID()

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

Operation postRestoreBucketID

Overwrite storage metadata for a bucket with shard info from a backup.

Parameters

string	$bucket_id	The bucket ID. (required)
string	$body	Database info serialized as protobuf. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_type	content_type (optional, default to 'application/octet-stream')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: string|string

◆ postRestoreBucketIDRequest()

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

protected

Create request for operation 'postRestoreBucketID'

Parameters

string	$bucket_id	The bucket ID. (required)
string	$body	Database info serialized as protobuf. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_type	(optional, default to 'application/octet-stream')

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postRestoreBucketIDWithHttpInfo()

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

Operation postRestoreBucketIDWithHttpInfo

Overwrite storage metadata for a bucket with shard info from a backup.

Parameters

string	$bucket_id	The bucket ID. (required)
string	$body	Database info serialized as protobuf. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_type	(optional, default to 'application/octet-stream')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of string|string, HTTP status code, HTTP response headers (array of strings)

◆ 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_manifest	Metadata manifest for a bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\RestoredBucketMappings|string

◆ postRestoreBucketMetadataRequest()

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

protected

Create request for operation 'postRestoreBucketMetadata'

Parameters

\InfluxDB2\Model\BucketMetadataManifest	$bucket_metadata_manifest	Metadata manifest for a bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ 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_manifest	Metadata manifest for a bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\RestoredBucketMappings|string, 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	$body	Full KV snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to 'identity')
string	$content_type	content_type (optional, default to 'application/octet-stream')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\PostRestoreKVResponse|string

◆ 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	$body	Full KV snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to 'identity')
string	$content_type	(optional, default to 'application/octet-stream')

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ 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	$body	Full KV snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (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 \InfluxDB2\Model\PostRestoreKVResponse|string, 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_id	The shard ID. (required)
\SplFileObject	$body	TSM snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to 'identity')
string	$content_type	content_type (optional, default to 'application/octet-stream')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ 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_id	The shard ID. (required)
\SplFileObject	$body	TSM snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to 'identity')
string	$content_type	(optional, default to 'application/octet-stream')

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ 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_id	The shard ID. (required)
\SplFileObject	$body	TSM snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (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	$body	Full SQL snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to 'identity')
string	$content_type	content_type (optional, default to 'application/octet-stream')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ 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	$body	Full SQL snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (optional, default to 'identity')
string	$content_type	(optional, default to 'application/octet-stream')

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ 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	$body	Full SQL snapshot. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$content_encoding	The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. (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:

src/InfluxDB2/Service/RestoreService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ postRestoreBucketID()

◆ postRestoreBucketIDRequest()

◆ postRestoreBucketIDWithHttpInfo()

◆ postRestoreBucketMetadata()

◆ postRestoreBucketMetadataRequest()

◆ postRestoreBucketMetadataWithHttpInfo()

◆ postRestoreKV()

◆ postRestoreKVRequest()

◆ postRestoreKVWithHttpInfo()

◆ postRestoreShardId()

◆ postRestoreShardIdRequest()

◆ postRestoreShardIdWithHttpInfo()

◆ postRestoreSQL()

◆ postRestoreSQLRequest()

◆ postRestoreSQLWithHttpInfo()