Class TemplatesService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

TemplatesService

Implements

ITemplatesService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class TemplatesService : object, ITemplatesService, IApiAccessor

Constructors

TemplatesService(Configuration)

Initializes a new instance of the TemplatesService class using Configuration object

Declaration

public TemplatesService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

TemplatesService(String)

Initializes a new instance of the TemplatesService class.

Declaration

public TemplatesService(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

ApplyTemplate(TemplateApply)

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

Declaration

public TemplateSummary ApplyTemplate(TemplateApply templateApply)

Parameters

Type	Name	Description
TemplateApply	templateApply

Returns

Type	Description
TemplateSummary	TemplateSummary

Exceptions

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

ApplyTemplateAsync(TemplateApply, CancellationToken)

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

Declaration

public async 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

Exceptions

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

ApplyTemplateAsyncWithHttpInfo(TemplateApply, CancellationToken)

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

Declaration

public async 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)

Exceptions

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

ApplyTemplateAsyncWithIRestResponse(TemplateApply, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> ApplyTemplateAsyncWithIRestResponse(TemplateApply templateApply, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
TemplateApply	templateApply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (TemplateSummary)

Exceptions

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

ApplyTemplateWithHttpInfo(TemplateApply)

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

Declaration

public ApiResponse<TemplateSummary> ApplyTemplateWithHttpInfo(TemplateApply templateApply)

Parameters

Type	Name	Description
TemplateApply	templateApply

Returns

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

Exceptions

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

ApplyTemplateWithIRestResponse(TemplateApply)

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

Declaration

public RestResponse ApplyTemplateWithIRestResponse(TemplateApply templateApply)

Parameters

Type	Name	Description
TemplateApply	templateApply

Returns

Type	Description
RestResponse	ApiResponse of TemplateSummary

Exceptions

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

ApplyTemplateWithIRestResponseAsync(TemplateApply, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> ApplyTemplateWithIRestResponseAsync(TemplateApply templateApply, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
TemplateApply	templateApply
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

ApplyTemplateWithRestRequest(TemplateApply)

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

Declaration

public RestRequest ApplyTemplateWithRestRequest(TemplateApply templateApply)

Parameters

Type	Name	Description
TemplateApply	templateApply

Returns

Type	Description
RestRequest	ApiResponse of TemplateSummary

Exceptions

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

CreateStack(PostStackRequest)

Create a new stack

Declaration

public 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

public async 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

public async 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

CreateStackAsyncWithIRestResponse(PostStackRequest, CancellationToken)

Create a new stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> CreateStackAsyncWithIRestResponse(PostStackRequest postStackRequest = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Stack)

Exceptions

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

CreateStackWithHttpInfo(PostStackRequest)

Create a new stack

Declaration

public 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

CreateStackWithIRestResponse(PostStackRequest)

Create a new stack

Declaration

public RestResponse CreateStackWithIRestResponse(PostStackRequest postStackRequest = null)

Parameters

Type	Name	Description
PostStackRequest	postStackRequest	(optional)

Returns

Type	Description
RestResponse	ApiResponse of Stack

Exceptions

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

CreateStackWithIRestResponseAsync(PostStackRequest, CancellationToken)

Create a new stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> CreateStackWithIRestResponseAsync(PostStackRequest postStackRequest = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

CreateStackWithRestRequest(PostStackRequest)

Create a new stack

Declaration

public RestRequest CreateStackWithRestRequest(PostStackRequest postStackRequest = null)

Parameters

Type	Name	Description
PostStackRequest	postStackRequest	(optional)

Returns

Type	Description
RestRequest	ApiResponse of Stack

Exceptions

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

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
IDictionary<System.String, System.String>	Dictionary of HTTP header

DeleteStack(String, String)

Delete a stack and associated resources

Declaration

public 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

public 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

public async 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

DeleteStackAsyncWithIRestResponse(String, String, CancellationToken)

Delete a stack and associated resources

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteStackAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

DeleteStackWithIRestResponse(String, String)

Delete a stack and associated resources

Declaration

public RestResponse DeleteStackWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

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

DeleteStackWithIRestResponseAsync(String, String, CancellationToken)

Delete a stack and associated resources

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteStackWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

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

DeleteStackWithRestRequest(String, String)

Delete a stack and associated resources

Declaration

public RestRequest DeleteStackWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

ExportTemplateAsyncWithIRestResponse(TemplateExportByID, CancellationToken)

Export a new template

Declaration

public async System.Threading.Tasks.Task<RestResponse> ExportTemplateAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (List<Object>)

Exceptions

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

ExportTemplateWithHttpInfo(TemplateExportByID)

Export a new template

Declaration

public 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

ExportTemplateWithIRestResponse(TemplateExportByID)

Export a new template

Declaration

public RestResponse ExportTemplateWithIRestResponse(TemplateExportByID templateExportByID = null)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of List<Object>

Exceptions

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

ExportTemplateWithIRestResponseAsync(TemplateExportByID, CancellationToken)

Export a new template

Declaration

public async System.Threading.Tasks.Task<RestResponse> ExportTemplateWithIRestResponseAsync(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<RestResponse>	ApiResponse of List<Object>

Exceptions

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

ExportTemplateWithRestRequest(TemplateExportByID)

Export a new template

Declaration

public RestRequest ExportTemplateWithRestRequest(TemplateExportByID templateExportByID = null)

Parameters

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

Returns

Type	Description
RestRequest	ApiResponse of List<Object>

Exceptions

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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

ListStacks(String, String, String)

List installed templates

Declaration

public 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

public async 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

public async 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

ListStacksAsyncWithIRestResponse(String, String, String, CancellationToken)

List installed templates

Declaration

public async System.Threading.Tasks.Task<RestResponse> ListStacksAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (ListStacksResponse)

Exceptions

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

ListStacksWithHttpInfo(String, String, String)

List installed templates

Declaration

public 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

ListStacksWithIRestResponse(String, String, String)

List installed templates

Declaration

public RestResponse ListStacksWithIRestResponse(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
RestResponse	ApiResponse of ListStacksResponse

Exceptions

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

ListStacksWithIRestResponseAsync(String, String, String, CancellationToken)

List installed templates

Declaration

public async System.Threading.Tasks.Task<RestResponse> ListStacksWithIRestResponseAsync(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<RestResponse>	ApiResponse of ListStacksResponse

Exceptions

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

ListStacksWithRestRequest(String, String, String)

List installed templates

Declaration

public RestRequest ListStacksWithRestRequest(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
RestRequest	ApiResponse of ListStacksResponse

Exceptions

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

ReadStack(String)

Retrieve a stack

Declaration

public 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

public async 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

public async 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

ReadStackAsyncWithIRestResponse(String, CancellationToken)

Retrieve a stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> ReadStackAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (Stack)

Exceptions

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

ReadStackWithHttpInfo(String)

Retrieve a stack

Declaration

public 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

ReadStackWithIRestResponse(String)

Retrieve a stack

Declaration

public RestResponse ReadStackWithIRestResponse(string stackId)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of Stack

Exceptions

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

ReadStackWithIRestResponseAsync(String, CancellationToken)

Retrieve a stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> ReadStackWithIRestResponseAsync(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<RestResponse>	ApiResponse of Stack

Exceptions

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

ReadStackWithRestRequest(String)

Retrieve a stack

Declaration

public RestRequest ReadStackWithRestRequest(string stackId)

Parameters

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

Returns

Type	Description
RestRequest	ApiResponse of Stack

Exceptions

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

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

UninstallStack(String)

Uninstall a stack

Declaration

public 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

public async 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

public async 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

UninstallStackAsyncWithIRestResponse(String, CancellationToken)

Uninstall a stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> UninstallStackAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (Stack)

Exceptions

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

UninstallStackWithHttpInfo(String)

Uninstall a stack

Declaration

public 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

UninstallStackWithIRestResponse(String)

Uninstall a stack

Declaration

public RestResponse UninstallStackWithIRestResponse(string stackId)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of Stack

Exceptions

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

UninstallStackWithIRestResponseAsync(String, CancellationToken)

Uninstall a stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> UninstallStackWithIRestResponseAsync(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<RestResponse>	ApiResponse of Stack

Exceptions

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

UninstallStackWithRestRequest(String)

Uninstall a stack

Declaration

public RestRequest UninstallStackWithRestRequest(string stackId)

Parameters

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

Returns

Type	Description
RestRequest	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

public 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

public async 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

public async 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

UpdateStackAsyncWithIRestResponse(String, PatchStackRequest, CancellationToken)

Update a stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> UpdateStackAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (Stack)

Exceptions

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

UpdateStackWithHttpInfo(String, PatchStackRequest)

Update a stack

Declaration

public 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

UpdateStackWithIRestResponse(String, PatchStackRequest)

Update a stack

Declaration

public RestResponse UpdateStackWithIRestResponse(string stackId, PatchStackRequest patchStackRequest = null)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of Stack

Exceptions

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

UpdateStackWithIRestResponseAsync(String, PatchStackRequest, CancellationToken)

Update a stack

Declaration

public async System.Threading.Tasks.Task<RestResponse> UpdateStackWithIRestResponseAsync(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<RestResponse>	ApiResponse of Stack

Exceptions

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

UpdateStackWithRestRequest(String, PatchStackRequest)

Update a stack

Declaration

public RestRequest UpdateStackWithRestRequest(string stackId, PatchStackRequest patchStackRequest = null)

Parameters

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

Returns

Type	Description
RestRequest	ApiResponse of Stack

Exceptions

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

Implements

ITemplatesService