InfluxDB2\Service\TelegrafsService Class Reference

Public Member Functions
	__construct (DefaultApi $defaultApi)
	deleteTelegrafsID ($telegraf_id, $zap_trace_span=null)
	deleteTelegrafsIDWithHttpInfo ($telegraf_id, $zap_trace_span=null)
	deleteTelegrafsIDLabelsID ($telegraf_id, $label_id, $zap_trace_span=null)
	deleteTelegrafsIDLabelsIDWithHttpInfo ($telegraf_id, $label_id, $zap_trace_span=null)
	deleteTelegrafsIDMembersID ($user_id, $telegraf_id, $zap_trace_span=null)
	deleteTelegrafsIDMembersIDWithHttpInfo ($user_id, $telegraf_id, $zap_trace_span=null)
	deleteTelegrafsIDOwnersID ($user_id, $telegraf_id, $zap_trace_span=null)
	deleteTelegrafsIDOwnersIDWithHttpInfo ($user_id, $telegraf_id, $zap_trace_span=null)
	getTelegrafs ($zap_trace_span=null, $org_id=null)
	getTelegrafsWithHttpInfo ($zap_trace_span=null, $org_id=null)
	getTelegrafsID ($telegraf_id, $zap_trace_span=null, $accept='application/toml')
	getTelegrafsIDWithHttpInfo ($telegraf_id, $zap_trace_span=null, $accept='application/toml')
	getTelegrafsIDLabels ($telegraf_id, $zap_trace_span=null)
	getTelegrafsIDLabelsWithHttpInfo ($telegraf_id, $zap_trace_span=null)
	getTelegrafsIDMembers ($telegraf_id, $zap_trace_span=null)
	getTelegrafsIDMembersWithHttpInfo ($telegraf_id, $zap_trace_span=null)
	getTelegrafsIDOwners ($telegraf_id, $zap_trace_span=null)
	getTelegrafsIDOwnersWithHttpInfo ($telegraf_id, $zap_trace_span=null)
	postTelegrafs ($telegraf_plugin_request, $zap_trace_span=null)
	postTelegrafsWithHttpInfo ($telegraf_plugin_request, $zap_trace_span=null)
	postTelegrafsIDLabels ($telegraf_id, $label_mapping, $zap_trace_span=null)
	postTelegrafsIDLabelsWithHttpInfo ($telegraf_id, $label_mapping, $zap_trace_span=null)
	postTelegrafsIDMembers ($telegraf_id, $add_resource_member_request_body, $zap_trace_span=null)
	postTelegrafsIDMembersWithHttpInfo ($telegraf_id, $add_resource_member_request_body, $zap_trace_span=null)
	postTelegrafsIDOwners ($telegraf_id, $add_resource_member_request_body, $zap_trace_span=null)
	postTelegrafsIDOwnersWithHttpInfo ($telegraf_id, $add_resource_member_request_body, $zap_trace_span=null)
	putTelegrafsID ($telegraf_id, $telegraf_plugin_request, $zap_trace_span=null)
	putTelegrafsIDWithHttpInfo ($telegraf_id, $telegraf_plugin_request, $zap_trace_span=null)

Protected Member Functions
	deleteTelegrafsIDRequest ($telegraf_id, $zap_trace_span=null)
	deleteTelegrafsIDLabelsIDRequest ($telegraf_id, $label_id, $zap_trace_span=null)
	deleteTelegrafsIDMembersIDRequest ($user_id, $telegraf_id, $zap_trace_span=null)
	deleteTelegrafsIDOwnersIDRequest ($user_id, $telegraf_id, $zap_trace_span=null)
	getTelegrafsRequest ($zap_trace_span=null, $org_id=null)
	getTelegrafsIDRequest ($telegraf_id, $zap_trace_span=null, $accept='application/toml')
	getTelegrafsIDLabelsRequest ($telegraf_id, $zap_trace_span=null)
	getTelegrafsIDMembersRequest ($telegraf_id, $zap_trace_span=null)
	getTelegrafsIDOwnersRequest ($telegraf_id, $zap_trace_span=null)
	postTelegrafsRequest ($telegraf_plugin_request, $zap_trace_span=null)
	postTelegrafsIDLabelsRequest ($telegraf_id, $label_mapping, $zap_trace_span=null)
	postTelegrafsIDMembersRequest ($telegraf_id, $add_resource_member_request_body, $zap_trace_span=null)
	postTelegrafsIDOwnersRequest ($telegraf_id, $add_resource_member_request_body, $zap_trace_span=null)
	putTelegrafsIDRequest ($telegraf_id, $telegraf_plugin_request, $zap_trace_span=null)

