Class InvokableScriptsService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

InvokableScriptsService

Implements

IInvokableScriptsService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class InvokableScriptsService : object, IInvokableScriptsService, IApiAccessor

Constructors

InvokableScriptsService(Configuration)

Initializes a new instance of the InvokableScriptsService class using Configuration object

Declaration

public InvokableScriptsService(Configuration configuration = null)

Parameters

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

InvokableScriptsService(String)

Initializes a new instance of the InvokableScriptsService class.

Declaration

public InvokableScriptsService(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.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

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

DeleteScriptsID(String)

Delete a script Deletes a script and all associated records.

Declaration

public void DeleteScriptsID(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.

Exceptions

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

DeleteScriptsIDAsync(String, CancellationToken)

Delete a script Deletes a script and all associated records.

Declaration

public System.Threading.Tasks.Task DeleteScriptsIDAsync(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.
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

DeleteScriptsIDAsyncWithHttpInfo(String, CancellationToken)

Delete a script Deletes a script and all associated records.

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteScriptsIDAsyncWithHttpInfo(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.
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

DeleteScriptsIDAsyncWithIRestResponse(String, CancellationToken)

Delete a script Deletes a script and all associated records.

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteScriptsIDAsyncWithIRestResponse(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.
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

DeleteScriptsIDWithHttpInfo(String)

Delete a script Deletes a script and all associated records.

Declaration

public ApiResponse<object> DeleteScriptsIDWithHttpInfo(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.

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

DeleteScriptsIDWithIRestResponse(String)

Delete a script Deletes a script and all associated records.

Declaration

public RestResponse DeleteScriptsIDWithIRestResponse(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.

Returns

Type	Description
RestResponse	ApiResponse of Object(void)

Exceptions

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

DeleteScriptsIDWithIRestResponseAsync(String, CancellationToken)

Delete a script Deletes a script and all associated records.

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteScriptsIDWithIRestResponseAsync(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.
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

DeleteScriptsIDWithRestRequest(String)

Delete a script Deletes a script and all associated records.

Declaration

public RestRequest DeleteScriptsIDWithRestRequest(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The ID of the script to delete.

Returns

Type	Description
RestRequest	ApiResponse of Object(void)

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

GetScripts(Nullable<Int32>, Nullable<Int32>)

List scripts

Declaration

public Scripts GetScripts(int? limit = null, int? offset = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)

Returns

Type	Description
Scripts	Scripts

Exceptions

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

GetScriptsAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List scripts

Declaration

public async System.Threading.Tasks.Task<Scripts> GetScriptsAsync(int? limit = null, int? offset = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsAsyncWithHttpInfo(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List scripts

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Scripts>> GetScriptsAsyncWithHttpInfo(int? limit = null, int? offset = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsAsyncWithIRestResponse(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List scripts

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetScriptsAsyncWithIRestResponse(int? limit = null, int? offset = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsID(String)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public Script GetScriptsID(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.

Returns

Type	Description
Script	Script

Exceptions

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

GetScriptsIDAsync(String, CancellationToken)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public async System.Threading.Tasks.Task<Script> GetScriptsIDAsync(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsIDAsyncWithHttpInfo(String, CancellationToken)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Script>> GetScriptsIDAsyncWithHttpInfo(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsIDAsyncWithIRestResponse(String, CancellationToken)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetScriptsIDAsyncWithIRestResponse(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsIDWithHttpInfo(String)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public ApiResponse<Script> GetScriptsIDWithHttpInfo(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.

Returns

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

Exceptions

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

GetScriptsIDWithIRestResponse(String)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public RestResponse GetScriptsIDWithIRestResponse(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.

Returns

Type	Description
RestResponse	ApiResponse of Script

Exceptions

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

GetScriptsIDWithIRestResponseAsync(String, CancellationToken)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetScriptsIDWithIRestResponseAsync(string scriptID, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsIDWithRestRequest(String)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Declaration

public RestRequest GetScriptsIDWithRestRequest(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.

Returns

Type	Description
RestRequest	ApiResponse of Script

Exceptions

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

GetScriptsWithHttpInfo(Nullable<Int32>, Nullable<Int32>)

List scripts

Declaration

public ApiResponse<Scripts> GetScriptsWithHttpInfo(int? limit = null, int? offset = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)

Returns

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

Exceptions

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

GetScriptsWithIRestResponse(Nullable<Int32>, Nullable<Int32>)

List scripts

Declaration

public RestResponse GetScriptsWithIRestResponse(int? limit = null, int? offset = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)

Returns

Type	Description
RestResponse	ApiResponse of Scripts

Exceptions

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

GetScriptsWithIRestResponseAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List scripts

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetScriptsWithIRestResponseAsync(int? limit = null, int? offset = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetScriptsWithRestRequest(Nullable<Int32>, Nullable<Int32>)

List scripts

Declaration

public RestRequest GetScriptsWithRestRequest(int? limit = null, int? offset = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	The number of scripts to return. (optional)
System.Nullable<System.Int32>	offset	The offset for pagination. (optional)

Returns

Type	Description
RestRequest	ApiResponse of Scripts

Exceptions

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

PatchScriptsID(String, ScriptUpdateRequest)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public Script PatchScriptsID(string scriptID, ScriptUpdateRequest scriptUpdateRequest)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply

Returns

Type	Description
Script	Script

Exceptions

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

PatchScriptsIDAsync(String, ScriptUpdateRequest, CancellationToken)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public async System.Threading.Tasks.Task<Script> PatchScriptsIDAsync(string scriptID, ScriptUpdateRequest scriptUpdateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PatchScriptsIDAsyncWithHttpInfo(String, ScriptUpdateRequest, CancellationToken)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Script>> PatchScriptsIDAsyncWithHttpInfo(string scriptID, ScriptUpdateRequest scriptUpdateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PatchScriptsIDAsyncWithIRestResponse(String, ScriptUpdateRequest, CancellationToken)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchScriptsIDAsyncWithIRestResponse(string scriptID, ScriptUpdateRequest scriptUpdateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PatchScriptsIDWithHttpInfo(String, ScriptUpdateRequest)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public ApiResponse<Script> PatchScriptsIDWithHttpInfo(string scriptID, ScriptUpdateRequest scriptUpdateRequest)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply

Returns

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

Exceptions

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

PatchScriptsIDWithIRestResponse(String, ScriptUpdateRequest)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public RestResponse PatchScriptsIDWithIRestResponse(string scriptID, ScriptUpdateRequest scriptUpdateRequest)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply

Returns

Type	Description
RestResponse	ApiResponse of Script

Exceptions

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

PatchScriptsIDWithIRestResponseAsync(String, ScriptUpdateRequest, CancellationToken)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchScriptsIDWithIRestResponseAsync(string scriptID, ScriptUpdateRequest scriptUpdateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PatchScriptsIDWithRestRequest(String, ScriptUpdateRequest)

Update a script Updates properties (name, description, and script) of an invokable script.

Declaration

public RestRequest PatchScriptsIDWithRestRequest(string scriptID, ScriptUpdateRequest scriptUpdateRequest)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.
ScriptUpdateRequest	scriptUpdateRequest	Script update to apply

Returns

Type	Description
RestRequest	ApiResponse of Script

Exceptions

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

PostScripts(ScriptCreateRequest)

Create a script

Declaration

public Script PostScripts(ScriptCreateRequest scriptCreateRequest)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.

Returns

Type	Description
Script	Script

Exceptions

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

PostScriptsAsync(ScriptCreateRequest, CancellationToken)

Create a script

Declaration

public async System.Threading.Tasks.Task<Script> PostScriptsAsync(ScriptCreateRequest scriptCreateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostScriptsAsyncWithHttpInfo(ScriptCreateRequest, CancellationToken)

Create a script

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Script>> PostScriptsAsyncWithHttpInfo(ScriptCreateRequest scriptCreateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostScriptsAsyncWithIRestResponse(ScriptCreateRequest, CancellationToken)

Create a script

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostScriptsAsyncWithIRestResponse(ScriptCreateRequest scriptCreateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostScriptsIDInvoke(String, ScriptInvocationParams)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public string PostScriptsIDInvoke(string scriptID, ScriptInvocationParams scriptInvocationParams = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)

Returns

Type	Description
System.String	string

Exceptions

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

PostScriptsIDInvokeAsync(String, ScriptInvocationParams, CancellationToken)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public async System.Threading.Tasks.Task<string> PostScriptsIDInvokeAsync(string scriptID, ScriptInvocationParams scriptInvocationParams = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Task of string

Exceptions

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

PostScriptsIDInvokeAsyncWithHttpInfo(String, ScriptInvocationParams, CancellationToken)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public async System.Threading.Tasks.Task<ApiResponse<string>> PostScriptsIDInvokeAsyncWithHttpInfo(string scriptID, ScriptInvocationParams scriptInvocationParams = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostScriptsIDInvokeAsyncWithIRestResponse(String, ScriptInvocationParams, CancellationToken)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostScriptsIDInvokeAsyncWithIRestResponse(string scriptID, ScriptInvocationParams scriptInvocationParams = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostScriptsIDInvokeWithHttpInfo(String, ScriptInvocationParams)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public ApiResponse<string> PostScriptsIDInvokeWithHttpInfo(string scriptID, ScriptInvocationParams scriptInvocationParams = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.String>	ApiResponse of string

Exceptions

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

PostScriptsIDInvokeWithIRestResponse(String, ScriptInvocationParams)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public RestResponse PostScriptsIDInvokeWithIRestResponse(string scriptID, ScriptInvocationParams scriptInvocationParams = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)

Returns

Type	Description
RestResponse	ApiResponse of string

Exceptions

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

PostScriptsIDInvokeWithIRestResponseAsync(String, ScriptInvocationParams, CancellationToken)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostScriptsIDInvokeWithIRestResponseAsync(string scriptID, ScriptInvocationParams scriptInvocationParams = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostScriptsIDInvokeWithRestRequest(String, ScriptInvocationParams)

Invoke a script Invokes a script and substitutes params keys referenced in the script with params key-values sent in the request body.

Declaration

public RestRequest PostScriptsIDInvokeWithRestRequest(string scriptID, ScriptInvocationParams scriptInvocationParams = null)

Parameters

Type	Name	Description
System.String	scriptID
ScriptInvocationParams	scriptInvocationParams	(optional)

Returns

Type	Description
RestRequest	ApiResponse of string

Exceptions

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

PostScriptsWithHttpInfo(ScriptCreateRequest)

Create a script

Declaration

public ApiResponse<Script> PostScriptsWithHttpInfo(ScriptCreateRequest scriptCreateRequest)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.

Returns

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

Exceptions

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

PostScriptsWithIRestResponse(ScriptCreateRequest)

Create a script

Declaration

public RestResponse PostScriptsWithIRestResponse(ScriptCreateRequest scriptCreateRequest)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.

Returns

Type	Description
RestResponse	ApiResponse of Script

Exceptions

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

PostScriptsWithIRestResponseAsync(ScriptCreateRequest, CancellationToken)

Create a script

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostScriptsWithIRestResponseAsync(ScriptCreateRequest scriptCreateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostScriptsWithRestRequest(ScriptCreateRequest)

Create a script

Declaration

public RestRequest PostScriptsWithRestRequest(ScriptCreateRequest scriptCreateRequest)

Parameters

Type	Name	Description
ScriptCreateRequest	scriptCreateRequest	The script to create.

Returns

Type	Description
RestRequest	ApiResponse of Script

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

Implements

IInvokableScriptsService