InfluxDB2\Service\DBRPsService Class Reference

Public Member Functions
	__construct (DefaultApi $defaultApi)
	deleteDBRPID ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
	deleteDBRPIDWithHttpInfo ($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)
	getDBRPsID ($dbrp_id, $zap_trace_span=null, $org_id=null, $org=null)
	getDBRPsIDWithHttpInfo ($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)
	postDBRP ($dbrp_create, $zap_trace_span=null)
	postDBRPWithHttpInfo ($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)

Protected Attributes
	$defaultApi
	$headerSelector

Constructor & Destructor Documentation

__construct()

InfluxDB2\Service\DBRPsService::__construct

(

DefaultApi

$defaultApi

)

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

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_id	The database retention policy mapping (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies the organization name of the mapping (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

void

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_id	The database retention policy mapping (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies the organization name of the mapping (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

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_id	The database retention policy mapping (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies 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)

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 database retention policy mappings

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID to filter on (optional)
string	$org	Specifies the organization name to filter on (optional)
string	$id	Specifies the mapping ID to filter on (optional)
string	$bucket_id	Specifies the bucket ID to filter on (optional)
bool	$default	Specifies filtering on default (optional)
string	$db	Specifies the database to filter on (optional)
string	$rp	Specifies 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

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_id	The database retention policy mapping ID (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies 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

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_id	The database retention policy mapping ID (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies the organization name of the mapping (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

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_id	The database retention policy mapping ID (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies 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_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID to filter on (optional)
string	$org	Specifies the organization name to filter on (optional)
string	$id	Specifies the mapping ID to filter on (optional)
string	$bucket_id	Specifies the bucket ID to filter on (optional)
bool	$default	Specifies filtering on default (optional)
string	$db	Specifies the database to filter on (optional)
string	$rp	Specifies the retention policy to filter on (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

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 database retention policy mappings

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID to filter on (optional)
string	$org	Specifies the organization name to filter on (optional)
string	$id	Specifies the mapping ID to filter on (optional)
string	$bucket_id	Specifies the bucket ID to filter on (optional)
bool	$default	Specifies filtering on default (optional)
string	$db	Specifies the database to filter on (optional)
string	$rp	Specifies 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_id	The database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate	$dbrp_update	Database retention policy update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies 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

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_id	The database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate	$dbrp_update	Database retention policy update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies the organization name of the mapping (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

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_id	The database retention policy mapping. (required)
\InfluxDB2\Model\DBRPUpdate	$dbrp_update	Database retention policy update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	Specifies the organization ID of the mapping (optional)
string	$org	Specifies 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_create	The database retention policy mapping to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

postDBRPRequest()

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

protected

Create request for operation 'postDBRP'

Parameters

\InfluxDB2\Model\DBRPCreate	$dbrp_create	The database retention policy mapping to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

postDBRPWithHttpInfo()

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

Operation postDBRPWithHttpInfo

Add a database retention policy mapping

Parameters

\InfluxDB2\Model\DBRPCreate	$dbrp_create	The database retention policy mapping to add (required)
string	$zap_trace_span	OpenTracing 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:

• src/InfluxDB2/Service/DBRPsService.php