Interface IInvokableScriptsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IInvokableScriptsService : IApiAccessor

Methods

DeleteScriptsID(String)

Delete a script

Declaration

void DeleteScriptsID(string scriptID)

Parameters

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

Remarks

Deletes a script and all associated records.

Exceptions

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

DeleteScriptsIDAsync(String, CancellationToken)

Delete a script

Declaration

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

Remarks

Deletes a script and all associated records.

Exceptions

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

DeleteScriptsIDAsyncWithHttpInfo(String, CancellationToken)

Delete a script

Declaration

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

Remarks

Deletes a script and all associated records.

Exceptions

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

DeleteScriptsIDWithHttpInfo(String)

Delete a script

Declaration

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)

Remarks

Deletes a script and all associated records.

Exceptions

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

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

List scripts

Declaration

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

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

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

GetScriptsID(String)

Retrieve a script

Declaration

Script GetScriptsID(string scriptID)

Parameters

Type	Name	Description
System.String	scriptID	The script ID.

Returns

Type	Description
Script	Script

Remarks

Uses script ID to retrieve details of an invokable script.

Exceptions

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

GetScriptsIDAsync(String, CancellationToken)

Retrieve a script

Declaration

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

Remarks

Uses script ID to retrieve details of an invokable script.

Exceptions

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

GetScriptsIDAsyncWithHttpInfo(String, CancellationToken)

Retrieve a script

Declaration

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)

Remarks

Uses script ID to retrieve details of an invokable script.

Exceptions

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

GetScriptsIDWithHttpInfo(String)

Retrieve a script

Declaration

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

Remarks

Uses script ID to retrieve details of an invokable script.

Exceptions

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

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

List scripts

Declaration

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

PatchScriptsID(String, ScriptUpdateRequest)

Update a script

Declaration

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

Remarks

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

Exceptions

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

PatchScriptsIDAsync(String, ScriptUpdateRequest, CancellationToken)

Update a script

Declaration

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

Remarks

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

Exceptions

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

PatchScriptsIDAsyncWithHttpInfo(String, ScriptUpdateRequest, CancellationToken)

Update a script

Declaration

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)

Remarks

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

Exceptions

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

PatchScriptsIDWithHttpInfo(String, ScriptUpdateRequest)

Update a script

Declaration

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

Remarks

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

Exceptions

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

PostScripts(ScriptCreateRequest)

Create a script

Declaration

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

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

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

PostScriptsIDInvoke(String, ScriptInvocationParams)

Invoke a script

Declaration

string PostScriptsIDInvoke(string scriptID, ScriptInvocationParams scriptInvocationParams = null)

Parameters

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

Returns

Type	Description
System.String	string

Remarks

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

Exceptions

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

PostScriptsIDInvokeAsync(String, ScriptInvocationParams, CancellationToken)

Invoke a script

Declaration

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

Remarks

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

Exceptions

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

PostScriptsIDInvokeAsyncWithHttpInfo(String, ScriptInvocationParams, CancellationToken)

Invoke a script

Declaration

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)

Remarks

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

Exceptions

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

PostScriptsIDInvokeWithHttpInfo(String, ScriptInvocationParams)

Invoke a script

Declaration

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

Remarks

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

Exceptions

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

PostScriptsWithHttpInfo(ScriptCreateRequest)

Create a script

Declaration

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