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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteDocumentsTemplatesID ($template_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDWithHttpInfo ($template_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDAsync ($template_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDAsyncWithHttpInfo ($template_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDLabelsID ($template_id, $label_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDLabelsIDWithHttpInfo ($template_id, $label_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDLabelsIDAsync ($template_id, $label_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDLabelsIDAsyncWithHttpInfo ($template_id, $label_id, $zap_trace_span=null)
 
 getDocumentsTemplates ($zap_trace_span=null, $org=null, $org_id=null)
 
 getDocumentsTemplatesWithHttpInfo ($zap_trace_span=null, $org=null, $org_id=null)
 
 getDocumentsTemplatesAsync ($zap_trace_span=null, $org=null, $org_id=null)
 
 getDocumentsTemplatesAsyncWithHttpInfo ($zap_trace_span=null, $org=null, $org_id=null)
 
 getDocumentsTemplatesID ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDWithHttpInfo ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDAsync ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDAsyncWithHttpInfo ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDLabels ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDLabelsWithHttpInfo ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDLabelsAsync ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDLabelsAsyncWithHttpInfo ($template_id, $zap_trace_span=null)
 
 postDocumentsTemplates ($document_create, $zap_trace_span=null)
 
 postDocumentsTemplatesWithHttpInfo ($document_create, $zap_trace_span=null)
 
 postDocumentsTemplatesAsync ($document_create, $zap_trace_span=null)
 
 postDocumentsTemplatesAsyncWithHttpInfo ($document_create, $zap_trace_span=null)
 
 postDocumentsTemplatesIDLabels ($template_id, $label_mapping, $zap_trace_span=null)
 
 postDocumentsTemplatesIDLabelsWithHttpInfo ($template_id, $label_mapping, $zap_trace_span=null)
 
 postDocumentsTemplatesIDLabelsAsync ($template_id, $label_mapping, $zap_trace_span=null)
 
 postDocumentsTemplatesIDLabelsAsyncWithHttpInfo ($template_id, $label_mapping, $zap_trace_span=null)
 
 putDocumentsTemplatesID ($template_id, $document_update, $zap_trace_span=null)
 
 putDocumentsTemplatesIDWithHttpInfo ($template_id, $document_update, $zap_trace_span=null)
 
 putDocumentsTemplatesIDAsync ($template_id, $document_update, $zap_trace_span=null)
 
 putDocumentsTemplatesIDAsyncWithHttpInfo ($template_id, $document_update, $zap_trace_span=null)
 

Protected Member Functions

 deleteDocumentsTemplatesIDRequest ($template_id, $zap_trace_span=null)
 
 deleteDocumentsTemplatesIDLabelsIDRequest ($template_id, $label_id, $zap_trace_span=null)
 
 getDocumentsTemplatesRequest ($zap_trace_span=null, $org=null, $org_id=null)
 
 getDocumentsTemplatesIDRequest ($template_id, $zap_trace_span=null)
 
 getDocumentsTemplatesIDLabelsRequest ($template_id, $zap_trace_span=null)
 
 postDocumentsTemplatesRequest ($document_create, $zap_trace_span=null)
 
 postDocumentsTemplatesIDLabelsRequest ($template_id, $label_mapping, $zap_trace_span=null)
 
 putDocumentsTemplatesIDRequest ($template_id, $document_update, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\TemplatesService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteDocumentsTemplatesID()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesID (   $template_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesID

Delete a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDocumentsTemplatesIDAsync()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDAsync (   $template_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesIDAsync

Delete a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDocumentsTemplatesIDAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDAsyncWithHttpInfo (   $template_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesIDAsyncWithHttpInfo

Delete a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDocumentsTemplatesIDLabelsID()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDLabelsID (   $template_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesIDLabelsID

Delete a label from a template

Parameters
string$template_idThe template ID. (required)
string$label_idThe label ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDocumentsTemplatesIDLabelsIDAsync()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDLabelsIDAsync (   $template_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesIDLabelsIDAsync

Delete a label from a template

Parameters
string$template_idThe template ID. (required)
string$label_idThe label ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDocumentsTemplatesIDLabelsIDAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDLabelsIDAsyncWithHttpInfo (   $template_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesIDLabelsIDAsyncWithHttpInfo

Delete a label from a template

Parameters
string$template_idThe template ID. (required)
string$label_idThe label ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDocumentsTemplatesIDLabelsIDRequest()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDLabelsIDRequest (   $template_id,
  $label_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteDocumentsTemplatesIDLabelsID'

Parameters
string$template_idThe template ID. (required)
string$label_idThe label ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteDocumentsTemplatesIDLabelsIDWithHttpInfo()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDLabelsIDWithHttpInfo (   $template_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesIDLabelsIDWithHttpInfo

Delete a label from a template

Parameters
string$template_idThe template ID. (required)
string$label_idThe label 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)

◆ deleteDocumentsTemplatesIDRequest()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDRequest (   $template_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteDocumentsTemplatesID'

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteDocumentsTemplatesIDWithHttpInfo()

InfluxDB2\Service\TemplatesService::deleteDocumentsTemplatesIDWithHttpInfo (   $template_id,
  $zap_trace_span = null 
)

Operation deleteDocumentsTemplatesIDWithHttpInfo

Delete a template

Parameters
string$template_idThe template 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)

◆ getConfig()

InfluxDB2\Service\TemplatesService::getConfig ( )
Returns
Configuration

◆ getDocumentsTemplates()

InfluxDB2\Service\TemplatesService::getDocumentsTemplates (   $zap_trace_span = null,
  $org = null,
  $org_id = null 
)

Operation getDocumentsTemplates

List all templates

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the name of the organization of the template. (optional)
string$org_idSpecifies the organization ID of the template. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Documents|\InfluxDB2\Model\Error

◆ getDocumentsTemplatesAsync()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesAsync (   $zap_trace_span = null,
  $org = null,
  $org_id = null 
)

Operation getDocumentsTemplatesAsync

List all templates

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the name of the organization of the template. (optional)
string$org_idSpecifies the organization ID of the template. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDocumentsTemplatesAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesAsyncWithHttpInfo (   $zap_trace_span = null,
  $org = null,
  $org_id = null 
)

Operation getDocumentsTemplatesAsyncWithHttpInfo

List all templates

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the name of the organization of the template. (optional)
string$org_idSpecifies the organization ID of the template. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDocumentsTemplatesID()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesID (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesID

Retrieve a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Document|\InfluxDB2\Model\Error

◆ getDocumentsTemplatesIDAsync()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDAsync (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesIDAsync

Retrieve a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDocumentsTemplatesIDAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDAsyncWithHttpInfo (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesIDAsyncWithHttpInfo

Retrieve a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDocumentsTemplatesIDLabels()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDLabels (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesIDLabels

List all labels for a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getDocumentsTemplatesIDLabelsAsync()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDLabelsAsync (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesIDLabelsAsync

List all labels for a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDocumentsTemplatesIDLabelsAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDLabelsAsyncWithHttpInfo (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesIDLabelsAsyncWithHttpInfo

List all labels for a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDocumentsTemplatesIDLabelsRequest()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDLabelsRequest (   $template_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getDocumentsTemplatesIDLabels'

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getDocumentsTemplatesIDLabelsWithHttpInfo()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDLabelsWithHttpInfo (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesIDLabelsWithHttpInfo

List all labels for a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing 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)

◆ getDocumentsTemplatesIDRequest()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDRequest (   $template_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getDocumentsTemplatesID'

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getDocumentsTemplatesIDWithHttpInfo()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesIDWithHttpInfo (   $template_id,
  $zap_trace_span = null 
)

Operation getDocumentsTemplatesIDWithHttpInfo

Retrieve a template

Parameters
string$template_idThe template ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getDocumentsTemplatesRequest()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesRequest (   $zap_trace_span = null,
  $org = null,
  $org_id = null 
)
protected

Create request for operation 'getDocumentsTemplates'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the name of the organization of the template. (optional)
string$org_idSpecifies the organization ID of the template. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getDocumentsTemplatesWithHttpInfo()

InfluxDB2\Service\TemplatesService::getDocumentsTemplatesWithHttpInfo (   $zap_trace_span = null,
  $org = null,
  $org_id = null 
)

Operation getDocumentsTemplatesWithHttpInfo

List all templates

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the name of the organization of the template. (optional)
string$org_idSpecifies the organization ID of the template. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postDocumentsTemplates()

InfluxDB2\Service\TemplatesService::postDocumentsTemplates (   $document_create,
  $zap_trace_span = null 
)

Operation postDocumentsTemplates

Create a template

Parameters
\InfluxDB2\Model\DocumentCreate$document_createTemplate that will be created (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Document|\InfluxDB2\Model\Error

◆ postDocumentsTemplatesAsync()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesAsync (   $document_create,
  $zap_trace_span = null 
)

Operation postDocumentsTemplatesAsync

Create a template

Parameters
\InfluxDB2\Model\DocumentCreate$document_createTemplate that will be created (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDocumentsTemplatesAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesAsyncWithHttpInfo (   $document_create,
  $zap_trace_span = null 
)

Operation postDocumentsTemplatesAsyncWithHttpInfo

Create a template

Parameters
\InfluxDB2\Model\DocumentCreate$document_createTemplate that will be created (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDocumentsTemplatesIDLabels()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesIDLabels (   $template_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postDocumentsTemplatesIDLabels

Add a label to a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postDocumentsTemplatesIDLabelsAsync()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesIDLabelsAsync (   $template_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postDocumentsTemplatesIDLabelsAsync

Add a label to a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDocumentsTemplatesIDLabelsAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesIDLabelsAsyncWithHttpInfo (   $template_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postDocumentsTemplatesIDLabelsAsyncWithHttpInfo

Add a label to a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDocumentsTemplatesIDLabelsRequest()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesIDLabelsRequest (   $template_id,
  $label_mapping,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDocumentsTemplatesIDLabels'

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postDocumentsTemplatesIDLabelsWithHttpInfo()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesIDLabelsWithHttpInfo (   $template_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postDocumentsTemplatesIDLabelsWithHttpInfo

Add a label to a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing 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)

◆ postDocumentsTemplatesRequest()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesRequest (   $document_create,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDocumentsTemplates'

Parameters
\InfluxDB2\Model\DocumentCreate$document_createTemplate that will be created (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postDocumentsTemplatesWithHttpInfo()

InfluxDB2\Service\TemplatesService::postDocumentsTemplatesWithHttpInfo (   $document_create,
  $zap_trace_span = null 
)

Operation postDocumentsTemplatesWithHttpInfo

Create a template

Parameters
\InfluxDB2\Model\DocumentCreate$document_createTemplate that will be created (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ putDocumentsTemplatesID()

InfluxDB2\Service\TemplatesService::putDocumentsTemplatesID (   $template_id,
  $document_update,
  $zap_trace_span = null 
)

Operation putDocumentsTemplatesID

Update a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\DocumentUpdate$document_updateTemplate that will be updated (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Document|\InfluxDB2\Model\Error

◆ putDocumentsTemplatesIDAsync()

InfluxDB2\Service\TemplatesService::putDocumentsTemplatesIDAsync (   $template_id,
  $document_update,
  $zap_trace_span = null 
)

Operation putDocumentsTemplatesIDAsync

Update a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\DocumentUpdate$document_updateTemplate that will be updated (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putDocumentsTemplatesIDAsyncWithHttpInfo()

InfluxDB2\Service\TemplatesService::putDocumentsTemplatesIDAsyncWithHttpInfo (   $template_id,
  $document_update,
  $zap_trace_span = null 
)

Operation putDocumentsTemplatesIDAsyncWithHttpInfo

Update a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\DocumentUpdate$document_updateTemplate that will be updated (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putDocumentsTemplatesIDRequest()

InfluxDB2\Service\TemplatesService::putDocumentsTemplatesIDRequest (   $template_id,
  $document_update,
  $zap_trace_span = null 
)
protected

Create request for operation 'putDocumentsTemplatesID'

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\DocumentUpdate$document_updateTemplate that will be updated (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ putDocumentsTemplatesIDWithHttpInfo()

InfluxDB2\Service\TemplatesService::putDocumentsTemplatesIDWithHttpInfo (   $template_id,
  $document_update,
  $zap_trace_span = null 
)

Operation putDocumentsTemplatesIDWithHttpInfo

Update a template

Parameters
string$template_idThe template ID. (required)
\InfluxDB2\Model\DocumentUpdate$document_updateTemplate that will be updated (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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