Protected Attributes
	$defaultApi
	$headerSelector

Constructor & Destructor Documentation

__construct()

InfluxDB2\Service\TelegrafsService::__construct

(

DefaultApi

$defaultApi

)

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

deleteTelegrafsID()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsID	(		$telegraf_id,
			$zap_trace_span = null )

Operation deleteTelegrafsID

Delete a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

void

deleteTelegrafsIDLabelsID()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDLabelsID	(		$telegraf_id,
			$label_id,
			$zap_trace_span = null )

Operation deleteTelegrafsIDLabelsID

Delete a label from a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$label_id	The label ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

void

deleteTelegrafsIDLabelsIDRequest()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDLabelsIDRequest ( $telegraf_id, $label_id, $zap_trace_span = null )

protected

Create request for operation 'deleteTelegrafsIDLabelsID'

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$label_id	The label ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

deleteTelegrafsIDLabelsIDWithHttpInfo()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDLabelsIDWithHttpInfo	(		$telegraf_id,
			$label_id,
			$zap_trace_span = null )

Operation deleteTelegrafsIDLabelsIDWithHttpInfo

Delete a label from a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$label_id	The label ID. (required)
string	$zap_trace_span	OpenTracing 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)

deleteTelegrafsIDMembersID()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDMembersID	(		$user_id,
			$telegraf_id,
			$zap_trace_span = null )

Operation deleteTelegrafsIDMembersID

Remove a member from a Telegraf config

Parameters

string	$user_id	The ID of the member to remove. (required)
string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

void

deleteTelegrafsIDMembersIDRequest()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDMembersIDRequest ( $user_id, $telegraf_id, $zap_trace_span = null )

protected

Create request for operation 'deleteTelegrafsIDMembersID'

Parameters

string	$user_id	The ID of the member to remove. (required)
string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

deleteTelegrafsIDMembersIDWithHttpInfo()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDMembersIDWithHttpInfo	(		$user_id,
			$telegraf_id,
			$zap_trace_span = null )

Operation deleteTelegrafsIDMembersIDWithHttpInfo

Remove a member from a Telegraf config

Parameters

string	$user_id	The ID of the member to remove. (required)
string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing 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)

deleteTelegrafsIDOwnersID()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDOwnersID	(		$user_id,
			$telegraf_id,
			$zap_trace_span = null )

Operation deleteTelegrafsIDOwnersID

Remove an owner from a Telegraf config

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

void

deleteTelegrafsIDOwnersIDRequest()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDOwnersIDRequest ( $user_id, $telegraf_id, $zap_trace_span = null )

protected

Create request for operation 'deleteTelegrafsIDOwnersID'

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

deleteTelegrafsIDOwnersIDWithHttpInfo()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDOwnersIDWithHttpInfo	(		$user_id,
			$telegraf_id,
			$zap_trace_span = null )

Operation deleteTelegrafsIDOwnersIDWithHttpInfo

Remove an owner from a Telegraf config

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing 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)

deleteTelegrafsIDRequest()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDRequest ( $telegraf_id, $zap_trace_span = null )

protected

Create request for operation 'deleteTelegrafsID'

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

deleteTelegrafsIDWithHttpInfo()

InfluxDB2\Service\TelegrafsService::deleteTelegrafsIDWithHttpInfo	(		$telegraf_id,
			$zap_trace_span = null )

Operation deleteTelegrafsIDWithHttpInfo

Delete a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing 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)

getTelegrafs()

InfluxDB2\Service\TelegrafsService::getTelegrafs	(		$zap_trace_span = null,
			$org_id = null )

