Public Member Functions
	__construct (DefaultApi $defaultApi)

	applyTemplate ($template_apply)

	applyTemplateWithHttpInfo ($template_apply)

	createStack ($post_stack_request1=null)

	createStackWithHttpInfo ($post_stack_request1=null)

	deleteStack ($stack_id, $org_id)

	deleteStackWithHttpInfo ($stack_id, $org_id)

	exportTemplate ($template_export_by_id=null)

	exportTemplateWithHttpInfo ($template_export_by_id=null)

	listStacks ($org_id, $name=null, $stack_id=null)

	listStacksWithHttpInfo ($org_id, $name=null, $stack_id=null)

	readStack ($stack_id)

	readStackWithHttpInfo ($stack_id)

	uninstallStack ($stack_id)

	uninstallStackWithHttpInfo ($stack_id)

	updateStack ($stack_id, $patch_stack_request1=null)

	updateStackWithHttpInfo ($stack_id, $patch_stack_request1=null)

Protected Member Functions
	applyTemplateRequest ($template_apply)

	createStackRequest ($post_stack_request1=null)

	deleteStackRequest ($stack_id, $org_id)

	exportTemplateRequest ($template_export_by_id=null)

	listStacksRequest ($org_id, $name=null, $stack_id=null)

	readStackRequest ($stack_id)

	uninstallStackRequest ($stack_id)

	updateStackRequest ($stack_id, $patch_stack_request1=null)

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\TemplatesService::__construct ( DefaultApi $defaultApi )

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ applyTemplate()

InfluxDB2\Service\TemplatesService::applyTemplate ( $template_apply )

Operation applyTemplate

Apply or dry-run a template

Parameters

\InfluxDB2\Model\TemplateApply $template_apply Parameters for applying templates. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\TemplateSummary|\InfluxDB2\Model\TemplateSummary|TemplateSummary|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ applyTemplateRequest()

InfluxDB2\Service\TemplatesService::applyTemplateRequest ( $template_apply )

protected

Create request for operation 'applyTemplate'

Parameters

\InfluxDB2\Model\TemplateApply $template_apply Parameters for applying templates. (required)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ applyTemplateWithHttpInfo()

InfluxDB2\Service\TemplatesService::applyTemplateWithHttpInfo ( $template_apply )

Operation applyTemplateWithHttpInfo

Apply or dry-run a template

Parameters

\InfluxDB2\Model\TemplateApply $template_apply Parameters for applying templates. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ createStack()

InfluxDB2\Service\TemplatesService::createStack ( $post_stack_request1 = null )

Operation createStack

Create a stack

Parameters

