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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteDBRPID ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 deleteDBRPIDWithHttpInfo ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 deleteDBRPIDAsync ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 deleteDBRPIDAsyncWithHttpInfo ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 getDBRPs ($zap_trace_span=null, $org_id=null, $org=null, $id=null, $bucket_id=null, $default=null, $db=null, $rp=null)
 
 getDBRPsWithHttpInfo ($zap_trace_span=null, $org_id=null, $org=null, $id=null, $bucket_id=null, $default=null, $db=null, $rp=null)
 
 getDBRPsAsync ($zap_trace_span=null, $org_id=null, $org=null, $id=null, $bucket_id=null, $default=null, $db=null, $rp=null)
 
 getDBRPsAsyncWithHttpInfo ($zap_trace_span=null, $org_id=null, $org=null, $id=null, $bucket_id=null, $default=null, $db=null, $rp=null)
 
 getDBRPsID ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 getDBRPsIDWithHttpInfo ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 getDBRPsIDAsync ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 getDBRPsIDAsyncWithHttpInfo ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 patchDBRPID ($dbrp_id, $dbrp_update, $zap_trace_span=null, $org_id=null, $org=null)
 
 patchDBRPIDWithHttpInfo ($dbrp_id, $dbrp_update, $zap_trace_span=null, $org_id=null, $org=null)
 
 patchDBRPIDAsync ($dbrp_id, $dbrp_update, $zap_trace_span=null, $org_id=null, $org=null)
 
 patchDBRPIDAsyncWithHttpInfo ($dbrp_id, $dbrp_update, $zap_trace_span=null, $org_id=null, $org=null)
 
 postDBRP ($dbrp_create, $zap_trace_span=null)
 
 postDBRPWithHttpInfo ($dbrp_create, $zap_trace_span=null)
 
 postDBRPAsync ($dbrp_create, $zap_trace_span=null)
 
 postDBRPAsyncWithHttpInfo ($dbrp_create, $zap_trace_span=null)
 