Operation getTelegrafs

List all Telegraf configurations

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	The organization ID the Telegraf config belongs to. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\Telegrafs|\InfluxDB2\Model\Error

getTelegrafsID()

InfluxDB2\Service\TelegrafsService::getTelegrafsID	(		$telegraf_id,
			$zap_trace_span = null,
			$accept = 'application/toml' )

Operation getTelegrafsID

Retrieve a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$accept	accept (optional, default to 'application/toml')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

string|\InfluxDB2\Model\Error

getTelegrafsIDLabels()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDLabels	(		$telegraf_id,
			$zap_trace_span = null )

Operation getTelegrafsIDLabels

List all labels for a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error

getTelegrafsIDLabelsRequest()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDLabelsRequest ( $telegraf_id, $zap_trace_span = null )

protected

Create request for operation 'getTelegrafsIDLabels'

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getTelegrafsIDLabelsWithHttpInfo()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDLabelsWithHttpInfo	(		$telegraf_id,
			$zap_trace_span = null )

Operation getTelegrafsIDLabelsWithHttpInfo

List all labels for a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

getTelegrafsIDMembers()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDMembers	(		$telegraf_id,
			$zap_trace_span = null )

Operation getTelegrafsIDMembers

List all users with member privileges for a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error

getTelegrafsIDMembersRequest()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDMembersRequest ( $telegraf_id, $zap_trace_span = null )

protected

Create request for operation 'getTelegrafsIDMembers'

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getTelegrafsIDMembersWithHttpInfo()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDMembersWithHttpInfo	(		$telegraf_id,
			$zap_trace_span = null )

Operation getTelegrafsIDMembersWithHttpInfo

List all users with member privileges for a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

getTelegrafsIDOwners()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDOwners	(		$telegraf_id,
			$zap_trace_span = null )

Operation getTelegrafsIDOwners

List all owners of a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error

getTelegrafsIDOwnersRequest()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDOwnersRequest ( $telegraf_id, $zap_trace_span = null )

protected

Create request for operation 'getTelegrafsIDOwners'

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getTelegrafsIDOwnersWithHttpInfo()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDOwnersWithHttpInfo	(		$telegraf_id,
			$zap_trace_span = null )

Operation getTelegrafsIDOwnersWithHttpInfo

List all owners of a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

getTelegrafsIDRequest()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDRequest ( $telegraf_id, $zap_trace_span = null, $accept = 'application/toml' )

protected

Create request for operation 'getTelegrafsID'

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$accept	(optional, default to 'application/toml')

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getTelegrafsIDWithHttpInfo()

InfluxDB2\Service\TelegrafsService::getTelegrafsIDWithHttpInfo	(		$telegraf_id,
			$zap_trace_span = null,
			$accept = 'application/toml' )

Operation getTelegrafsIDWithHttpInfo

Retrieve a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$accept	(optional, default to 'application/toml')

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

getTelegrafsRequest()

InfluxDB2\Service\TelegrafsService::getTelegrafsRequest ( $zap_trace_span = null, $org_id = null )

protected

