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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteSourcesID ($source_id, $zap_trace_span=null)
 
 deleteSourcesIDWithHttpInfo ($source_id, $zap_trace_span=null)
 
 deleteSourcesIDAsync ($source_id, $zap_trace_span=null)
 
 deleteSourcesIDAsyncWithHttpInfo ($source_id, $zap_trace_span=null)
 
 getSources ($zap_trace_span=null, $org=null)
 
 getSourcesWithHttpInfo ($zap_trace_span=null, $org=null)
 
 getSourcesAsync ($zap_trace_span=null, $org=null)
 
 getSourcesAsyncWithHttpInfo ($zap_trace_span=null, $org=null)
 
 getSourcesID ($source_id, $zap_trace_span=null)
 
 getSourcesIDWithHttpInfo ($source_id, $zap_trace_span=null)
 
 getSourcesIDAsync ($source_id, $zap_trace_span=null)
 
 getSourcesIDAsyncWithHttpInfo ($source_id, $zap_trace_span=null)
 
 getSourcesIDBuckets ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDBucketsWithHttpInfo ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDBucketsAsync ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDBucketsAsyncWithHttpInfo ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDHealth ($source_id, $zap_trace_span=null)
 
 getSourcesIDHealthWithHttpInfo ($source_id, $zap_trace_span=null)
 
 getSourcesIDHealthAsync ($source_id, $zap_trace_span=null)
 
 getSourcesIDHealthAsyncWithHttpInfo ($source_id, $zap_trace_span=null)
 
 patchSourcesID ($source_id, $source, $zap_trace_span=null)
 
 patchSourcesIDWithHttpInfo ($source_id, $source, $zap_trace_span=null)
 
 patchSourcesIDAsync ($source_id, $source, $zap_trace_span=null)
 
 patchSourcesIDAsyncWithHttpInfo ($source_id, $source, $zap_trace_span=null)
 
 postSources ($source, $zap_trace_span=null)
 
 postSourcesWithHttpInfo ($source, $zap_trace_span=null)
 
 postSourcesAsync ($source, $zap_trace_span=null)
 
 postSourcesAsyncWithHttpInfo ($source, $zap_trace_span=null)
 

