• 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
    • InfluxDBTraceFilter
    • 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 CellsService

Represents a collection of functions to interact with the API endpoints

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

Constructors

CellsService(Configuration)

Initializes a new instance of the CellsService class using Configuration object

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

An instance of Configuration

CellsService(String)

Initializes a new instance of the CellsService class.

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

DeleteDashboardsIDCellsID(String, String, String)

Delete a dashboard cell

Declaration
public void DeleteDashboardsIDCellsID(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to delete.

System.String cellID

The ID of the cell to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteDashboardsIDCellsIDAsync(String, String, String, CancellationToken)

Delete a dashboard cell

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

The ID of the dashboard to delete.

System.String cellID

The ID of the cell 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

DeleteDashboardsIDCellsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a dashboard cell

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

The ID of the dashboard to delete.

System.String cellID

The ID of the cell 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

DeleteDashboardsIDCellsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete a dashboard cell

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

The ID of the dashboard to delete.

System.String cellID

The ID of the cell 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

DeleteDashboardsIDCellsIDWithHttpInfo(String, String, String)

Delete a dashboard cell

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

The ID of the dashboard to delete.

System.String cellID

The ID of the cell 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

DeleteDashboardsIDCellsIDWithIRestResponse(String, String, String)

Delete a dashboard cell

Declaration
public RestResponse DeleteDashboardsIDCellsIDWithIRestResponse(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to delete.

System.String cellID

The ID of the cell 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

DeleteDashboardsIDCellsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete a dashboard cell

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

The ID of the dashboard to delete.

System.String cellID

The ID of the cell 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

DeleteDashboardsIDCellsIDWithRestRequest(String, String, String)

Delete a dashboard cell

Declaration
public RestRequest DeleteDashboardsIDCellsIDWithRestRequest(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to delete.

System.String cellID

The ID of the cell 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

GetDashboardsIDCellsIDView(String, String, String)

Retrieve the view for a cell

Declaration
public View GetDashboardsIDCellsIDView(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
View

View

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewAsync(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration
public async System.Threading.Tasks.Task<View> GetDashboardsIDCellsIDViewAsync(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of View

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewAsyncWithHttpInfo(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration
public async System.Threading.Tasks.Task<ApiResponse<View>> GetDashboardsIDCellsIDViewAsyncWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (View)

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewAsyncWithIRestResponse(String, String, String, CancellationToken)

Retrieve the view for a cell

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

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (View)

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithHttpInfo(String, String, String)

Retrieve the view for a cell

Declaration
public ApiResponse<View> GetDashboardsIDCellsIDViewWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of View

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithIRestResponse(String, String, String)

Retrieve the view for a cell

Declaration
public RestResponse GetDashboardsIDCellsIDViewWithIRestResponse(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of View

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithIRestResponseAsync(String, String, String, CancellationToken)

Retrieve the view for a cell

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

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of View

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithRestRequest(String, String, String)

Retrieve the view for a cell

Declaration
public RestRequest GetDashboardsIDCellsIDViewWithRestRequest(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsID(String, String, CellUpdate, String)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public Cell PatchDashboardsIDCellsID(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Cell

Cell

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDAsync(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public async System.Threading.Tasks.Task<Cell> PatchDashboardsIDCellsIDAsync(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Cell

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDAsyncWithHttpInfo(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Cell>> PatchDashboardsIDCellsIDAsyncWithHttpInfo(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Cell)

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDAsyncWithIRestResponse(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDAsyncWithIRestResponse(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Cell)

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDView(String, String, View, String)

Update the view for a cell

Declaration
public View PatchDashboardsIDCellsIDView(string dashboardID, string cellID, View view, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
View

View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewAsync(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration
public async System.Threading.Tasks.Task<View> PatchDashboardsIDCellsIDViewAsync(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewAsyncWithHttpInfo(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration
public async System.Threading.Tasks.Task<ApiResponse<View>> PatchDashboardsIDCellsIDViewAsyncWithHttpInfo(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (View)

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewAsyncWithIRestResponse(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDViewAsyncWithIRestResponse(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (View)

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithHttpInfo(String, String, View, String)

Update the view for a cell

Declaration
public ApiResponse<View> PatchDashboardsIDCellsIDViewWithHttpInfo(string dashboardID, string cellID, View view, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithIRestResponse(String, String, View, String)

Update the view for a cell

Declaration
public RestResponse PatchDashboardsIDCellsIDViewWithIRestResponse(string dashboardID, string cellID, View view, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithIRestResponseAsync(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDViewWithIRestResponseAsync(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithRestRequest(String, String, View, String)

Update the view for a cell

Declaration
public RestRequest PatchDashboardsIDCellsIDViewWithRestRequest(string dashboardID, string cellID, View view, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDWithHttpInfo(String, String, CellUpdate, String)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public ApiResponse<Cell> PatchDashboardsIDCellsIDWithHttpInfo(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Cell

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDWithIRestResponse(String, String, CellUpdate, String)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public RestResponse PatchDashboardsIDCellsIDWithIRestResponse(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Cell

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDWithIRestResponseAsync(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDWithIRestResponseAsync(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Cell

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDWithRestRequest(String, String, CellUpdate, String)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration
public RestRequest PatchDashboardsIDCellsIDWithRestRequest(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Cell

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

Thrown when fails to make API call

PostDashboardsIDCells(String, CreateCell, String)

Create a dashboard cell

Declaration
public Cell PostDashboardsIDCells(string dashboardID, CreateCell createCell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Cell

Cell

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

Thrown when fails to make API call

PostDashboardsIDCellsAsync(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration
public async System.Threading.Tasks.Task<Cell> PostDashboardsIDCellsAsync(string dashboardID, CreateCell createCell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Cell

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

Thrown when fails to make API call

PostDashboardsIDCellsAsyncWithHttpInfo(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Cell>> PostDashboardsIDCellsAsyncWithHttpInfo(string dashboardID, CreateCell createCell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Cell)

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

Thrown when fails to make API call

PostDashboardsIDCellsAsyncWithIRestResponse(String, CreateCell, String, CancellationToken)

Create a dashboard cell

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

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Cell)

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

Thrown when fails to make API call

PostDashboardsIDCellsWithHttpInfo(String, CreateCell, String)

Create a dashboard cell

Declaration
public ApiResponse<Cell> PostDashboardsIDCellsWithHttpInfo(string dashboardID, CreateCell createCell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Cell

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

Thrown when fails to make API call

PostDashboardsIDCellsWithIRestResponse(String, CreateCell, String)

Create a dashboard cell

Declaration
public RestResponse PostDashboardsIDCellsWithIRestResponse(string dashboardID, CreateCell createCell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Cell

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

Thrown when fails to make API call

PostDashboardsIDCellsWithIRestResponseAsync(String, CreateCell, String, CancellationToken)

Create a dashboard cell

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

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Cell

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

Thrown when fails to make API call

PostDashboardsIDCellsWithRestRequest(String, CreateCell, String)

Create a dashboard cell

Declaration
public RestRequest PostDashboardsIDCellsWithRestRequest(string dashboardID, CreateCell createCell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Cell

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

Thrown when fails to make API call

PutDashboardsIDCells(String, List<Cell>, String)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public Dashboard PutDashboardsIDCells(string dashboardID, List<Cell> cell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Dashboard

Dashboard

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

Thrown when fails to make API call

PutDashboardsIDCellsAsync(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public async System.Threading.Tasks.Task<Dashboard> PutDashboardsIDCellsAsync(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Dashboard

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

Thrown when fails to make API call

PutDashboardsIDCellsAsyncWithHttpInfo(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Dashboard>> PutDashboardsIDCellsAsyncWithHttpInfo(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Dashboard)

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

Thrown when fails to make API call

PutDashboardsIDCellsAsyncWithIRestResponse(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PutDashboardsIDCellsAsyncWithIRestResponse(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Dashboard)

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

Thrown when fails to make API call

PutDashboardsIDCellsWithHttpInfo(String, List<Cell>, String)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public ApiResponse<Dashboard> PutDashboardsIDCellsWithHttpInfo(string dashboardID, List<Cell> cell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Dashboard

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

Thrown when fails to make API call

PutDashboardsIDCellsWithIRestResponse(String, List<Cell>, String)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public RestResponse PutDashboardsIDCellsWithIRestResponse(string dashboardID, List<Cell> cell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Dashboard

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

Thrown when fails to make API call

PutDashboardsIDCellsWithIRestResponseAsync(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PutDashboardsIDCellsWithIRestResponseAsync(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Dashboard

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

Thrown when fails to make API call

PutDashboardsIDCellsWithRestRequest(String, List<Cell>, String)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration
public RestRequest PutDashboardsIDCellsWithRestRequest(string dashboardID, List<Cell> cell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Dashboard

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

ICellsService
In This Article
Back to top Generated by DocFX