\InfluxDB2\Model\PostStackRequest1 $post_stack_request1 post_stack_request1 (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Stack|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ createStackRequest()

InfluxDB2\Service\TemplatesService::createStackRequest ( $post_stack_request1 = null )

protected

Create request for operation 'createStack'

Parameters

\InfluxDB2\Model\PostStackRequest1 $post_stack_request1 (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ createStackWithHttpInfo()

InfluxDB2\Service\TemplatesService::createStackWithHttpInfo ( $post_stack_request1 = null )

Operation createStackWithHttpInfo

Create a stack

Parameters

\InfluxDB2\Model\PostStackRequest1 $post_stack_request1 (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ deleteStack()

InfluxDB2\Service\TemplatesService::deleteStack	(		$stack_id,
			$org_id )

Operation deleteStack

Delete a stack and associated resources

Parameters

string	$stack_id	The identifier of the stack. (required)
string	$org_id	The identifier of the organization. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteStackRequest()

InfluxDB2\Service\TemplatesService::deleteStackRequest	(		$stack_id,
			$org_id )

protected

Create request for operation 'deleteStack'

Parameters

string	$stack_id	The identifier of the stack. (required)
string	$org_id	The identifier of the organization. (required)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteStackWithHttpInfo()

InfluxDB2\Service\TemplatesService::deleteStackWithHttpInfo	(		$stack_id,
			$org_id )

Operation deleteStackWithHttpInfo

Delete a stack and associated resources

Parameters

string	$stack_id	The identifier of the stack. (required)
string	$org_id	The identifier of the organization. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ exportTemplate()

InfluxDB2\Service\TemplatesService::exportTemplate ( $template_export_by_id = null )

Operation exportTemplate

Export a new template

Parameters

\InfluxDB2\Model\TemplateExportByID $template_export_by_id Export resources as an InfluxDB template. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: object[]|\InfluxDB2\Model\Error

◆ exportTemplateRequest()

InfluxDB2\Service\TemplatesService::exportTemplateRequest ( $template_export_by_id = null )

protected

Create request for operation 'exportTemplate'

Parameters

\InfluxDB2\Model\TemplateExportByID $template_export_by_id Export resources as an InfluxDB template. (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ exportTemplateWithHttpInfo()

InfluxDB2\Service\TemplatesService::exportTemplateWithHttpInfo ( $template_export_by_id = null )

Operation exportTemplateWithHttpInfo

Export a new template

Parameters

\InfluxDB2\Model\TemplateExportByID $template_export_by_id Export resources as an InfluxDB template. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of object[]|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ listStacks()

InfluxDB2\Service\TemplatesService::listStacks	(	$org_id,
		$name = null,
		$stack_id = null )

Operation listStacks

List installed stacks

Parameters

string	$org_id	The ID of the organization that owns the stacks. Only returns stacks owned by this organization. #### InfluxDB Cloud - Doesn't require this parameter; InfluxDB only returns resources allowed by the API token. (required)
string	$name	The stack name. Finds stack `events` with this name and returns the stacks. Repeatable. To filter for more than one stack name, repeat this parameter with each name–for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` (optional)
string	$stack_id	The stack ID. Only returns stacks with this ID. Repeatable. To filter for more than one stack ID, repeat this parameter with each ID–for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\ListStacksResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ listStacksRequest()

InfluxDB2\Service\TemplatesService::listStacksRequest	(	$org_id,
		$name = null,
		$stack_id = null )

protected

Create request for operation 'listStacks'

Parameters

string	$org_id	The ID of the organization that owns the stacks. Only returns stacks owned by this organization. #### InfluxDB Cloud - Doesn't require this parameter; InfluxDB only returns resources allowed by the API token. (required)
string	$name	The stack name. Finds stack `events` with this name and returns the stacks. Repeatable. To filter for more than one stack name, repeat this parameter with each name–for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` (optional)
string	$stack_id	The stack ID. Only returns stacks with this ID. Repeatable. To filter for more than one stack ID, repeat this parameter with each ID–for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ listStacksWithHttpInfo()

InfluxDB2\Service\TemplatesService::listStacksWithHttpInfo	(	$org_id,
		$name = null,
		$stack_id = null )

Operation listStacksWithHttpInfo

List installed stacks

Parameters

string	$org_id	The ID of the organization that owns the stacks. Only returns stacks owned by this organization. #### InfluxDB Cloud - Doesn't require this parameter; InfluxDB only returns resources allowed by the API token. (required)
string	$name	The stack name. Finds stack `events` with this name and returns the stacks. Repeatable. To filter for more than one stack name, repeat this parameter with each name–for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` (optional)
string	$stack_id	The stack ID. Only returns stacks with this ID. Repeatable. To filter for more than one stack ID, repeat this parameter with each ID–for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ readStack()

InfluxDB2\Service\TemplatesService::readStack ( $stack_id )

Operation readStack

Retrieve a stack

Parameters

string $stack_id The identifier of the stack. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error

◆ readStackRequest()

InfluxDB2\Service\TemplatesService::readStackRequest ( $stack_id )

protected

Create request for operation 'readStack'

Parameters

string $stack_id The identifier of the stack. (required)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ readStackWithHttpInfo()

InfluxDB2\Service\TemplatesService::readStackWithHttpInfo ( $stack_id )

Operation readStackWithHttpInfo

Retrieve a stack

Parameters

string $stack_id The identifier of the stack. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ uninstallStack()

InfluxDB2\Service\TemplatesService::uninstallStack ( $stack_id )

Operation uninstallStack

Uninstall a stack

Parameters

string $stack_id The identifier of the stack. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error

◆ uninstallStackRequest()

InfluxDB2\Service\TemplatesService::uninstallStackRequest ( $stack_id )

protected

Create request for operation 'uninstallStack'

Parameters

string $stack_id The identifier of the stack. (required)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ uninstallStackWithHttpInfo()

InfluxDB2\Service\TemplatesService::uninstallStackWithHttpInfo ( $stack_id )

Operation uninstallStackWithHttpInfo

Uninstall a stack

Parameters

string $stack_id The identifier of the stack. (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ updateStack()

InfluxDB2\Service\TemplatesService::updateStack	(		$stack_id,
			$patch_stack_request1 = null )

Operation updateStack

Update a stack

Parameters

string	$stack_id	The identifier of the stack. (required)
\InfluxDB2\Model\PatchStackRequest1	$patch_stack_request1	patch_stack_request1 (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error

◆ updateStackRequest()

InfluxDB2\Service\TemplatesService::updateStackRequest	(		$stack_id,
			$patch_stack_request1 = null )

protected

Create request for operation 'updateStack'

Parameters

string	$stack_id	The identifier of the stack. (required)
\InfluxDB2\Model\PatchStackRequest1	$patch_stack_request1	(optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ updateStackWithHttpInfo()

InfluxDB2\Service\TemplatesService::updateStackWithHttpInfo	(		$stack_id,
			$patch_stack_request1 = null )

Operation updateStackWithHttpInfo

Update a stack

Parameters

string	$stack_id	The identifier of the stack. (required)
\InfluxDB2\Model\PatchStackRequest1	$patch_stack_request1	(optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Stack|\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/TemplatesService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyTemplate()

◆ applyTemplateRequest()

◆ applyTemplateWithHttpInfo()

◆ createStack()

◆ createStackRequest()

◆ createStackWithHttpInfo()

◆ deleteStack()

◆ deleteStackRequest()

◆ deleteStackWithHttpInfo()

◆ exportTemplate()

◆ exportTemplateRequest()

◆ exportTemplateWithHttpInfo()

◆ listStacks()

◆ listStacksRequest()

◆ listStacksWithHttpInfo()

◆ readStack()

◆ readStackRequest()

◆ readStackWithHttpInfo()

◆ uninstallStack()

◆ uninstallStackRequest()

◆ uninstallStackWithHttpInfo()

◆ updateStack()

◆ updateStackRequest()

◆ updateStackWithHttpInfo()