Protected Member Functions

 deleteSourcesIDRequest ($source_id, $zap_trace_span=null)
 
 getSourcesRequest ($zap_trace_span=null, $org=null)
 
 getSourcesIDRequest ($source_id, $zap_trace_span=null)
 
 getSourcesIDBucketsRequest ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDHealthRequest ($source_id, $zap_trace_span=null)
 
 patchSourcesIDRequest ($source_id, $source, $zap_trace_span=null)
 
 postSourcesRequest ($source, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\SourcesService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteSourcesID()

InfluxDB2\Service\SourcesService::deleteSourcesID (   $source_id,
  $zap_trace_span = null 
)

Operation deleteSourcesID

Delete a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteSourcesIDAsync()

InfluxDB2\Service\SourcesService::deleteSourcesIDAsync (   $source_id,
  $zap_trace_span = null 
)

Operation deleteSourcesIDAsync

Delete a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteSourcesIDAsyncWithHttpInfo()

InfluxDB2\Service\SourcesService::deleteSourcesIDAsyncWithHttpInfo (   $source_id,
  $zap_trace_span = null 
)

Operation deleteSourcesIDAsyncWithHttpInfo

Delete a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteSourcesIDRequest()

InfluxDB2\Service\SourcesService::deleteSourcesIDRequest (   $source_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteSourcesID'

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteSourcesIDWithHttpInfo()

InfluxDB2\Service\SourcesService::deleteSourcesIDWithHttpInfo (   $source_id,
  $zap_trace_span = null 
)

Operation deleteSourcesIDWithHttpInfo

Delete a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getConfig()

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

◆ getSources()

InfluxDB2\Service\SourcesService::getSources (   $zap_trace_span = null,
  $org = null 
)

Operation getSources

List all sources

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Sources|\InfluxDB2\Model\Error

◆ getSourcesAsync()

InfluxDB2\Service\SourcesService::getSourcesAsync (   $zap_trace_span = null,
  $org = null 
)

Operation getSourcesAsync

List all sources

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesAsyncWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesAsyncWithHttpInfo (   $zap_trace_span = null,
  $org = null 
)

Operation getSourcesAsyncWithHttpInfo

List all sources

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesID()

InfluxDB2\Service\SourcesService::getSourcesID (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesID

Retrieve a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Source|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getSourcesIDAsync()

InfluxDB2\Service\SourcesService::getSourcesIDAsync (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesIDAsync

Retrieve a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDAsyncWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesIDAsyncWithHttpInfo (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesIDAsyncWithHttpInfo

Retrieve a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDBuckets()

InfluxDB2\Service\SourcesService::getSourcesIDBuckets (   $source_id,
  $zap_trace_span = null,
  $org = null 
)

Operation getSourcesIDBuckets

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Buckets|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getSourcesIDBucketsAsync()

InfluxDB2\Service\SourcesService::getSourcesIDBucketsAsync (   $source_id,
  $zap_trace_span = null,
  $org = null 
)

Operation getSourcesIDBucketsAsync

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDBucketsAsyncWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesIDBucketsAsyncWithHttpInfo (   $source_id,
  $zap_trace_span = null,
  $org = null 
)

Operation getSourcesIDBucketsAsyncWithHttpInfo

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDBucketsRequest()

InfluxDB2\Service\SourcesService::getSourcesIDBucketsRequest (   $source_id,
  $zap_trace_span = null,
  $org = null 
)
protected

Create request for operation 'getSourcesIDBuckets'

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getSourcesIDBucketsWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesIDBucketsWithHttpInfo (   $source_id,
  $zap_trace_span = null,
  $org = null 
)

Operation getSourcesIDBucketsWithHttpInfo

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getSourcesIDHealth()

InfluxDB2\Service\SourcesService::getSourcesIDHealth (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesIDHealth

Get the health of a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\HealthCheck|\InfluxDB2\Model\HealthCheck|\InfluxDB2\Model\Error

◆ getSourcesIDHealthAsync()

InfluxDB2\Service\SourcesService::getSourcesIDHealthAsync (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesIDHealthAsync

Get the health of a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDHealthAsyncWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesIDHealthAsyncWithHttpInfo (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesIDHealthAsyncWithHttpInfo

Get the health of a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDHealthRequest()

InfluxDB2\Service\SourcesService::getSourcesIDHealthRequest (   $source_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getSourcesIDHealth'

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getSourcesIDHealthWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesIDHealthWithHttpInfo (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesIDHealthWithHttpInfo

Get the health of a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getSourcesIDRequest()

InfluxDB2\Service\SourcesService::getSourcesIDRequest (   $source_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getSourcesID'

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getSourcesIDWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesIDWithHttpInfo (   $source_id,
  $zap_trace_span = null 
)

Operation getSourcesIDWithHttpInfo

Retrieve a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getSourcesRequest()

InfluxDB2\Service\SourcesService::getSourcesRequest (   $zap_trace_span = null,
  $org = null 
)
protected

Create request for operation 'getSources'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getSourcesWithHttpInfo()

InfluxDB2\Service\SourcesService::getSourcesWithHttpInfo (   $zap_trace_span = null,
  $org = null 
)

Operation getSourcesWithHttpInfo

List all sources

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchSourcesID()

InfluxDB2\Service\SourcesService::patchSourcesID (   $source_id,
  $source,
  $zap_trace_span = null 
)

Operation patchSourcesID

Update a Source

Parameters
string$source_idThe source ID. (required)
\InfluxDB2\Model\Source$sourceSource update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Source|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchSourcesIDAsync()

InfluxDB2\Service\SourcesService::patchSourcesIDAsync (   $source_id,
  $source,
  $zap_trace_span = null 
)

Operation patchSourcesIDAsync

Update a Source

Parameters
string$source_idThe source ID. (required)
\InfluxDB2\Model\Source$sourceSource update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchSourcesIDAsyncWithHttpInfo()

InfluxDB2\Service\SourcesService::patchSourcesIDAsyncWithHttpInfo (   $source_id,
  $source,
  $zap_trace_span = null 
)

Operation patchSourcesIDAsyncWithHttpInfo

Update a Source

Parameters
string$source_idThe source ID. (required)
\InfluxDB2\Model\Source$sourceSource update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchSourcesIDRequest()

InfluxDB2\Service\SourcesService::patchSourcesIDRequest (   $source_id,
  $source,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchSourcesID'

Parameters
string$source_idThe source ID. (required)
\InfluxDB2\Model\Source$sourceSource update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchSourcesIDWithHttpInfo()

InfluxDB2\Service\SourcesService::patchSourcesIDWithHttpInfo (   $source_id,
  $source,
  $zap_trace_span = null 
)

Operation patchSourcesIDWithHttpInfo

Update a Source

Parameters
string$source_idThe source ID. (required)
\InfluxDB2\Model\Source$sourceSource update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postSources()

InfluxDB2\Service\SourcesService::postSources (   $source,
  $zap_trace_span = null 
)

Operation postSources

Create a source

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Source|\InfluxDB2\Model\Error

◆ postSourcesAsync()

InfluxDB2\Service\SourcesService::postSourcesAsync (   $source,
  $zap_trace_span = null 
)

Operation postSourcesAsync

Create a source

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSourcesAsyncWithHttpInfo()

InfluxDB2\Service\SourcesService::postSourcesAsyncWithHttpInfo (   $source,
  $zap_trace_span = null 
)

Operation postSourcesAsyncWithHttpInfo

Create a source

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSourcesRequest()

InfluxDB2\Service\SourcesService::postSourcesRequest (   $source,
  $zap_trace_span = null 
)
protected

Create request for operation 'postSources'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postSourcesWithHttpInfo()

InfluxDB2\Service\SourcesService::postSourcesWithHttpInfo (   $source,
  $zap_trace_span = null 
)

Operation postSourcesWithHttpInfo

Create a source

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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