InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\SourcesService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteSourcesID ($source_id, $zap_trace_span=null)
 
 deleteSourcesIDWithHttpInfo ($source_id, $zap_trace_span=null)
 
 getSources ($zap_trace_span=null, $org=null)
 
 getSourcesWithHttpInfo ($zap_trace_span=null, $org=null)
 
 getSourcesID ($source_id, $zap_trace_span=null)
 
 getSourcesIDWithHttpInfo ($source_id, $zap_trace_span=null)
 
 getSourcesIDBuckets ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDBucketsWithHttpInfo ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDHealth ($source_id, $zap_trace_span=null)
 
 getSourcesIDHealthWithHttpInfo ($source_id, $zap_trace_span=null)
 
 patchSourcesID ($source_id, $source, $zap_trace_span=null)
 
 patchSourcesIDWithHttpInfo ($source_id, $source, $zap_trace_span=null)
 
 postSources ($source, $zap_trace_span=null)
 
 postSourcesWithHttpInfo ($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)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\SourcesService::__construct ( DefaultApi $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ 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

◆ 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
\Psr\Http\Message\RequestInterface

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

◆ 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

◆ 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

◆ 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

◆ 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
\Psr\Http\Message\RequestInterface

◆ 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

◆ 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
\Psr\Http\Message\RequestInterface

◆ 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
\Psr\Http\Message\RequestInterface

◆ 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
\Psr\Http\Message\RequestInterface

◆ 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

◆ 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
\Psr\Http\Message\RequestInterface

◆ 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

◆ 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
\Psr\Http\Message\RequestInterface

◆ 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: