InfluxDB2\Service\SetupService Class Reference

Public Member Functions
	__construct (DefaultApi $defaultApi)
	getSetup ($zap_trace_span=null)
	getSetupWithHttpInfo ($zap_trace_span=null)
	postSetup ($onboarding_request, $zap_trace_span=null)
	postSetupWithHttpInfo ($onboarding_request, $zap_trace_span=null)

Protected Member Functions
	getSetupRequest ($zap_trace_span=null)
	postSetupRequest ($onboarding_request, $zap_trace_span=null)

Protected Attributes
	$defaultApi
	$headerSelector

Constructor & Destructor Documentation

__construct()

InfluxDB2\Service\SetupService::__construct

(

DefaultApi

$defaultApi

)

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

getSetup()

InfluxDB2\Service\SetupService::getSetup

(

$zap_trace_span = null

)

Operation getSetup

Check if database has default user, org, bucket

Parameters

string

$zap_trace_span

OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\IsOnboarding

getSetupRequest()

InfluxDB2\Service\SetupService::getSetupRequest ( $zap_trace_span = null )

protected

Create request for operation 'getSetup'

Parameters

string

$zap_trace_span

OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getSetupWithHttpInfo()

InfluxDB2\Service\SetupService::getSetupWithHttpInfo

(

$zap_trace_span = null

)

Operation getSetupWithHttpInfo

Check if database has default user, org, bucket

Parameters

string

$zap_trace_span

OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

array of \InfluxDB2\Model\IsOnboarding, HTTP status code, HTTP response headers (array of strings)

postSetup()

InfluxDB2\Service\SetupService::postSetup	(		$onboarding_request,
			$zap_trace_span = null )

Operation postSetup

Set up initial user, org and bucket

Parameters

\InfluxDB2\Model\OnboardingRequest	$onboarding_request	Source to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\OnboardingResponse|string

postSetupRequest()

InfluxDB2\Service\SetupService::postSetupRequest ( $onboarding_request, $zap_trace_span = null )

protected

Create request for operation 'postSetup'

Parameters

\InfluxDB2\Model\OnboardingRequest	$onboarding_request	Source to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

postSetupWithHttpInfo()

InfluxDB2\Service\SetupService::postSetupWithHttpInfo	(		$onboarding_request,
			$zap_trace_span = null )

Operation postSetupWithHttpInfo

Set up initial user, org and bucket

Parameters

\InfluxDB2\Model\OnboardingRequest	$onboarding_request	Source to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

---

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

• src/InfluxDB2/Service/SetupService.php