Protected Member Functions

 deleteDBRPIDRequest ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 getDBRPsRequest ($zap_trace_span=null, $org_id=null, $org=null, $id=null, $bucket_id=null, $default=null, $db=null, $rp=null)
 
 getDBRPsIDRequest ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
 
 patchDBRPIDRequest ($dbrp_id, $dbrp_update, $zap_trace_span=null, $org_id=null, $org=null)
 
 postDBRPRequest ($dbrp_create, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\DBRPsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteDBRPID()

InfluxDB2\Service\DBRPsService::deleteDBRPID (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation deleteDBRPID

Delete a database retention policy

Parameters
string$dbrp_idThe database retention policy mapping (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDBRPIDAsync()

InfluxDB2\Service\DBRPsService::deleteDBRPIDAsync (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation deleteDBRPIDAsync

Delete a database retention policy

Parameters
string$dbrp_idThe database retention policy mapping (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDBRPIDAsyncWithHttpInfo()

InfluxDB2\Service\DBRPsService::deleteDBRPIDAsyncWithHttpInfo (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation deleteDBRPIDAsyncWithHttpInfo

Delete a database retention policy

Parameters
string$dbrp_idThe database retention policy mapping (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDBRPIDRequest()

InfluxDB2\Service\DBRPsService::deleteDBRPIDRequest (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)
protected

Create request for operation 'deleteDBRPID'

Parameters
string$dbrp_idThe database retention policy mapping (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteDBRPIDWithHttpInfo()

InfluxDB2\Service\DBRPsService::deleteDBRPIDWithHttpInfo (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation deleteDBRPIDWithHttpInfo

Delete a database retention policy

Parameters
string$dbrp_idThe database retention policy mapping (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (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\DBRPsService::getConfig ( )
Returns
Configuration

◆ getDBRPs()

InfluxDB2\Service\DBRPsService::getDBRPs (   $zap_trace_span = null,
  $org_id = null,
  $org = null,
  $id = null,
  $bucket_id = null,
  $default = null,
  $db = null,
  $rp = null 
)

Operation getDBRPs

List all database retention policy mappings

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID to filter on (optional)
string$orgSpecifies the organization name to filter on (optional)
string$idSpecifies the mapping ID to filter on (optional)
string$bucket_idSpecifies the bucket ID to filter on (optional)
bool$defaultSpecifies filtering on default (optional)
string$dbSpecifies the database to filter on (optional)
string$rpSpecifies the retention policy to filter on (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\DBRPs|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getDBRPsAsync()

InfluxDB2\Service\DBRPsService::getDBRPsAsync (   $zap_trace_span = null,
  $org_id = null,
  $org = null,
  $id = null,
  $bucket_id = null,
  $default = null,
  $db = null,
  $rp = null 
)

Operation getDBRPsAsync

List all database retention policy mappings

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID to filter on (optional)
string$orgSpecifies the organization name to filter on (optional)
string$idSpecifies the mapping ID to filter on (optional)
string$bucket_idSpecifies the bucket ID to filter on (optional)
bool$defaultSpecifies filtering on default (optional)
string$dbSpecifies the database to filter on (optional)
string$rpSpecifies the retention policy to filter on (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDBRPsAsyncWithHttpInfo()

InfluxDB2\Service\DBRPsService::getDBRPsAsyncWithHttpInfo (   $zap_trace_span = null,
  $org_id = null,
  $org = null,
  $id = null,
  $bucket_id = null,
  $default = null,
  $db = null,
  $rp = null 
)

Operation getDBRPsAsyncWithHttpInfo

List all database retention policy mappings

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID to filter on (optional)
string$orgSpecifies the organization name to filter on (optional)
string$idSpecifies the mapping ID to filter on (optional)
string$bucket_idSpecifies the bucket ID to filter on (optional)
bool$defaultSpecifies filtering on default (optional)
string$dbSpecifies the database to filter on (optional)
string$rpSpecifies the retention policy to filter on (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDBRPsID()

InfluxDB2\Service\DBRPsService::getDBRPsID (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation getDBRPsID

Retrieve a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping ID (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\DBRPGet|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getDBRPsIDAsync()

InfluxDB2\Service\DBRPsService::getDBRPsIDAsync (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation getDBRPsIDAsync

Retrieve a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping ID (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDBRPsIDAsyncWithHttpInfo()

InfluxDB2\Service\DBRPsService::getDBRPsIDAsyncWithHttpInfo (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation getDBRPsIDAsyncWithHttpInfo

Retrieve a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping ID (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDBRPsIDRequest()

InfluxDB2\Service\DBRPsService::getDBRPsIDRequest (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)
protected

Create request for operation 'getDBRPsID'

Parameters
string$dbrp_idThe database retention policy mapping ID (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getDBRPsIDWithHttpInfo()

InfluxDB2\Service\DBRPsService::getDBRPsIDWithHttpInfo (   $dbrp_id,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation getDBRPsIDWithHttpInfo

Retrieve a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping ID (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getDBRPsRequest()

InfluxDB2\Service\DBRPsService::getDBRPsRequest (   $zap_trace_span = null,
  $org_id = null,
  $org = null,
  $id = null,
  $bucket_id = null,
  $default = null,
  $db = null,
  $rp = null 
)
protected

Create request for operation 'getDBRPs'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID to filter on (optional)
string$orgSpecifies the organization name to filter on (optional)
string$idSpecifies the mapping ID to filter on (optional)
string$bucket_idSpecifies the bucket ID to filter on (optional)
bool$defaultSpecifies filtering on default (optional)
string$dbSpecifies the database to filter on (optional)
string$rpSpecifies the retention policy to filter on (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getDBRPsWithHttpInfo()

InfluxDB2\Service\DBRPsService::getDBRPsWithHttpInfo (   $zap_trace_span = null,
  $org_id = null,
  $org = null,
  $id = null,
  $bucket_id = null,
  $default = null,
  $db = null,
  $rp = null 
)

Operation getDBRPsWithHttpInfo

List all database retention policy mappings

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID to filter on (optional)
string$orgSpecifies the organization name to filter on (optional)
string$idSpecifies the mapping ID to filter on (optional)
string$bucket_idSpecifies the bucket ID to filter on (optional)
bool$defaultSpecifies filtering on default (optional)
string$dbSpecifies the database to filter on (optional)
string$rpSpecifies the retention policy to filter on (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchDBRPID()

InfluxDB2\Service\DBRPsService::patchDBRPID (   $dbrp_id,
  $dbrp_update,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation patchDBRPID

Update a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate$dbrp_updateDatabase retention policy update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\DBRPGet|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchDBRPIDAsync()

InfluxDB2\Service\DBRPsService::patchDBRPIDAsync (   $dbrp_id,
  $dbrp_update,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation patchDBRPIDAsync

Update a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate$dbrp_updateDatabase retention policy update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchDBRPIDAsyncWithHttpInfo()

InfluxDB2\Service\DBRPsService::patchDBRPIDAsyncWithHttpInfo (   $dbrp_id,
  $dbrp_update,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation patchDBRPIDAsyncWithHttpInfo

Update a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate$dbrp_updateDatabase retention policy update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchDBRPIDRequest()

InfluxDB2\Service\DBRPsService::patchDBRPIDRequest (   $dbrp_id,
  $dbrp_update,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)
protected

Create request for operation 'patchDBRPID'

Parameters
string$dbrp_idThe database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate$dbrp_updateDatabase retention policy update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchDBRPIDWithHttpInfo()

InfluxDB2\Service\DBRPsService::patchDBRPIDWithHttpInfo (   $dbrp_id,
  $dbrp_update,
  $zap_trace_span = null,
  $org_id = null,
  $org = null 
)

Operation patchDBRPIDWithHttpInfo

Update a database retention policy mapping

Parameters
string$dbrp_idThe database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate$dbrp_updateDatabase retention policy update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
string$org_idSpecifies the organization ID of the mapping (optional)
string$orgSpecifies the organization name of the mapping (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postDBRP()

InfluxDB2\Service\DBRPsService::postDBRP (   $dbrp_create,
  $zap_trace_span = null 
)

Operation postDBRP

Add a database retention policy mapping

Parameters
\InfluxDB2\Model\DBRPCreate$dbrp_createThe database retention policy mapping to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\DBRP|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postDBRPAsync()

InfluxDB2\Service\DBRPsService::postDBRPAsync (   $dbrp_create,
  $zap_trace_span = null 
)

Operation postDBRPAsync

Add a database retention policy mapping

Parameters
\InfluxDB2\Model\DBRPCreate$dbrp_createThe database retention policy mapping to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDBRPAsyncWithHttpInfo()

InfluxDB2\Service\DBRPsService::postDBRPAsyncWithHttpInfo (   $dbrp_create,
  $zap_trace_span = null 
)

Operation postDBRPAsyncWithHttpInfo

Add a database retention policy mapping

Parameters
\InfluxDB2\Model\DBRPCreate$dbrp_createThe database retention policy mapping to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDBRPRequest()

InfluxDB2\Service\DBRPsService::postDBRPRequest (   $dbrp_create,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDBRP'

Parameters
\InfluxDB2\Model\DBRPCreate$dbrp_createThe database retention policy mapping to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postDBRPWithHttpInfo()

InfluxDB2\Service\DBRPsService::postDBRPWithHttpInfo (   $dbrp_create,
  $zap_trace_span = null 
)

Operation postDBRPWithHttpInfo

Add a database retention policy mapping

Parameters
\InfluxDB2\Model\DBRPCreate$dbrp_createThe database retention policy mapping to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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