Interface ITemplatesService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ITemplatesService : IApiAccessor

Methods

ApplyTemplate(TemplateApply)

Apply or dry-run a template

Declaration

TemplateSummary ApplyTemplate(TemplateApply templateApply)

Parameters

Type	Name	Description
TemplateApply	templateApply

Returns

Type	Description
TemplateSummary	TemplateSummary

Remarks

Applies or performs a dry-run of template in an organization.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ApplyTemplateAsync(TemplateApply, CancellationToken)

Apply or dry-run a template

Declaration

System.Threading.Tasks.Task<TemplateSummary> ApplyTemplateAsync(TemplateApply templateApply, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
TemplateApply	templateApply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<TemplateSummary>	Task of TemplateSummary

Remarks

Applies or performs a dry-run of template in an organization.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ApplyTemplateAsyncWithHttpInfo(TemplateApply, CancellationToken)

Apply or dry-run a template

Declaration

System.Threading.Tasks.Task<ApiResponse<TemplateSummary>> ApplyTemplateAsyncWithHttpInfo(TemplateApply templateApply, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
TemplateApply	templateApply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TemplateSummary>>	Task of ApiResponse (TemplateSummary)

Remarks

Applies or performs a dry-run of template in an organization.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ApplyTemplateWithHttpInfo(TemplateApply)

Apply or dry-run a template

Declaration

ApiResponse<TemplateSummary> ApplyTemplateWithHttpInfo(TemplateApply templateApply)

Parameters

Type	Name	Description
TemplateApply	templateApply

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<TemplateSummary>	ApiResponse of TemplateSummary

Remarks

Applies or performs a dry-run of template in an organization.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

CreateStack(PostStackRequest)

Create a new stack

Declaration

Stack CreateStack(PostStackRequest postStackRequest = null)

Parameters

Type	Name	Description
PostStackRequest	postStackRequest	(optional)

Returns

Type	Description
Stack	Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

CreateStackAsync(PostStackRequest, CancellationToken)

Create a new stack

Declaration

System.Threading.Tasks.Task<Stack> CreateStackAsync(PostStackRequest postStackRequest = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostStackRequest	postStackRequest	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Stack>	Task of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

CreateStackAsyncWithHttpInfo(PostStackRequest, CancellationToken)

Create a new stack

Declaration

System.Threading.Tasks.Task<ApiResponse<Stack>> CreateStackAsyncWithHttpInfo(PostStackRequest postStackRequest = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostStackRequest	postStackRequest	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Stack>>	Task of ApiResponse (Stack)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

CreateStackWithHttpInfo(PostStackRequest)

Create a new stack

Declaration

ApiResponse<Stack> CreateStackWithHttpInfo(PostStackRequest postStackRequest = null)

Parameters

Type	Name	Description
PostStackRequest	postStackRequest	(optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Stack>	ApiResponse of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteStack(String, String)

Delete a stack and associated resources

Declaration

void DeleteStack(string stackId, string orgID)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
System.String	orgID	The identifier of the organization.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteStackAsync(String, String, CancellationToken)

Delete a stack and associated resources

Declaration

System.Threading.Tasks.Task DeleteStackAsync(string stackId, string orgID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
System.String	orgID	The identifier of the organization.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteStackAsyncWithHttpInfo(String, String, CancellationToken)

Delete a stack and associated resources

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteStackAsyncWithHttpInfo(string stackId, string orgID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
System.String	orgID	The identifier of the organization.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteStackWithHttpInfo(String, String)

Delete a stack and associated resources

Declaration

ApiResponse<object> DeleteStackWithHttpInfo(string stackId, string orgID)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
System.String	orgID	The identifier of the organization.

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ExportTemplate(TemplateExportByID)

Export a new template

Declaration

List<object> ExportTemplate(TemplateExportByID templateExportByID = null)

Parameters

Type	Name	Description
TemplateExportByID	templateExportByID	Export resources as an InfluxDB template. (optional)

Returns

Type	Description
List<System.Object>	List<Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ExportTemplateAsync(TemplateExportByID, CancellationToken)

Export a new template

Declaration

System.Threading.Tasks.Task<List<object>> ExportTemplateAsync(TemplateExportByID templateExportByID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
TemplateExportByID	templateExportByID	Export resources as an InfluxDB template. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<List<System.Object>>	Task of List<Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ExportTemplateAsyncWithHttpInfo(TemplateExportByID, CancellationToken)

Export a new template

Declaration

System.Threading.Tasks.Task<ApiResponse<List<object>>> ExportTemplateAsyncWithHttpInfo(TemplateExportByID templateExportByID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
TemplateExportByID	templateExportByID	Export resources as an InfluxDB template. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<List<System.Object>>>	Task of ApiResponse (List<Object>)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ExportTemplateWithHttpInfo(TemplateExportByID)

Export a new template

Declaration

ApiResponse<List<object>> ExportTemplateWithHttpInfo(TemplateExportByID templateExportByID = null)

Parameters

Type	Name	Description
TemplateExportByID	templateExportByID	Export resources as an InfluxDB template. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<List<System.Object>>	ApiResponse of List<Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ListStacks(String, String, String)

List installed templates

Declaration

ListStacksResponse ListStacks(string orgID, string name = null, string stackID = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID of the stacks
System.String	name	A collection of names to filter the list by. (optional)
System.String	stackID	A collection of stackIDs to filter the list by. (optional)

Returns

Type	Description
ListStacksResponse	ListStacksResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ListStacksAsync(String, String, String, CancellationToken)

List installed templates

Declaration

System.Threading.Tasks.Task<ListStacksResponse> ListStacksAsync(string orgID, string name = null, string stackID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID of the stacks
System.String	name	A collection of names to filter the list by. (optional)
System.String	stackID	A collection of stackIDs to filter the list by. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ListStacksResponse>	Task of ListStacksResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ListStacksAsyncWithHttpInfo(String, String, String, CancellationToken)

List installed templates

Declaration

System.Threading.Tasks.Task<ApiResponse<ListStacksResponse>> ListStacksAsyncWithHttpInfo(string orgID, string name = null, string stackID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID of the stacks
System.String	name	A collection of names to filter the list by. (optional)
System.String	stackID	A collection of stackIDs to filter the list by. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ListStacksResponse>>	Task of ApiResponse (ListStacksResponse)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ListStacksWithHttpInfo(String, String, String)

List installed templates

Declaration

ApiResponse<ListStacksResponse> ListStacksWithHttpInfo(string orgID, string name = null, string stackID = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID of the stacks
System.String	name	A collection of names to filter the list by. (optional)
System.String	stackID	A collection of stackIDs to filter the list by. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ListStacksResponse>	ApiResponse of ListStacksResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ReadStack(String)

Retrieve a stack

Declaration

Stack ReadStack(string stackId)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.

Returns

Type	Description
Stack	Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ReadStackAsync(String, CancellationToken)

Retrieve a stack

Declaration

System.Threading.Tasks.Task<Stack> ReadStackAsync(string stackId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Stack>	Task of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ReadStackAsyncWithHttpInfo(String, CancellationToken)

Retrieve a stack

Declaration

System.Threading.Tasks.Task<ApiResponse<Stack>> ReadStackAsyncWithHttpInfo(string stackId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Stack>>	Task of ApiResponse (Stack)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

ReadStackWithHttpInfo(String)

Retrieve a stack

Declaration

ApiResponse<Stack> ReadStackWithHttpInfo(string stackId)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Stack>	ApiResponse of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UninstallStack(String)

Uninstall a stack

Declaration

Stack UninstallStack(string stackId)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.

Returns

Type	Description
Stack	Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UninstallStackAsync(String, CancellationToken)

Uninstall a stack

Declaration

System.Threading.Tasks.Task<Stack> UninstallStackAsync(string stackId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Stack>	Task of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UninstallStackAsyncWithHttpInfo(String, CancellationToken)

Uninstall a stack

Declaration

System.Threading.Tasks.Task<ApiResponse<Stack>> UninstallStackAsyncWithHttpInfo(string stackId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Stack>>	Task of ApiResponse (Stack)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UninstallStackWithHttpInfo(String)

Uninstall a stack

Declaration

ApiResponse<Stack> UninstallStackWithHttpInfo(string stackId)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Stack>	ApiResponse of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UpdateStack(String, PatchStackRequest)

Update a stack

Declaration

Stack UpdateStack(string stackId, PatchStackRequest patchStackRequest = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
PatchStackRequest	patchStackRequest	(optional)

Returns

Type	Description
Stack	Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UpdateStackAsync(String, PatchStackRequest, CancellationToken)

Update a stack

Declaration

System.Threading.Tasks.Task<Stack> UpdateStackAsync(string stackId, PatchStackRequest patchStackRequest = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
PatchStackRequest	patchStackRequest	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Stack>	Task of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UpdateStackAsyncWithHttpInfo(String, PatchStackRequest, CancellationToken)

Update a stack

Declaration

System.Threading.Tasks.Task<ApiResponse<Stack>> UpdateStackAsyncWithHttpInfo(string stackId, PatchStackRequest patchStackRequest = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
PatchStackRequest	patchStackRequest	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Stack>>	Task of ApiResponse (Stack)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

UpdateStackWithHttpInfo(String, PatchStackRequest)

Update a stack

Declaration

ApiResponse<Stack> UpdateStackWithHttpInfo(string stackId, PatchStackRequest patchStackRequest = null)

Parameters

Type	Name	Description
System.String	stackId	The identifier of the stack.
PatchStackRequest	patchStackRequest	(optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Stack>	ApiResponse of Stack

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call