Create request for operation 'getTelegrafs'

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	The organization ID the Telegraf config belongs to. (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getTelegrafsWithHttpInfo()

InfluxDB2\Service\TelegrafsService::getTelegrafsWithHttpInfo	(		$zap_trace_span = null,
			$org_id = null )

Operation getTelegrafsWithHttpInfo

List all Telegraf configurations

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
string	$org_id	The organization ID the Telegraf config belongs to. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

postTelegrafs()

InfluxDB2\Service\TelegrafsService::postTelegrafs	(		$telegraf_plugin_request,
			$zap_trace_span = null )

Operation postTelegrafs

Create a Telegraf configuration

Parameters

\InfluxDB2\Model\TelegrafPluginRequest	$telegraf_plugin_request	Telegraf configuration to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\Telegraf|\InfluxDB2\Model\Error

postTelegrafsIDLabels()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDLabels	(		$telegraf_id,
			$label_mapping,
			$zap_trace_span = null )

Operation postTelegrafsIDLabels

Add a label to a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error

postTelegrafsIDLabelsRequest()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDLabelsRequest ( $telegraf_id, $label_mapping, $zap_trace_span = null )

protected

Create request for operation 'postTelegrafsIDLabels'

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

postTelegrafsIDLabelsWithHttpInfo()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDLabelsWithHttpInfo	(		$telegraf_id,
			$label_mapping,
			$zap_trace_span = null )

Operation postTelegrafsIDLabelsWithHttpInfo

Add a label to a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label 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\LabelResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

postTelegrafsIDMembers()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDMembers	(		$telegraf_id,
			$add_resource_member_request_body,
			$zap_trace_span = null )

Operation postTelegrafsIDMembers

Add a member to a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as member (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error

postTelegrafsIDMembersRequest()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDMembersRequest ( $telegraf_id, $add_resource_member_request_body, $zap_trace_span = null )

protected

Create request for operation 'postTelegrafsIDMembers'

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as member (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

postTelegrafsIDMembersWithHttpInfo()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDMembersWithHttpInfo	(		$telegraf_id,
			$add_resource_member_request_body,
			$zap_trace_span = null )

Operation postTelegrafsIDMembersWithHttpInfo

Add a member to a Telegraf config

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as member (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

postTelegrafsIDOwners()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDOwners	(		$telegraf_id,
			$add_resource_member_request_body,
			$zap_trace_span = null )

Operation postTelegrafsIDOwners

Add an owner to a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as owner (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error

postTelegrafsIDOwnersRequest()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDOwnersRequest ( $telegraf_id, $add_resource_member_request_body, $zap_trace_span = null )

protected

Create request for operation 'postTelegrafsIDOwners'

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as owner (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

postTelegrafsIDOwnersWithHttpInfo()

InfluxDB2\Service\TelegrafsService::postTelegrafsIDOwnersWithHttpInfo	(		$telegraf_id,
			$add_resource_member_request_body,
			$zap_trace_span = null )

Operation postTelegrafsIDOwnersWithHttpInfo

Add an owner to a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf configuration ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as owner (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

postTelegrafsRequest()

InfluxDB2\Service\TelegrafsService::postTelegrafsRequest ( $telegraf_plugin_request, $zap_trace_span = null )

protected

Create request for operation 'postTelegrafs'

Parameters

\InfluxDB2\Model\TelegrafPluginRequest	$telegraf_plugin_request	Telegraf configuration to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

postTelegrafsWithHttpInfo()

InfluxDB2\Service\TelegrafsService::postTelegrafsWithHttpInfo	(		$telegraf_plugin_request,
			$zap_trace_span = null )

Operation postTelegrafsWithHttpInfo

Create a Telegraf configuration

Parameters

\InfluxDB2\Model\TelegrafPluginRequest	$telegraf_plugin_request	Telegraf configuration to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

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

putTelegrafsID()

InfluxDB2\Service\TelegrafsService::putTelegrafsID	(		$telegraf_id,
			$telegraf_plugin_request,
			$zap_trace_span = null )

Operation putTelegrafsID

Update a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\TelegrafPluginRequest	$telegraf_plugin_request	Telegraf configuration update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

\InfluxDB2\Model\Telegraf|\InfluxDB2\Model\Error

putTelegrafsIDRequest()

InfluxDB2\Service\TelegrafsService::putTelegrafsIDRequest ( $telegraf_id, $telegraf_plugin_request, $zap_trace_span = null )

protected

Create request for operation 'putTelegrafsID'

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\TelegrafPluginRequest	$telegraf_plugin_request	Telegraf configuration update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

putTelegrafsIDWithHttpInfo()

InfluxDB2\Service\TelegrafsService::putTelegrafsIDWithHttpInfo	(		$telegraf_id,
			$telegraf_plugin_request,
			$zap_trace_span = null )

Operation putTelegrafsIDWithHttpInfo

Update a Telegraf configuration

Parameters

string	$telegraf_id	The Telegraf config ID. (required)
\InfluxDB2\Model\TelegrafPluginRequest	$telegraf_plugin_request	Telegraf configuration update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

array of \InfluxDB2\Model\Telegraf|\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/TelegrafsService.php