• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

Class TasksService

Represents a collection of functions to interact with the API endpoints

Inheritance
System.Object
TasksService
Implements
ITasksService
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class TasksService : object, ITasksService, IApiAccessor

Constructors

TasksService(Configuration)

Initializes a new instance of the TasksService class using Configuration object

Declaration
public TasksService(Configuration configuration = null)
Parameters
Type Name Description
InfluxDB.Client.Api.Client.Configuration configuration

An instance of Configuration

TasksService(String)

Initializes a new instance of the TasksService class.

Declaration
public TasksService(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

DeleteTasksID(String, String)

Delete a task Deletes a task and all associated records

Declaration
public void DeleteTasksID(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDAsync(String, String, CancellationToken)

Delete a task Deletes a task and all associated records

Declaration
public System.Threading.Tasks.Task DeleteTasksIDAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a task Deletes a task and all associated records

Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a task Deletes a task and all associated records

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDLabelsID(String, String, String)

Delete a label from a task

Declaration
public void DeleteTasksIDLabelsID(string taskID, string labelID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a task

Declaration
public System.Threading.Tasks.Task DeleteTasksIDLabelsIDAsync(string taskID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDLabelsIDAsyncWithHttpInfo(string taskID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete a label from a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDLabelsIDAsyncWithIRestResponse(string taskID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a task

Declaration
public ApiResponse<object> DeleteTasksIDLabelsIDWithHttpInfo(string taskID, string labelID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDLabelsIDWithIRestResponse(String, String, String)

Delete a label from a task

Declaration
public RestResponse DeleteTasksIDLabelsIDWithIRestResponse(string taskID, string labelID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete a label from a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDLabelsIDWithIRestResponseAsync(string taskID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDLabelsIDWithRestRequest(String, String, String)

Delete a label from a task

Declaration
public RestRequest DeleteTasksIDLabelsIDWithRestRequest(string taskID, string labelID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDMembersID(String, String, String)

Remove a member from a task

Declaration
public void DeleteTasksIDMembersID(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDMembersIDAsync(String, String, String, CancellationToken)

Remove a member from a task

Declaration
public System.Threading.Tasks.Task DeleteTasksIDMembersIDAsync(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove a member from a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDMembersIDAsyncWithHttpInfo(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDMembersIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Remove a member from a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDMembersIDAsyncWithIRestResponse(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDMembersIDWithHttpInfo(String, String, String)

Remove a member from a task

Declaration
public ApiResponse<object> DeleteTasksIDMembersIDWithHttpInfo(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDMembersIDWithIRestResponse(String, String, String)

Remove a member from a task

Declaration
public RestResponse DeleteTasksIDMembersIDWithIRestResponse(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDMembersIDWithIRestResponseAsync(String, String, String, CancellationToken)

Remove a member from a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDMembersIDWithIRestResponseAsync(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDMembersIDWithRestRequest(String, String, String)

Remove a member from a task

Declaration
public RestRequest DeleteTasksIDMembersIDWithRestRequest(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDOwnersID(String, String, String)

Remove an owner from a task

Declaration
public void DeleteTasksIDOwnersID(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDOwnersIDAsync(String, String, String, CancellationToken)

Remove an owner from a task

Declaration
public System.Threading.Tasks.Task DeleteTasksIDOwnersIDAsync(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove an owner from a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDOwnersIDAsyncWithHttpInfo(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDOwnersIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Remove an owner from a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDOwnersIDAsyncWithIRestResponse(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDOwnersIDWithHttpInfo(String, String, String)

Remove an owner from a task

Declaration
public ApiResponse<object> DeleteTasksIDOwnersIDWithHttpInfo(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDOwnersIDWithIRestResponse(String, String, String)

Remove an owner from a task

Declaration
public RestResponse DeleteTasksIDOwnersIDWithIRestResponse(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDOwnersIDWithIRestResponseAsync(String, String, String, CancellationToken)

Remove an owner from a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDOwnersIDWithIRestResponseAsync(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDOwnersIDWithRestRequest(String, String, String)

Remove an owner from a task

Declaration
public RestRequest DeleteTasksIDOwnersIDWithRestRequest(string userID, string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDRunsID(String, String, String)

Cancel a running task

Declaration
public void DeleteTasksIDRunsID(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDRunsIDAsync(String, String, String, CancellationToken)

Cancel a running task

Declaration
public System.Threading.Tasks.Task DeleteTasksIDRunsIDAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDRunsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Cancel a running task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDRunsIDAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDRunsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Cancel a running task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDRunsIDAsyncWithIRestResponse(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDRunsIDWithHttpInfo(String, String, String)

Cancel a running task

Declaration
public ApiResponse<object> DeleteTasksIDRunsIDWithHttpInfo(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDRunsIDWithIRestResponse(String, String, String)

Cancel a running task

Declaration
public RestResponse DeleteTasksIDRunsIDWithIRestResponse(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDRunsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Cancel a running task

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDRunsIDWithIRestResponseAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDRunsIDWithRestRequest(String, String, String)

Cancel a running task

Declaration
public RestRequest DeleteTasksIDRunsIDWithRestRequest(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDWithHttpInfo(String, String)

Delete a task Deletes a task and all associated records

Declaration
public ApiResponse<object> DeleteTasksIDWithHttpInfo(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDWithIRestResponse(String, String)

Delete a task Deletes a task and all associated records

Declaration
public RestResponse DeleteTasksIDWithIRestResponse(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteTasksIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a task Deletes a task and all associated records

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteTasksIDWithIRestResponseAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

DeleteTasksIDWithRestRequest(String, String)

Delete a task Deletes a task and all associated records

Declaration
public RestRequest DeleteTasksIDWithRestRequest(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

GetTasks(String, String, String, String, String, String, String, Nullable<Int32>, String)

List all tasks

Declaration
public Tasks GetTasks(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

Returns
Type Description
Tasks

Tasks

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksAsync(String, String, String, String, String, String, String, Nullable<Int32>, String, CancellationToken)

List all tasks

Declaration
public async System.Threading.Tasks.Task<Tasks> GetTasksAsync(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<Tasks>

Task of Tasks

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksAsyncWithHttpInfo(String, String, String, String, String, String, String, Nullable<Int32>, String, CancellationToken)

List all tasks

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Tasks>> GetTasksAsyncWithHttpInfo(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Tasks)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksAsyncWithIRestResponse(String, String, String, String, String, String, String, Nullable<Int32>, String, CancellationToken)

List all tasks

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksAsyncWithIRestResponse(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (Tasks)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksID(String, String)

Retrieve a task

Declaration
public TaskType GetTasksID(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
TaskType

TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDAsync(String, String, CancellationToken)

Retrieve a task

Declaration
public async System.Threading.Tasks.Task<TaskType> GetTasksIDAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<TaskType>

Task of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<TaskType>> GetTasksIDAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TaskType>>

Task of ApiResponse (TaskType)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (TaskType)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabels(String, String)

List all labels for a task

Declaration
public LabelsResponse GetTasksIDLabels(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
LabelsResponse

LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabelsAsync(String, String, CancellationToken)

List all labels for a task

Declaration
public async System.Threading.Tasks.Task<LabelsResponse> GetTasksIDLabelsAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<LabelsResponse>

Task of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetTasksIDLabelsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>>

Task of ApiResponse (LabelsResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)

List all labels for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDLabelsAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (LabelsResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabelsWithHttpInfo(String, String)

List all labels for a task

Declaration
public ApiResponse<LabelsResponse> GetTasksIDLabelsWithHttpInfo(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>

ApiResponse of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabelsWithIRestResponse(String, String)

List all labels for a task

Declaration
public RestResponse GetTasksIDLabelsWithIRestResponse(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabelsWithIRestResponseAsync(String, String, CancellationToken)

List all labels for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDLabelsWithIRestResponseAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLabelsWithRestRequest(String, String)

List all labels for a task

Declaration
public RestRequest GetTasksIDLabelsWithRestRequest(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogs(String, String)

Retrieve all logs for a task

Declaration
public Logs GetTasksIDLogs(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Logs

Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogsAsync(String, String, CancellationToken)

Retrieve all logs for a task

Declaration
public async System.Threading.Tasks.Task<Logs> GetTasksIDLogsAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<Logs>

Task of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogsAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve all logs for a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Logs>> GetTasksIDLogsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Logs>>

Task of ApiResponse (Logs)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogsAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve all logs for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDLogsAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (Logs)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogsWithHttpInfo(String, String)

Retrieve all logs for a task

Declaration
public ApiResponse<Logs> GetTasksIDLogsWithHttpInfo(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<Logs>

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogsWithIRestResponse(String, String)

Retrieve all logs for a task

Declaration
public RestResponse GetTasksIDLogsWithIRestResponse(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogsWithIRestResponseAsync(String, String, CancellationToken)

Retrieve all logs for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDLogsWithIRestResponseAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDLogsWithRestRequest(String, String)

Retrieve all logs for a task

Declaration
public RestRequest GetTasksIDLogsWithRestRequest(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembers(String, String)

List all task members

Declaration
public ResourceMembers GetTasksIDMembers(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceMembers

ResourceMembers

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembersAsync(String, String, CancellationToken)

List all task members

Declaration
public async System.Threading.Tasks.Task<ResourceMembers> GetTasksIDMembersAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<ResourceMembers>

Task of ResourceMembers

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembersAsyncWithHttpInfo(String, String, CancellationToken)

List all task members

Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetTasksIDMembersAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers>>

Task of ApiResponse (ResourceMembers)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembersAsyncWithIRestResponse(String, String, CancellationToken)

List all task members

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDMembersAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (ResourceMembers)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembersWithHttpInfo(String, String)

List all task members

Declaration
public ApiResponse<ResourceMembers> GetTasksIDMembersWithHttpInfo(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers>

ApiResponse of ResourceMembers

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembersWithIRestResponse(String, String)

List all task members

Declaration
public RestResponse GetTasksIDMembersWithIRestResponse(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of ResourceMembers

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembersWithIRestResponseAsync(String, String, CancellationToken)

List all task members

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDMembersWithIRestResponseAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of ResourceMembers

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDMembersWithRestRequest(String, String)

List all task members

Declaration
public RestRequest GetTasksIDMembersWithRestRequest(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of ResourceMembers

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwners(String, String)

List all owners of a task

Declaration
public ResourceOwners GetTasksIDOwners(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceOwners

ResourceOwners

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwnersAsync(String, String, CancellationToken)

List all owners of a task

Declaration
public async System.Threading.Tasks.Task<ResourceOwners> GetTasksIDOwnersAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<ResourceOwners>

Task of ResourceOwners

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)

List all owners of a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetTasksIDOwnersAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners>>

Task of ApiResponse (ResourceOwners)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwnersAsyncWithIRestResponse(String, String, CancellationToken)

List all owners of a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDOwnersAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (ResourceOwners)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwnersWithHttpInfo(String, String)

List all owners of a task

Declaration
public ApiResponse<ResourceOwners> GetTasksIDOwnersWithHttpInfo(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners>

ApiResponse of ResourceOwners

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwnersWithIRestResponse(String, String)

List all owners of a task

Declaration
public RestResponse GetTasksIDOwnersWithIRestResponse(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of ResourceOwners

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwnersWithIRestResponseAsync(String, String, CancellationToken)

List all owners of a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDOwnersWithIRestResponseAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of ResourceOwners

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDOwnersWithRestRequest(String, String)

List all owners of a task

Declaration
public RestRequest GetTasksIDOwnersWithRestRequest(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of ResourceOwners

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRuns(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>)

List runs for a task

Declaration
public Runs GetTasksIDRuns(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

Returns
Type Description
Runs

Runs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsAsync(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>, CancellationToken)

List runs for a task

Declaration
public async System.Threading.Tasks.Task<Runs> GetTasksIDRunsAsync(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<Runs>

Task of Runs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsAsyncWithHttpInfo(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>, CancellationToken)

List runs for a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Runs>> GetTasksIDRunsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Runs>>

Task of ApiResponse (Runs)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsAsyncWithIRestResponse(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>, CancellationToken)

List runs for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDRunsAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (Runs)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsID(String, String, String)

Retrieve a single run for a task

Declaration
public Run GetTasksIDRunsID(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Run

Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDAsync(String, String, String, CancellationToken)

Retrieve a single run for a task

Declaration
public async System.Threading.Tasks.Task<Run> GetTasksIDRunsIDAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<Run>

Task of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Retrieve a single run for a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Run>> GetTasksIDRunsIDAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Run>>

Task of ApiResponse (Run)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Retrieve a single run for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDRunsIDAsyncWithIRestResponse(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (Run)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogs(String, String, String)

Retrieve all logs for a run

Declaration
public Logs GetTasksIDRunsIDLogs(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Logs

Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogsAsync(String, String, String, CancellationToken)

Retrieve all logs for a run

Declaration
public async System.Threading.Tasks.Task<Logs> GetTasksIDRunsIDLogsAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<Logs>

Task of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogsAsyncWithHttpInfo(String, String, String, CancellationToken)

Retrieve all logs for a run

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Logs>> GetTasksIDRunsIDLogsAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Logs>>

Task of ApiResponse (Logs)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogsAsyncWithIRestResponse(String, String, String, CancellationToken)

Retrieve all logs for a run

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDRunsIDLogsAsyncWithIRestResponse(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (Logs)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogsWithHttpInfo(String, String, String)

Retrieve all logs for a run

Declaration
public ApiResponse<Logs> GetTasksIDRunsIDLogsWithHttpInfo(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<Logs>

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogsWithIRestResponse(String, String, String)

Retrieve all logs for a run

Declaration
public RestResponse GetTasksIDRunsIDLogsWithIRestResponse(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogsWithIRestResponseAsync(String, String, String, CancellationToken)

Retrieve all logs for a run

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDRunsIDLogsWithIRestResponseAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDLogsWithRestRequest(String, String, String)

Retrieve all logs for a run

Declaration
public RestRequest GetTasksIDRunsIDLogsWithRestRequest(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

ID of task to get logs for.

System.String runID

ID of run to get logs for.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Logs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDWithHttpInfo(String, String, String)

Retrieve a single run for a task

Declaration
public ApiResponse<Run> GetTasksIDRunsIDWithHttpInfo(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<Run>

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDWithIRestResponse(String, String, String)

Retrieve a single run for a task

Declaration
public RestResponse GetTasksIDRunsIDWithIRestResponse(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Retrieve a single run for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDRunsIDWithIRestResponseAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsIDWithRestRequest(String, String, String)

Retrieve a single run for a task

Declaration
public RestRequest GetTasksIDRunsIDWithRestRequest(string taskID, string runID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsWithHttpInfo(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>)

List runs for a task

Declaration
public ApiResponse<Runs> GetTasksIDRunsWithHttpInfo(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<Runs>

ApiResponse of Runs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsWithIRestResponse(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>)

List runs for a task

Declaration
public RestResponse GetTasksIDRunsWithIRestResponse(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

Returns
Type Description
RestResponse

ApiResponse of Runs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsWithIRestResponseAsync(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>, CancellationToken)

List runs for a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDRunsWithIRestResponseAsync(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of Runs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDRunsWithRestRequest(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>)

List runs for a task

Declaration
public RestRequest GetTasksIDRunsWithRestRequest(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null)
Parameters
Type Name Description
System.String taskID

The ID of the task to get runs for.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String after

Returns runs after a specific ID. (optional)

System.Nullable<System.Int32> limit

The number of runs to return (optional, default to 100)

System.Nullable<DateTime> afterTime

Filter runs to those scheduled after this time, RFC3339 (optional)

System.Nullable<DateTime> beforeTime

Filter runs to those scheduled before this time, RFC3339 (optional)

Returns
Type Description
RestRequest

ApiResponse of Runs

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDWithHttpInfo(String, String)

Retrieve a task

Declaration
public ApiResponse<TaskType> GetTasksIDWithHttpInfo(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<TaskType>

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDWithIRestResponse(String, String)

Retrieve a task

Declaration
public RestResponse GetTasksIDWithIRestResponse(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksIDWithIRestResponseAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksIDWithRestRequest(String, String)

Retrieve a task

Declaration
public RestRequest GetTasksIDWithRestRequest(string taskID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksWithHttpInfo(String, String, String, String, String, String, String, Nullable<Int32>, String)

List all tasks

Declaration
public ApiResponse<Tasks> GetTasksWithHttpInfo(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<Tasks>

ApiResponse of Tasks

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksWithIRestResponse(String, String, String, String, String, String, String, Nullable<Int32>, String)

List all tasks

Declaration
public RestResponse GetTasksWithIRestResponse(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

Returns
Type Description
RestResponse

ApiResponse of Tasks

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksWithIRestResponseAsync(String, String, String, String, String, String, String, Nullable<Int32>, String, CancellationToken)

List all tasks

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetTasksWithIRestResponseAsync(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of Tasks

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetTasksWithRestRequest(String, String, String, String, String, String, String, Nullable<Int32>, String)

List all tasks

Declaration
public RestRequest GetTasksWithRestRequest(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

Returns task with a specific name. (optional)

System.String after

Return tasks after a specified ID. (optional)

System.String user

Filter tasks to a specific user ID. (optional)

System.String org

Filter tasks to a specific organization name. (optional)

System.String orgID

Filter tasks to a specific organization ID. (optional)

System.String status

Filter tasks by a status- -&quot;inactive&quot; or &quot;active&quot;. (optional)

System.Nullable<System.Int32> limit

The number of tasks to return (optional, default to 100)

System.String type

Type of task, unset by default. (optional)

Returns
Type Description
RestRequest

ApiResponse of Tasks

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksID(String, TaskUpdateRequest, String)

Update a task Update a task. This will cancel all queued runs.

Declaration
public TaskType PatchTasksID(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
TaskType

TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksIDAsync(String, TaskUpdateRequest, String, CancellationToken)

Update a task Update a task. This will cancel all queued runs.

Declaration
public async System.Threading.Tasks.Task<TaskType> PatchTasksIDAsync(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<TaskType>

Task of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksIDAsyncWithHttpInfo(String, TaskUpdateRequest, String, CancellationToken)

Update a task Update a task. This will cancel all queued runs.

Declaration
public async System.Threading.Tasks.Task<ApiResponse<TaskType>> PatchTasksIDAsyncWithHttpInfo(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TaskType>>

Task of ApiResponse (TaskType)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksIDAsyncWithIRestResponse(String, TaskUpdateRequest, String, CancellationToken)

Update a task Update a task. This will cancel all queued runs.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchTasksIDAsyncWithIRestResponse(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (TaskType)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksIDWithHttpInfo(String, TaskUpdateRequest, String)

Update a task Update a task. This will cancel all queued runs.

Declaration
public ApiResponse<TaskType> PatchTasksIDWithHttpInfo(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<TaskType>

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksIDWithIRestResponse(String, TaskUpdateRequest, String)

Update a task Update a task. This will cancel all queued runs.

Declaration
public RestResponse PatchTasksIDWithIRestResponse(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksIDWithIRestResponseAsync(String, TaskUpdateRequest, String, CancellationToken)

Update a task Update a task. This will cancel all queued runs.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchTasksIDWithIRestResponseAsync(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchTasksIDWithRestRequest(String, TaskUpdateRequest, String)

Update a task Update a task. This will cancel all queued runs.

Declaration
public RestRequest PatchTasksIDWithRestRequest(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

TaskUpdateRequest taskUpdateRequest

Task update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasks(TaskCreateRequest, String)

Create a new task

Declaration
public TaskType PostTasks(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
TaskType

TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksAsync(TaskCreateRequest, String, CancellationToken)

Create a new task

Declaration
public async System.Threading.Tasks.Task<TaskType> PostTasksAsync(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<TaskType>

Task of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksAsyncWithHttpInfo(TaskCreateRequest, String, CancellationToken)

Create a new task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<TaskType>> PostTasksAsyncWithHttpInfo(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TaskType>>

Task of ApiResponse (TaskType)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksAsyncWithIRestResponse(TaskCreateRequest, String, CancellationToken)

Create a new task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksAsyncWithIRestResponse(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (TaskType)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabels(String, LabelMapping, String)

Add a label to a task

Declaration
public LabelResponse PostTasksIDLabels(string taskID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
LabelResponse

LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a task

Declaration
public async System.Threading.Tasks.Task<LabelResponse> PostTasksIDLabelsAsync(string taskID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<LabelResponse>

Task of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostTasksIDLabelsAsyncWithHttpInfo(string taskID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>>

Task of ApiResponse (LabelResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)

Add a label to a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDLabelsAsyncWithIRestResponse(string taskID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (LabelResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a task

Declaration
public ApiResponse<LabelResponse> PostTasksIDLabelsWithHttpInfo(string taskID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>

ApiResponse of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabelsWithIRestResponse(String, LabelMapping, String)

Add a label to a task

Declaration
public RestResponse PostTasksIDLabelsWithIRestResponse(string taskID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)

Add a label to a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDLabelsWithIRestResponseAsync(string taskID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDLabelsWithRestRequest(String, LabelMapping, String)

Add a label to a task

Declaration
public RestRequest PostTasksIDLabelsWithRestRequest(string taskID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembers(String, AddResourceMemberRequestBody, String)

Add a member to a task

Declaration
public ResourceMember PostTasksIDMembers(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceMember

ResourceMember

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a task

Declaration
public async System.Threading.Tasks.Task<ResourceMember> PostTasksIDMembersAsync(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<ResourceMember>

Task of ResourceMember

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostTasksIDMembersAsyncWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMember>>

Task of ApiResponse (ResourceMember)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDMembersAsyncWithIRestResponse(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (ResourceMember)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add a member to a task

Declaration
public ApiResponse<ResourceMember> PostTasksIDMembersWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceMember>

ApiResponse of ResourceMember

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembersWithIRestResponse(String, AddResourceMemberRequestBody, String)

Add a member to a task

Declaration
public RestResponse PostTasksIDMembersWithIRestResponse(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of ResourceMember

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDMembersWithIRestResponseAsync(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of ResourceMember

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDMembersWithRestRequest(String, AddResourceMemberRequestBody, String)

Add a member to a task

Declaration
public RestRequest PostTasksIDMembersWithRestRequest(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of ResourceMember

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwners(String, AddResourceMemberRequestBody, String)

Add an owner to a task

Declaration
public ResourceOwner PostTasksIDOwners(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceOwner

ResourceOwner

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a task

Declaration
public async System.Threading.Tasks.Task<ResourceOwner> PostTasksIDOwnersAsync(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<ResourceOwner>

Task of ResourceOwner

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a task

Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostTasksIDOwnersAsyncWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner>>

Task of ApiResponse (ResourceOwner)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwnersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDOwnersAsyncWithIRestResponse(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (ResourceOwner)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add an owner to a task

Declaration
public ApiResponse<ResourceOwner> PostTasksIDOwnersWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner>

ApiResponse of ResourceOwner

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwnersWithIRestResponse(String, AddResourceMemberRequestBody, String)

Add an owner to a task

Declaration
public RestResponse PostTasksIDOwnersWithIRestResponse(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of ResourceOwner

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwnersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDOwnersWithIRestResponseAsync(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of ResourceOwner

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDOwnersWithRestRequest(String, AddResourceMemberRequestBody, String)

Add an owner to a task

Declaration
public RestRequest PostTasksIDOwnersWithRestRequest(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String taskID

The task ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of ResourceOwner

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRuns(String, String, RunManually)

Manually start a task run, overriding the current schedule

Declaration
public Run PostTasksIDRuns(string taskID, string zapTraceSpan = null, RunManually runManually = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

Returns
Type Description
Run

Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsAsync(String, String, RunManually, CancellationToken)

Manually start a task run, overriding the current schedule

Declaration
public async System.Threading.Tasks.Task<Run> PostTasksIDRunsAsync(string taskID, string zapTraceSpan = null, RunManually runManually = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<Run>

Task of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsAsyncWithHttpInfo(String, String, RunManually, CancellationToken)

Manually start a task run, overriding the current schedule

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Run>> PostTasksIDRunsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, RunManually runManually = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Run>>

Task of ApiResponse (Run)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsAsyncWithIRestResponse(String, String, RunManually, CancellationToken)

Manually start a task run, overriding the current schedule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDRunsAsyncWithIRestResponse(string taskID, string zapTraceSpan = null, RunManually runManually = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (Run)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetry(String, String, String, String)

Retry a task run

Declaration
public Run PostTasksIDRunsIDRetry(string taskID, string runID, string zapTraceSpan = null, string body = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

Returns
Type Description
Run

Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetryAsync(String, String, String, String, CancellationToken)

Retry a task run

Declaration
public async System.Threading.Tasks.Task<Run> PostTasksIDRunsIDRetryAsync(string taskID, string runID, string zapTraceSpan = null, string body = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<Run>

Task of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetryAsyncWithHttpInfo(String, String, String, String, CancellationToken)

Retry a task run

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Run>> PostTasksIDRunsIDRetryAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, string body = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Run>>

Task of ApiResponse (Run)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetryAsyncWithIRestResponse(String, String, String, String, CancellationToken)

Retry a task run

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDRunsIDRetryAsyncWithIRestResponse(string taskID, string runID, string zapTraceSpan = null, string body = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (Run)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetryWithHttpInfo(String, String, String, String)

Retry a task run

Declaration
public ApiResponse<Run> PostTasksIDRunsIDRetryWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, string body = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<Run>

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetryWithIRestResponse(String, String, String, String)

Retry a task run

Declaration
public RestResponse PostTasksIDRunsIDRetryWithIRestResponse(string taskID, string runID, string zapTraceSpan = null, string body = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

Returns
Type Description
RestResponse

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetryWithIRestResponseAsync(String, String, String, String, CancellationToken)

Retry a task run

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDRunsIDRetryWithIRestResponseAsync(string taskID, string runID, string zapTraceSpan = null, string body = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsIDRetryWithRestRequest(String, String, String, String)

Retry a task run

Declaration
public RestRequest PostTasksIDRunsIDRetryWithRestRequest(string taskID, string runID, string zapTraceSpan = null, string body = null)
Parameters
Type Name Description
System.String taskID

The task ID.

System.String runID

The run ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String body

(optional)

Returns
Type Description
RestRequest

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsWithHttpInfo(String, String, RunManually)

Manually start a task run, overriding the current schedule

Declaration
public ApiResponse<Run> PostTasksIDRunsWithHttpInfo(string taskID, string zapTraceSpan = null, RunManually runManually = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<Run>

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsWithIRestResponse(String, String, RunManually)

Manually start a task run, overriding the current schedule

Declaration
public RestResponse PostTasksIDRunsWithIRestResponse(string taskID, string zapTraceSpan = null, RunManually runManually = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

Returns
Type Description
RestResponse

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsWithIRestResponseAsync(String, String, RunManually, CancellationToken)

Manually start a task run, overriding the current schedule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksIDRunsWithIRestResponseAsync(string taskID, string zapTraceSpan = null, RunManually runManually = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksIDRunsWithRestRequest(String, String, RunManually)

Manually start a task run, overriding the current schedule

Declaration
public RestRequest PostTasksIDRunsWithRestRequest(string taskID, string zapTraceSpan = null, RunManually runManually = null)
Parameters
Type Name Description
System.String taskID
System.String zapTraceSpan

OpenTracing span context (optional)

RunManually runManually

(optional)

Returns
Type Description
RestRequest

ApiResponse of Run

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksWithHttpInfo(TaskCreateRequest, String)

Create a new task

Declaration
public ApiResponse<TaskType> PostTasksWithHttpInfo(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<TaskType>

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksWithIRestResponse(TaskCreateRequest, String)

Create a new task

Declaration
public RestResponse PostTasksWithIRestResponse(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksWithIRestResponseAsync(TaskCreateRequest, String, CancellationToken)

Create a new task

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostTasksWithIRestResponseAsync(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of TaskType

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostTasksWithRestRequest(TaskCreateRequest, String)

Create a new task

Declaration
public RestRequest PostTasksWithRestRequest(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
TaskCreateRequest taskCreateRequest

Task to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of TaskType

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

ITasksService
In This Article
Back to top Generated by DocFX