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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getSetup ($zap_trace_span=null)
 
 getSetupWithHttpInfo ($zap_trace_span=null)
 
 getSetupAsync ($zap_trace_span=null)
 
 getSetupAsyncWithHttpInfo ($zap_trace_span=null)
 
 postSetup ($onboarding_request, $zap_trace_span=null)
 
 postSetupWithHttpInfo ($onboarding_request, $zap_trace_span=null)
 
 postSetupAsync ($onboarding_request, $zap_trace_span=null)
 
 postSetupAsyncWithHttpInfo ($onboarding_request, $zap_trace_span=null)
 

Protected Member Functions

 getSetupRequest ($zap_trace_span=null)
 
 postSetupRequest ($onboarding_request, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\SetupService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getSetup()

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

Operation getSetup

Check if database has default user, org, bucket

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\IsOnboarding

◆ getSetupAsync()

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

Operation getSetupAsync

Check if database has default user, org, bucket

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSetupAsyncWithHttpInfo()

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

Operation getSetupAsyncWithHttpInfo

Check if database has default user, org, bucket

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSetupRequest()

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

Create request for operation 'getSetup'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getSetupWithHttpInfo()

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

Operation getSetupWithHttpInfo

Check if database has default user, org, bucket

Parameters
string$zap_trace_spanOpenTracing 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_requestSource to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\OnboardingResponse|\InfluxDB2\Model\Error

◆ postSetupAsync()

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

Operation postSetupAsync

Set up initial user, org and bucket

Parameters
\InfluxDB2\Model\OnboardingRequest$onboarding_requestSource to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSetupAsyncWithHttpInfo()

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

Operation postSetupAsyncWithHttpInfo

Set up initial user, org and bucket

Parameters
\InfluxDB2\Model\OnboardingRequest$onboarding_requestSource to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSetupRequest()

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

Create request for operation 'postSetup'

Parameters
\InfluxDB2\Model\OnboardingRequest$onboarding_requestSource to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_requestSource to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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