From 6ebbc7bc738894212dd61b8ca7ba861d3c57b1e2 Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Mon, 3 Feb 2025 16:24:51 +0700 Subject: [PATCH] docs: updates documentation [skip CI] --- ...nfluxdb-client-apis.AuthorizationsAPI.html | 14 +++--- ...uxdata_influxdb-client-apis.BackupAPI.html | 10 ++-- ...xdata_influxdb-client-apis.BucketsAPI.html | 32 ++++++------- ...uxdata_influxdb-client-apis.ChecksAPI.html | 24 +++++----- ...uxdata_influxdb-client-apis.ConfigAPI.html | 6 +-- ...ta_influxdb-client-apis.DashboardsAPI.html | 44 +++++++++--------- ...luxdata_influxdb-client-apis.DbrpsAPI.html | 14 +++--- ...luxdata_influxdb-client-apis.DebugAPI.html | 24 +++++----- ...uxdata_influxdb-client-apis.DeleteAPI.html | 6 +-- ...luxdata_influxdb-client-apis.FlagsAPI.html | 6 +-- ...b-client-apis.FluxScriptInvocationAPI.html | 6 +-- ...uxdata_influxdb-client-apis.HealthAPI.html | 6 +-- ...uxdata_influxdb-client-apis.LabelsAPI.html | 14 +++--- ...influxdata_influxdb-client-apis.MeAPI.html | 8 ++-- ...xdata_influxdb-client-apis.MetricsAPI.html | 6 +-- ...-client-apis.NotificationEndpointsAPI.html | 22 ++++----- ...uxdb-client-apis.NotificationRulesAPI.html | 24 +++++----- ...fluxdata_influxdb-client-apis.OrgsAPI.html | 34 +++++++------- ...fluxdata_influxdb-client-apis.PingAPI.html | 6 +-- ...luxdata_influxdb-client-apis.QueryAPI.html | 14 +++--- ...luxdata_influxdb-client-apis.ReadyAPI.html | 6 +-- ...xdata_influxdb-client-apis.RemotesAPI.html | 14 +++--- ..._influxdb-client-apis.ReplicationsAPI.html | 16 +++---- ...ata_influxdb-client-apis.ResourcesAPI.html | 6 +-- ...xdata_influxdb-client-apis.RestoreAPI.html | 14 +++--- ...fluxdata_influxdb-client-apis.RootAPI.html | 6 +-- ...data_influxdb-client-apis.ScrapersAPI.html | 32 ++++++------- ...xdata_influxdb-client-apis.ScriptsAPI.html | 20 ++++---- ...luxdata_influxdb-client-apis.SetupAPI.html | 8 ++-- ...uxdata_influxdb-client-apis.SigninAPI.html | 6 +-- ...xdata_influxdb-client-apis.SignoutAPI.html | 6 +-- ...xdata_influxdb-client-apis.SourcesAPI.html | 18 ++++---- ...uxdata_influxdb-client-apis.StacksAPI.html | 16 +++---- ...luxdata_influxdb-client-apis.TasksAPI.html | 46 +++++++++---------- ...data_influxdb-client-apis.TelegrafAPI.html | 6 +-- ...ata_influxdb-client-apis.TelegrafsAPI.html | 32 ++++++------- ...ata_influxdb-client-apis.TemplatesAPI.html | 8 ++-- ...luxdata_influxdb-client-apis.UsersAPI.html | 16 +++---- ...ata_influxdb-client-apis.VariablesAPI.html | 22 ++++----- ...luxdata_influxdb-client-apis.WriteAPI.html | 6 +-- ...influxdata_influxdb-client.AbortError.html | 8 ++-- ..._influxdata_influxdb-client.HttpError.html | 12 ++--- ..._influxdb-client.IllegalArgumentError.html | 4 +- .../_influxdata_influxdb-client.InfluxDB.html | 8 ++-- ...fluxdata_influxdb-client.LineSplitter.html | 12 ++--- .../_influxdata_influxdb-client.Point.html | 24 +++++----- ..._influxdb-client.RequestTimedOutError.html | 8 ++-- ...b-client-giraffe.acceptMaxTableLength.html | 2 +- ...fluxdb-client-giraffe.createCollector.html | 2 +- ...db-client-giraffe.csvToFromFluxResult.html | 2 +- ...ta_influxdb-client-giraffe.csvToTable.html | 2 +- ...-client-giraffe.queryToFromFluxResult.html | 2 +- ..._influxdb-client-giraffe.queryToTable.html | 2 +- ...data_influxdb-client.canRetryHttpCall.html | 2 +- ...luxdata_influxdb-client.chunksToLines.html | 2 +- ...influxdb-client.chunksToLinesIterable.html | 2 +- ...ta_influxdb-client.convertTimeToNanos.html | 2 +- ...influxdb-client.createFluxTableColumn.html | 2 +- ...fluxdb-client.createFluxTableMetaData.html | 2 +- ...uxdb-client.createTextDecoderCombiner.html | 2 +- .../_influxdata_influxdb-client.flux.html | 2 +- .../_influxdata_influxdb-client.fluxBool.html | 2 +- ...fluxdata_influxdb-client.fluxDateTime.html | 2 +- ...fluxdata_influxdb-client.fluxDuration.html | 2 +- ...uxdata_influxdb-client.fluxExpression.html | 2 +- ..._influxdata_influxdb-client.fluxFloat.html | 2 +- ...nfluxdata_influxdb-client.fluxInteger.html | 2 +- ...influxdata_influxdb-client.fluxRegExp.html | 2 +- ...influxdata_influxdb-client.fluxString.html | 2 +- ...luxdata_influxdb-client.getRetryDelay.html | 2 +- ...influxdb-client.isStatusCodeRetriable.html | 2 +- ...a_influxdb-client.linesToRowsIterable.html | 2 +- ...luxdata_influxdb-client.linesToTables.html | 2 +- ...ta_influxdb-client.newFluxTableColumn.html | 2 +- ...luxdata_influxdb-client.sanitizeFloat.html | 2 +- ...xdata_influxdb-client.sanitizeInteger.html | 2 +- ...fluxdb-client.serializeDateTimeAsDate.html | 2 +- ...uxdb-client.serializeDateTimeAsNumber.html | 2 +- ...uxdb-client.serializeDateTimeAsString.html | 2 +- ..._influxdata_influxdb-client.setLogger.html | 2 +- ...luxdata_influxdb-client.stringToLines.html | 2 +- ...nfluxdata_influxdb-client.toFluxValue.html | 2 +- ...data_influxdb-client.useProcessHrtime.html | 2 +- ...data_influxdb-client-apis.ASTResponse.html | 4 +- ...ent-apis.AddResourceMemberRequestBody.html | 6 +-- ...uxdb-client-apis.AnalyzeQueryResponse.html | 4 +- ...uxdb-client-apis.ApplyTemplateRequest.html | 4 +- ..._influxdb-client-apis.ArrayExpression.html | 4 +- ...lient-apis.AuthorizationUpdateRequest.html | 6 +-- ...a_influxdb-client-apis.Authorizations.html | 4 +- ..._influxdata_influxdb-client-apis.Axes.html | 4 +- ..._influxdata_influxdb-client-apis.Axis.html | 12 ++--- ...ata_influxdb-client-apis.BadStatement.html | 4 +- ...fluxdb-client-apis.BandViewProperties.html | 8 ++-- ...influxdb-client-apis.BinaryExpression.html | 4 +- ...influxdata_influxdb-client-apis.Block.html | 4 +- ...a_influxdb-client-apis.BooleanLiteral.html | 4 +- ...nfluxdata_influxdb-client-apis.Bucket.html | 6 +-- ...db-client-apis.BucketMetadataManifest.html | 4 +- ...fluxdb-client-apis.BucketShardMapping.html | 4 +- ...fluxdata_influxdb-client-apis.Buckets.html | 4 +- ...ta_influxdb-client-apis.BuilderConfig.html | 4 +- ...uxdb-client-apis.BuilderFunctionsType.html | 4 +- ..._influxdb-client-apis.BuilderTagsType.html | 4 +- ...influxdb-client-apis.BuiltinStatement.html | 4 +- ...a_influxdb-client-apis.CallExpression.html | 4 +- ..._influxdata_influxdb-client-apis.Cell.html | 6 +-- ...xdata_influxdb-client-apis.CellUpdate.html | 4 +- ...uxdata_influxdb-client-apis.CheckBase.html | 16 +++---- ...xdata_influxdb-client-apis.CheckPatch.html | 4 +- ...luxdb-client-apis.CheckViewProperties.html | 6 +-- ...nfluxdata_influxdb-client-apis.Checks.html | 4 +- ...xdb-client-apis.ConditionalExpression.html | 4 +- ...nfluxdata_influxdb-client-apis.Config.html | 4 +- ...lient-apis.ConstantVariableProperties.html | 4 +- ...xdata_influxdb-client-apis.CreateCell.html | 6 +-- ...fluxdb-client-apis.CreateCheckRequest.html | 4 +- ...db-client-apis.CreateDashboardRequest.html | 8 ++-- ...pis.CreateNotificationEndpointRequest.html | 4 +- ...nt-apis.CreateNotificationRuleRequest.html | 4 +- ...fluxdb-client-apis.CreateStackRequest.html | 4 +- ..._influxdata_influxdb-client-apis.DBRP.html | 16 +++---- ...xdata_influxdb-client-apis.DBRPCreate.html | 14 +++--- ...fluxdata_influxdb-client-apis.DBRPGet.html | 4 +- ...xdata_influxdb-client-apis.DBRPUpdate.html | 6 +-- ...influxdata_influxdb-client-apis.DBRPs.html | 4 +- ...a_influxdb-client-apis.DashboardColor.html | 12 ++--- ...a_influxdb-client-apis.DashboardQuery.html | 6 +-- ...xdata_influxdb-client-apis.Dashboards.html | 4 +- ..._influxdb-client-apis.DateTimeLiteral.html | 4 +- ...ta_influxdb-client-apis.DecimalPlaces.html | 6 +-- ...nt-apis.DeleteAuthorizationsIDRequest.html | 4 +- ...t-apis.DeleteBucketsIDLabelsIDRequest.html | 6 +-- ...-apis.DeleteBucketsIDMembersIDRequest.html | 6 +-- ...t-apis.DeleteBucketsIDOwnersIDRequest.html | 6 +-- ...db-client-apis.DeleteBucketsIDRequest.html | 4 +- ...nt-apis.DeleteChecksIDLabelsIDRequest.html | 6 +-- ...xdb-client-apis.DeleteChecksIDRequest.html | 4 +- ...luxdb-client-apis.DeleteDBRPIDRequest.html | 8 ++-- ...apis.DeleteDashboardsIDCellsIDRequest.html | 6 +-- ...pis.DeleteDashboardsIDLabelsIDRequest.html | 6 +-- ...is.DeleteDashboardsIDMembersIDRequest.html | 6 +-- ...pis.DeleteDashboardsIDOwnersIDRequest.html | 6 +-- ...client-apis.DeleteDashboardsIDRequest.html | 4 +- ...xdb-client-apis.DeleteLabelsIDRequest.html | 4 +- ...otificationEndpointsIDLabelsIDRequest.html | 6 +-- ....DeleteNotificationEndpointsIDRequest.html | 4 +- ...eteNotificationRulesIDLabelsIDRequest.html | 6 +-- ...apis.DeleteNotificationRulesIDRequest.html | 4 +- ...ent-apis.DeleteOrgsIDMembersIDRequest.html | 6 +-- ...ient-apis.DeleteOrgsIDOwnersIDRequest.html | 6 +-- ...luxdb-client-apis.DeleteOrgsIDRequest.html | 4 +- ...ent-apis.DeleteOrgsIDSecretsIDRequest.html | 6 +-- ...db-client-apis.DeletePredicateRequest.html | 8 ++-- ...pis.DeleteRemoteConnectionByIDRequest.html | 4 +- ...ent-apis.DeleteReplicationByIDRequest.html | 4 +- ...-apis.DeleteScrapersIDLabelsIDRequest.html | 6 +-- ...apis.DeleteScrapersIDMembersIDRequest.html | 6 +-- ...-apis.DeleteScrapersIDOwnersIDRequest.html | 6 +-- ...b-client-apis.DeleteScrapersIDRequest.html | 4 +- ...db-client-apis.DeleteScriptsIDRequest.html | 4 +- ...db-client-apis.DeleteSourcesIDRequest.html | 4 +- ...fluxdb-client-apis.DeleteStackRequest.html | 6 +-- ...ent-apis.DeleteTasksIDLabelsIDRequest.html | 6 +-- ...nt-apis.DeleteTasksIDMembersIDRequest.html | 6 +-- ...ent-apis.DeleteTasksIDOwnersIDRequest.html | 6 +-- ...uxdb-client-apis.DeleteTasksIDRequest.html | 4 +- ...lient-apis.DeleteTasksIDRunsIDRequest.html | 6 +-- ...apis.DeleteTelegrafsIDLabelsIDRequest.html | 6 +-- ...pis.DeleteTelegrafsIDMembersIDRequest.html | 6 +-- ...apis.DeleteTelegrafsIDOwnersIDRequest.html | 6 +-- ...-client-apis.DeleteTelegrafsIDRequest.html | 4 +- ...uxdb-client-apis.DeleteUsersIDRequest.html | 4 +- ...apis.DeleteVariablesIDLabelsIDRequest.html | 6 +-- ...-client-apis.DeleteVariablesIDRequest.html | 4 +- ...fluxdata_influxdb-client-apis.Dialect.html | 12 ++--- ...a_influxdb-client-apis.DictExpression.html | 4 +- ...luxdata_influxdb-client-apis.DictItem.html | 4 +- ...luxdata_influxdb-client-apis.Duration.html | 4 +- ..._influxdb-client-apis.DurationLiteral.html | 6 +-- ...influxdata_influxdb-client-apis.Error.html | 10 ++-- ...influxdb-client-apis.ExecutionOptions.html | 6 +-- ...xdb-client-apis.ExportTemplateRequest.html | 4 +- ...luxdb-client-apis.ExpressionStatement.html | 4 +- ..._influxdata_influxdb-client-apis.File.html | 8 ++-- ...ata_influxdb-client-apis.FloatLiteral.html | 4 +- ...ata_influxdb-client-apis.FluxResponse.html | 4 +- ...a_influxdb-client-apis.FluxSuggestion.html | 4 +- ..._influxdb-client-apis.FluxSuggestions.html | 4 +- ...fluxdb-client-apis.FunctionExpression.html | 6 +-- ...luxdb-client-apis.GaugeViewProperties.html | 6 +-- ...db-client-apis.GeoViewLayerProperties.html | 4 +- ...nfluxdb-client-apis.GeoViewProperties.html | 22 ++++----- ...lient-apis.GetAuthorizationsIDRequest.html | 4 +- ...-client-apis.GetAuthorizationsRequest.html | 10 ++-- ...fluxdb-client-apis.GetBackupKVRequest.html | 2 +- ...-client-apis.GetBackupMetadataRequest.html | 2 +- ...b-client-apis.GetBackupShardIdRequest.html | 6 +-- ...client-apis.GetBucketsIDLabelsRequest.html | 4 +- ...lient-apis.GetBucketsIDMembersRequest.html | 4 +- ...client-apis.GetBucketsIDOwnersRequest.html | 4 +- ...luxdb-client-apis.GetBucketsIDRequest.html | 4 +- ...nfluxdb-client-apis.GetBucketsRequest.html | 16 +++---- ...-client-apis.GetChecksIDLabelsRequest.html | 4 +- ...b-client-apis.GetChecksIDQueryRequest.html | 4 +- ...fluxdb-client-apis.GetChecksIDRequest.html | 4 +- ...influxdb-client-apis.GetChecksRequest.html | 8 ++-- ...influxdb-client-apis.GetConfigRequest.html | 2 +- ...nfluxdb-client-apis.GetDBRPsIDRequest.html | 8 ++-- ..._influxdb-client-apis.GetDBRPsRequest.html | 16 +++---- ...pis.GetDashboardsIDCellsIDViewRequest.html | 6 +-- ...ent-apis.GetDashboardsIDLabelsRequest.html | 4 +- ...nt-apis.GetDashboardsIDMembersRequest.html | 4 +- ...ent-apis.GetDashboardsIDOwnersRequest.html | 4 +- ...db-client-apis.GetDashboardsIDRequest.html | 6 +-- ...uxdb-client-apis.GetDashboardsRequest.html | 18 ++++---- ...-apis.GetDebugPprofAllProfilesRequest.html | 4 +- ...lient-apis.GetDebugPprofAllocsRequest.html | 6 +-- ...client-apis.GetDebugPprofBlockRequest.html | 6 +-- ...ient-apis.GetDebugPprofCmdlineRequest.html | 2 +- ...nt-apis.GetDebugPprofGoroutineRequest.html | 6 +-- ...-client-apis.GetDebugPprofHeapRequest.html | 8 ++-- ...client-apis.GetDebugPprofMutexRequest.html | 6 +-- ...ient-apis.GetDebugPprofProfileRequest.html | 4 +- ...apis.GetDebugPprofThreadCreateRequest.html | 6 +-- ...client-apis.GetDebugPprofTraceRequest.html | 4 +- ..._influxdb-client-apis.GetFlagsRequest.html | 2 +- ...influxdb-client-apis.GetHealthRequest.html | 2 +- ...fluxdb-client-apis.GetLabelsIDRequest.html | 4 +- ...influxdb-client-apis.GetLabelsRequest.html | 4 +- ...ata_influxdb-client-apis.GetMeRequest.html | 2 +- ...nfluxdb-client-apis.GetMetricsRequest.html | 2 +- ...tNotificationEndpointsIDLabelsRequest.html | 4 +- ...pis.GetNotificationEndpointsIDRequest.html | 4 +- ...-apis.GetNotificationEndpointsRequest.html | 8 ++-- ...s.GetNotificationRulesIDLabelsRequest.html | 4 +- ...is.GetNotificationRulesIDQueryRequest.html | 4 +- ...nt-apis.GetNotificationRulesIDRequest.html | 4 +- ...ient-apis.GetNotificationRulesRequest.html | 12 ++--- ...b-client-apis.GetOrgsIDMembersRequest.html | 4 +- ...db-client-apis.GetOrgsIDOwnersRequest.html | 4 +- ...influxdb-client-apis.GetOrgsIDRequest.html | 4 +- ...b-client-apis.GetOrgsIDSecretsRequest.html | 4 +- ...a_influxdb-client-apis.GetOrgsRequest.html | 14 +++--- ...a_influxdb-client-apis.GetPingRequest.html | 2 +- ...t-apis.GetQuerySuggestionsNameRequest.html | 4 +- ...lient-apis.GetQuerySuggestionsRequest.html | 2 +- ..._influxdb-client-apis.GetReadyRequest.html | 2 +- ...t-apis.GetRemoteConnectionByIDRequest.html | 4 +- ...ient-apis.GetRemoteConnectionsRequest.html | 6 +-- ...client-apis.GetReplicationByIDRequest.html | 4 +- ...db-client-apis.GetReplicationsRequest.html | 6 +-- ...luxdb-client-apis.GetResourcesRequest.html | 2 +- ...influxdb-client-apis.GetRoutesRequest.html | 2 +- ...lient-apis.GetScrapersIDLabelsRequest.html | 4 +- ...ient-apis.GetScrapersIDMembersRequest.html | 4 +- ...lient-apis.GetScrapersIDOwnersRequest.html | 4 +- ...uxdb-client-apis.GetScrapersIDRequest.html | 4 +- ...fluxdb-client-apis.GetScrapersRequest.html | 10 ++-- ...luxdb-client-apis.GetScriptsIDRequest.html | 4 +- ...nfluxdb-client-apis.GetScriptsRequest.html | 12 ++--- ..._influxdb-client-apis.GetSetupRequest.html | 2 +- ...lient-apis.GetSourcesIDBucketsRequest.html | 6 +-- ...client-apis.GetSourcesIDHealthRequest.html | 4 +- ...luxdb-client-apis.GetSourcesIDRequest.html | 4 +- ...nfluxdb-client-apis.GetSourcesRequest.html | 4 +- ...b-client-apis.GetTasksIDLabelsRequest.html | 4 +- ...xdb-client-apis.GetTasksIDLogsRequest.html | 4 +- ...-client-apis.GetTasksIDMembersRequest.html | 4 +- ...b-client-apis.GetTasksIDOwnersRequest.html | 4 +- ...nfluxdb-client-apis.GetTasksIDRequest.html | 4 +- ...ient-apis.GetTasksIDRunsIDLogsRequest.html | 6 +-- ...b-client-apis.GetTasksIDRunsIDRequest.html | 6 +-- ...xdb-client-apis.GetTasksIDRunsRequest.html | 12 ++--- ..._influxdb-client-apis.GetTasksRequest.html | 18 ++++---- ...client-apis.GetTelegrafPluginsRequest.html | 4 +- ...ient-apis.GetTelegrafsIDLabelsRequest.html | 4 +- ...ent-apis.GetTelegrafsIDMembersRequest.html | 4 +- ...ient-apis.GetTelegrafsIDOwnersRequest.html | 4 +- ...xdb-client-apis.GetTelegrafsIDRequest.html | 4 +- ...luxdb-client-apis.GetTelegrafsRequest.html | 4 +- ...nfluxdb-client-apis.GetUsersIDRequest.html | 4 +- ..._influxdb-client-apis.GetUsersRequest.html | 8 ++-- ...ient-apis.GetVariablesIDLabelsRequest.html | 4 +- ...xdb-client-apis.GetVariablesIDRequest.html | 4 +- ...luxdb-client-apis.GetVariablesRequest.html | 6 +-- ...-client-apis.HTTPNotificationRuleBase.html | 4 +- ...data_influxdb-client-apis.HealthCheck.html | 4 +- ...xdb-client-apis.HeatmapViewProperties.html | 8 ++-- ...b-client-apis.HistogramViewProperties.html | 8 ++-- ...xdata_influxdb-client-apis.Identifier.html | 4 +- ...nfluxdb-client-apis.ImportDeclaration.html | 4 +- ..._influxdb-client-apis.IndexExpression.html | 4 +- ...a_influxdb-client-apis.IntegerLiteral.html | 4 +- ...ata_influxdb-client-apis.IsOnboarding.html | 4 +- ...influxdata_influxdb-client-apis.Label.html | 6 +-- ...fluxdb-client-apis.LabelCreateRequest.html | 6 +-- ...ata_influxdb-client-apis.LabelMapping.html | 4 +- ...ta_influxdb-client-apis.LabelResponse.html | 4 +- ...data_influxdb-client-apis.LabelUpdate.html | 4 +- ...a_influxdb-client-apis.LabelsResponse.html | 4 +- ..._influxdb-client-apis.LanguageRequest.html | 4 +- ...ata_influxdb-client-apis.LatLonColumn.html | 6 +-- ...ta_influxdb-client-apis.LatLonColumns.html | 4 +- ...ent-apis.LinePlusSingleStatProperties.html | 8 ++-- ...nfluxdb-client-apis.LineProtocolError.html | 12 ++--- ...b-client-apis.LineProtocolLengthError.html | 6 +-- ...influxdata_influxdb-client-apis.Links.html | 4 +- ...nfluxdb-client-apis.ListStacksRequest.html | 8 ++-- ...luxdata_influxdb-client-apis.LogEvent.html | 8 ++-- ...nfluxdb-client-apis.LogicalExpression.html | 4 +- ..._influxdata_influxdb-client-apis.Logs.html | 4 +- ...xdb-client-apis.MapVariableProperties.html | 4 +- ...db-client-apis.MarkdownViewProperties.html | 4 +- ...influxdb-client-apis.MemberAssignment.html | 4 +- ...influxdb-client-apis.MemberExpression.html | 4 +- ...a_influxdb-client-apis.MetadataBackup.html | 4 +- ...uxdb-client-apis.MosaicViewProperties.html | 6 +-- ...-client-apis.NotificationEndpointBase.html | 10 ++-- ...lient-apis.NotificationEndpointUpdate.html | 4 +- ...xdb-client-apis.NotificationEndpoints.html | 4 +- ...uxdb-client-apis.NotificationRuleBase.html | 30 ++++++------ ...db-client-apis.NotificationRuleUpdate.html | 4 +- ...nfluxdb-client-apis.NotificationRules.html | 4 +- ...influxdb-client-apis.ObjectExpression.html | 4 +- ...nfluxdb-client-apis.OnboardingRequest.html | 8 ++-- ...fluxdb-client-apis.OnboardingResponse.html | 4 +- ..._influxdb-client-apis.OptionStatement.html | 4 +- ...ata_influxdb-client-apis.Organization.html | 6 +-- ...ta_influxdb-client-apis.Organizations.html | 4 +- ...fluxdata_influxdb-client-apis.Package.html | 8 ++-- ...ta_influxdb-client-apis.PackageClause.html | 4 +- ...nt-apis.PagerDutyNotificationRuleBase.html | 4 +- ..._influxdb-client-apis.ParenExpression.html | 4 +- ...nfluxdb-client-apis.PasswordResetBody.html | 4 +- ...ent-apis.PatchAuthorizationsIDRequest.html | 6 +-- ...fluxdb-client-apis.PatchBucketRequest.html | 6 +-- ...xdb-client-apis.PatchBucketsIDRequest.html | 6 +-- ...uxdb-client-apis.PatchChecksIDRequest.html | 6 +-- ...fluxdb-client-apis.PatchDBRPIDRequest.html | 10 ++-- ...-apis.PatchDashboardsIDCellsIDRequest.html | 8 ++-- ...s.PatchDashboardsIDCellsIDViewRequest.html | 8 ++-- ...-client-apis.PatchDashboardsIDRequest.html | 6 +-- ...uxdb-client-apis.PatchLabelsIDRequest.html | 6 +-- ...s.PatchNotificationEndpointsIDRequest.html | 6 +-- ...-apis.PatchNotificationRulesIDRequest.html | 6 +-- ...-client-apis.PatchOrganizationRequest.html | 6 +-- ...fluxdb-client-apis.PatchOrgsIDRequest.html | 6 +-- ...client-apis.PatchOrgsIDSecretsRequest.html | 6 +-- ...apis.PatchRemoteConnectionByIDRequest.html | 4 +- ...ient-apis.PatchReplicationByIDRequest.html | 6 +-- ...fluxdb-client-apis.PatchRetentionRule.html | 6 +-- ...db-client-apis.PatchScrapersIDRequest.html | 6 +-- ...t-apis.PatchScriptsIDAddLabelsRequest.html | 6 +-- ...pis.PatchScriptsIDRemoveLabelsRequest.html | 6 +-- ...xdb-client-apis.PatchScriptsIDRequest.html | 6 +-- ...xdb-client-apis.PatchSourcesIDRequest.html | 6 +-- ...luxdb-client-apis.PatchTasksIDRequest.html | 6 +-- ...luxdb-client-apis.PatchUsersIDRequest.html | 6 +-- ...b-client-apis.PatchVariablesIDRequest.html | 6 +-- ...xdata_influxdb-client-apis.Permission.html | 4 +- ...a_influxdb-client-apis.PipeExpression.html | 4 +- ...data_influxdb-client-apis.PipeLiteral.html | 4 +- ...client-apis.PostAuthorizationsRequest.html | 4 +- ...nfluxdb-client-apis.PostBucketRequest.html | 12 ++--- ...lient-apis.PostBucketsIDLabelsRequest.html | 6 +-- ...ient-apis.PostBucketsIDMembersRequest.html | 6 +-- ...lient-apis.PostBucketsIDOwnersRequest.html | 6 +-- ...fluxdb-client-apis.PostBucketsRequest.html | 4 +- ...client-apis.PostChecksIDLabelsRequest.html | 6 +-- ..._influxdb-client-apis.PostDBRPRequest.html | 4 +- ...ent-apis.PostDashboardsIDCellsRequest.html | 6 +-- ...nt-apis.PostDashboardsIDLabelsRequest.html | 6 +-- ...t-apis.PostDashboardsIDMembersRequest.html | 6 +-- ...nt-apis.PostDashboardsIDOwnersRequest.html | 6 +-- ...xdb-client-apis.PostDashboardsRequest.html | 4 +- ...nfluxdb-client-apis.PostDeleteRequest.html | 12 ++--- ...nfluxdb-client-apis.PostLabelsRequest.html | 4 +- ...stNotificationEndpointIDLabelsRequest.html | 6 +-- ...s.PostNotificationRuleIDLabelsRequest.html | 6 +-- ...b-client-apis.PostOrganizationRequest.html | 6 +-- ...-client-apis.PostOrgsIDMembersRequest.html | 6 +-- ...b-client-apis.PostOrgsIDOwnersRequest.html | 6 +-- ...-client-apis.PostOrgsIDSecretsRequest.html | 6 +-- ..._influxdb-client-apis.PostOrgsRequest.html | 4 +- ...b-client-apis.PostQueryAnalyzeRequest.html | 4 +- ...luxdb-client-apis.PostQueryAstRequest.html | 4 +- ...influxdb-client-apis.PostQueryRequest.html | 8 ++-- ...ient-apis.PostRemoteConnectionRequest.html | 4 +- ...db-client-apis.PostReplicationRequest.html | 6 +-- ...lient-apis.PostRestoreBucketIDRequest.html | 6 +-- ...apis.PostRestoreBucketMetadataRequest.html | 4 +- ...uxdb-client-apis.PostRestoreKVRequest.html | 4 +- ...xdb-client-apis.PostRestoreSQLRequest.html | 4 +- ...client-apis.PostRestoreShardIdRequest.html | 6 +-- ...ient-apis.PostScrapersIDLabelsRequest.html | 6 +-- ...ent-apis.PostScrapersIDMembersRequest.html | 6 +-- ...ient-apis.PostScrapersIDOwnersRequest.html | 6 +-- ...luxdb-client-apis.PostScrapersRequest.html | 4 +- ...lient-apis.PostScriptsIDInvokeRequest.html | 6 +-- ...fluxdb-client-apis.PostScriptsRequest.html | 4 +- ...influxdb-client-apis.PostSetupRequest.html | 4 +- ...nfluxdb-client-apis.PostSigninRequest.html | 4 +- ...fluxdb-client-apis.PostSignoutRequest.html | 2 +- ...fluxdb-client-apis.PostSourcesRequest.html | 4 +- ...-client-apis.PostTasksIDLabelsRequest.html | 6 +-- ...client-apis.PostTasksIDMembersRequest.html | 6 +-- ...-client-apis.PostTasksIDOwnersRequest.html | 6 +-- ...nt-apis.PostTasksIDRunsIDRetryRequest.html | 8 ++-- ...db-client-apis.PostTasksIDRunsRequest.html | 4 +- ...influxdb-client-apis.PostTasksRequest.html | 4 +- ...ent-apis.PostTelegrafsIDLabelsRequest.html | 6 +-- ...nt-apis.PostTelegrafsIDMembersRequest.html | 6 +-- ...ent-apis.PostTelegrafsIDOwnersRequest.html | 6 +-- ...uxdb-client-apis.PostTelegrafsRequest.html | 4 +- ...lient-apis.PostUsersIDPasswordRequest.html | 8 ++-- ...influxdb-client-apis.PostUsersRequest.html | 4 +- ...is.PostValidateReplicationByIDRequest.html | 4 +- ...ent-apis.PostVariablesIDLabelsRequest.html | 6 +-- ...uxdb-client-apis.PostVariablesRequest.html | 4 +- ...influxdb-client-apis.PostWriteRequest.html | 12 ++--- ...luxdata_influxdb-client-apis.Property.html | 4 +- ...fluxdb-client-apis.PutChecksIDRequest.html | 6 +-- ...ient-apis.PutDashboardsIDCellsRequest.html | 6 +-- ...uxdb-client-apis.PutMePasswordRequest.html | 6 +-- ...pis.PutNotificationEndpointsIDRequest.html | 6 +-- ...nt-apis.PutNotificationRulesIDRequest.html | 6 +-- ...xdb-client-apis.PutTelegrafsIDRequest.html | 6 +-- ...xdb-client-apis.PutVariablesIDRequest.html | 6 +-- ...influxdata_influxdb-client-apis.Query.html | 12 ++--- ...b-client-apis.QueryVariableProperties.html | 4 +- ...influxdb-client-apis.ReadStackRequest.html | 4 +- ...influxdata_influxdb-client-apis.Ready.html | 4 +- ...ta_influxdb-client-apis.RegexpLiteral.html | 4 +- ...influxdb-client-apis.RemoteConnection.html | 4 +- ...-apis.RemoteConnectionCreationRequest.html | 4 +- ...nt-apis.RemoteConnectionUpdateRequest.html | 4 +- ...nfluxdb-client-apis.RemoteConnections.html | 4 +- ...a_influxdb-client-apis.RenamableField.html | 8 ++-- ...data_influxdb-client-apis.Replication.html | 4 +- ...lient-apis.ReplicationCreationRequest.html | 4 +- ...-client-apis.ReplicationUpdateRequest.html | 4 +- ...ata_influxdb-client-apis.Replications.html | 4 +- ...a_influxdb-client-apis.RequestOptions.html | 6 +-- ...luxdata_influxdb-client-apis.Resource.html | 12 ++--- ..._influxdb-client-apis.ResourceMembers.html | 4 +- ...a_influxdb-client-apis.ResourceOwners.html | 4 +- ...db-client-apis.RestoredBucketMappings.html | 4 +- ...b-client-apis.RetentionPolicyManifest.html | 4 +- ...ta_influxdb-client-apis.RetentionRule.html | 6 +-- ..._influxdb-client-apis.ReturnStatement.html | 4 +- ...nfluxdata_influxdb-client-apis.Routes.html | 4 +- .../_influxdata_influxdb-client-apis.Run.html | 14 +++--- ...data_influxdb-client-apis.RunManually.html | 4 +- ..._influxdata_influxdb-client-apis.Runs.html | 4 +- ...-client-apis.SMTPNotificationRuleBase.html | 4 +- ...xdb-client-apis.ScatterViewProperties.html | 8 ++-- ...uxdb-client-apis.ScraperTargetRequest.html | 14 +++--- ...db-client-apis.ScraperTargetResponses.html | 4 +- ...nfluxdata_influxdb-client-apis.Script.html | 10 ++-- ...luxdb-client-apis.ScriptCreateRequest.html | 8 ++-- ...db-client-apis.ScriptInvocationParams.html | 4 +- ...luxdb-client-apis.ScriptUpdateRequest.html | 6 +-- ...fluxdata_influxdb-client-apis.Scripts.html | 4 +- ...xdata_influxdb-client-apis.SecretKeys.html | 4 +- ...fluxdb-client-apis.ShardGroupManifest.html | 4 +- ...ta_influxdb-client-apis.ShardManifest.html | 4 +- ...xdata_influxdb-client-apis.ShardOwner.html | 4 +- ...client-apis.SimpleTableViewProperties.html | 6 +-- ...-client-apis.SingleStatViewProperties.html | 6 +-- ...client-apis.SlackNotificationRuleBase.html | 4 +- ...nfluxdata_influxdb-client-apis.Source.html | 4 +- ...fluxdata_influxdb-client-apis.Sources.html | 4 +- ...influxdata_influxdb-client-apis.Stack.html | 4 +- ...ata_influxdb-client-apis.StaticLegend.html | 4 +- ...xdata_influxdb-client-apis.StatusRule.html | 4 +- ...ta_influxdb-client-apis.StringLiteral.html | 4 +- ...uxdb-client-apis.SubscriptionManifest.html | 4 +- ...luxdb-client-apis.TableViewProperties.html | 12 ++--- ...fluxdata_influxdb-client-apis.TagRule.html | 4 +- ..._influxdata_influxdb-client-apis.Task.html | 24 +++++----- ...nfluxdb-client-apis.TaskCreateRequest.html | 10 ++-- ...nfluxdb-client-apis.TaskUpdateRequest.html | 14 +++--- ...influxdata_influxdb-client-apis.Tasks.html | 4 +- ...a_influxdb-client-apis.TelegrafPlugin.html | 4 +- ...xdb-client-apis.TelegrafPluginRequest.html | 4 +- ..._influxdb-client-apis.TelegrafPlugins.html | 4 +- ..._influxdb-client-apis.TelegrafRequest.html | 4 +- ...uxdata_influxdb-client-apis.Telegrafs.html | 4 +- ...ent-apis.TelegramNotificationRuleBase.html | 10 ++-- ...ta_influxdb-client-apis.TemplateApply.html | 20 ++++---- ...ta_influxdb-client-apis.TemplateChart.html | 4 +- ...fluxdb-client-apis.TemplateExportByID.html | 6 +-- ...uxdb-client-apis.TemplateExportByName.html | 4 +- ..._influxdb-client-apis.TemplateSummary.html | 4 +- ...uxdb-client-apis.TemplateSummaryLabel.html | 4 +- ...ta_influxdb-client-apis.TestStatement.html | 4 +- ...ta_influxdb-client-apis.ThresholdBase.html | 4 +- ..._influxdb-client-apis.UnaryExpression.html | 4 +- ...xdb-client-apis.UninstallStackRequest.html | 4 +- ...db-client-apis.UnsignedIntegerLiteral.html | 4 +- ...fluxdb-client-apis.UpdateStackRequest.html | 6 +-- ..._influxdata_influxdb-client-apis.User.html | 6 +-- ...ata_influxdb-client-apis.UserResponse.html | 8 ++-- ...influxdata_influxdb-client-apis.Users.html | 4 +- ...luxdata_influxdb-client-apis.Variable.html | 4 +- ...fluxdb-client-apis.VariableAssignment.html | 4 +- ...uxdata_influxdb-client-apis.Variables.html | 4 +- ..._influxdata_influxdb-client-apis.View.html | 4 +- ...influxdb-client-apis.XYViewProperties.html | 10 ++-- ..._influxdb-client-giraffe.TableOptions.html | 12 ++--- ..._influxdb-client.AnnotatedCSVResponse.html | 18 ++++---- ...nfluxdata_influxdb-client.Cancellable.html | 4 +- ...luxdata_influxdb-client.ChunkCombiner.html | 8 ++-- ...luxdata_influxdb-client.ClientOptions.html | 18 ++++---- ...influxdb-client.CommunicationObserver.html | 14 +++--- ...ata_influxdb-client.ConnectionOptions.html | 14 +++--- ...ata_influxdb-client.FluxParameterLike.html | 4 +- ...ta_influxdb-client.FluxResultObserver.html | 12 ++--- ...xdata_influxdb-client.FluxTableColumn.html | 14 +++--- ...ata_influxdb-client.FluxTableMetaData.html | 10 ++-- .../_influxdata_influxdb-client.Logger.html | 4 +- ...influxdata_influxdb-client.Observable.html | 4 +- .../_influxdata_influxdb-client.Observer.html | 4 +- ...ta_influxdb-client.ParameterizedQuery.html | 4 +- ...luxdata_influxdb-client.PointSettings.html | 6 +-- .../_influxdata_influxdb-client.QueryApi.html | 24 +++++----- ...fluxdata_influxdb-client.QueryOptions.html | 12 ++--- ...ata_influxdb-client.RetriableDecision.html | 6 +-- ...ta_influxdb-client.RetryDelayStrategy.html | 6 +-- ...uxdb-client.RetryDelayStrategyOptions.html | 12 ++--- .../_influxdata_influxdb-client.Row.html | 4 +- ...nfluxdata_influxdb-client.SendOptions.html | 10 ++-- ...fluxdata_influxdb-client.Subscribable.html | 4 +- ...fluxdata_influxdb-client.Subscription.html | 4 +- ..._influxdata_influxdb-client.Transport.html | 10 ++-- .../_influxdata_influxdb-client.WriteApi.html | 24 +++++----- ...fluxdata_influxdb-client.WriteOptions.html | 38 +++++++-------- ...ata_influxdb-client.WriteRetryOptions.html | 24 +++++----- media/CHANGELOG.md | 4 -- ...ta_influxdb-client-apis.Authorization.html | 2 +- ...-client-apis.AuthorizationPostRequest.html | 2 +- ...uxdata_influxdb-client-apis.AxisScale.html | 2 +- ...b-client-apis.BucketMetadataManifests.html | 2 +- ...luxdb-client-apis.BucketShardMappings.html | 2 +- ...ent-apis.BuilderAggregateFunctionType.html | 2 +- ...db-client-apis.CellWithViewProperties.html | 2 +- ...influxdata_influxdb-client-apis.Cells.html | 2 +- ...b-client-apis.CellsWithViewProperties.html | 2 +- ...influxdata_influxdb-client-apis.Check.html | 2 +- ...fluxdb-client-apis.CheckDiscriminator.html | 2 +- ...influxdb-client-apis.CheckStatusLevel.html | 2 +- ...ata_influxdb-client-apis.ColorMapping.html | 2 +- ...data_influxdb-client-apis.CustomCheck.html | 2 +- ...uxdata_influxdb-client-apis.Dashboard.html | 2 +- ...ient-apis.DashboardWithViewProperties.html | 2 +- ...ata_influxdb-client-apis.DeadmanCheck.html | 2 +- ...xdata_influxdb-client-apis.Expression.html | 2 +- ...influxdata_influxdb-client-apis.Flags.html | 2 +- ...fluxdb-client-apis.GeoCircleViewLayer.html | 2 +- ...luxdb-client-apis.GeoHeatMapViewLayer.html | 2 +- ...uxdb-client-apis.GeoPointMapViewLayer.html | 2 +- ...uxdb-client-apis.GeoTrackMapViewLayer.html | 2 +- ...ata_influxdb-client-apis.GeoViewLayer.html | 2 +- ...influxdb-client-apis.GreaterThreshold.html | 2 +- ...-client-apis.HTTPNotificationEndpoint.html | 2 +- ...uxdb-client-apis.HTTPNotificationRule.html | 2 +- ...nfluxdata_influxdb-client-apis.Labels.html | 2 +- ..._influxdb-client-apis.LesserThreshold.html | 2 +- ..._influxdata_influxdb-client-apis.Link.html | 2 +- ..._influxdata_influxdb-client-apis.Node.html | 2 +- ...luxdata_influxdb-client-apis.NodeType.html | 2 +- ...uxdb-client-apis.NotificationEndpoint.html | 2 +- ...pis.NotificationEndpointDiscriminator.html | 2 +- ...-client-apis.NotificationEndpointType.html | 2 +- ...influxdb-client-apis.NotificationRule.html | 2 +- ...nt-apis.NotificationRuleDiscriminator.html | 2 +- ...nt-apis.PagerDutyNotificationEndpoint.html | 2 +- ...client-apis.PagerDutyNotificationRule.html | 2 +- ...luxdb-client-apis.PatchRetentionRules.html | 2 +- ...uxdata_influxdb-client-apis.PostCheck.html | 2 +- ...-client-apis.PostNotificationEndpoint.html | 2 +- ...uxdb-client-apis.PostNotificationRule.html | 2 +- ...data_influxdb-client-apis.PropertyKey.html | 2 +- ...ta_influxdb-client-apis.QueryEditMode.html | 2 +- ...a_influxdb-client-apis.RangeThreshold.html | 2 +- ...a_influxdb-client-apis.ResourceMember.html | 2 +- ...ta_influxdb-client-apis.ResourceOwner.html | 2 +- ...-client-apis.RetentionPolicyManifests.html | 2 +- ...a_influxdb-client-apis.RetentionRules.html | 2 +- ..._influxdb-client-apis.RuleStatusLevel.html | 2 +- ...uxdb-client-apis.SMTPNotificationRule.html | 2 +- ...xdata_influxdb-client-apis.SchemaType.html | 2 +- ...xdb-client-apis.ScraperTargetResponse.html | 2 +- ...db-client-apis.ScriptHTTPResponseData.html | 2 +- ...a_influxdb-client-apis.ScriptLanguage.html | 2 +- ...fluxdb-client-apis.SecretKeysResponse.html | 2 +- ...fluxdata_influxdb-client-apis.Secrets.html | 2 +- ...luxdb-client-apis.ShardGroupManifests.html | 2 +- ...a_influxdb-client-apis.ShardManifests.html | 2 +- ...data_influxdb-client-apis.ShardOwners.html | 2 +- ...client-apis.SlackNotificationEndpoint.html | 2 +- ...xdb-client-apis.SlackNotificationRule.html | 2 +- ...uxdata_influxdb-client-apis.Statement.html | 2 +- ...xdb-client-apis.SubscriptionManifests.html | 2 +- ...a_influxdb-client-apis.TaskStatusType.html | 2 +- ...luxdata_influxdb-client-apis.Telegraf.html | 2 +- ...ent-apis.TelegramNotificationEndpoint.html | 2 +- ...-client-apis.TelegramNotificationRule.html | 2 +- ...luxdata_influxdb-client-apis.Template.html | 2 +- ...xdb-client-apis.TemplateEnvReferences.html | 2 +- ...ata_influxdb-client-apis.TemplateKind.html | 2 +- ...uxdata_influxdb-client-apis.Threshold.html | 2 +- ...a_influxdb-client-apis.ThresholdCheck.html | 2 +- ...fluxdb-client-apis.VariableProperties.html | 2 +- ...a_influxdb-client-apis.ViewProperties.html | 2 +- ...nfluxdata_influxdb-client-apis.XYGeom.html | 2 +- ...uxdb-client-giraffe.AcceptRowFunction.html | 2 +- ...db-client-giraffe.GiraffeTableFactory.html | 2 +- ...nfluxdata_influxdb-client.APIExecutor.html | 2 +- ...influxdata_influxdb-client.ColumnType.html | 2 +- ...nfluxdata_influxdb-client.HttpHeaders.html | 2 +- ...nfluxdb-client.IterableResultExecutor.html | 2 +- ...data_influxdb-client.ObserverComplete.html | 2 +- ...luxdata_influxdb-client.ObserverError.html | 2 +- ...fluxdata_influxdb-client.ObserverNext.html | 2 +- ...ata_influxdb-client.ResponseStartedFn.html | 2 +- ...ta_influxdb-client.WritePrecisionType.html | 2 +- ...client-giraffe.QUERY_MAX_TABLE_LENGTH.html | 2 +- ...uxdb-client.DEFAULT_ConnectionOptions.html | 2 +- ...ent.DEFAULT_RetryDelayStrategyOptions.html | 2 +- ..._influxdb-client.DEFAULT_WriteOptions.html | 2 +- ...influxdata_influxdb-client.FLUX_VALUE.html | 2 +- .../_influxdata_influxdb-client.Log.html | 2 +- ...uxdata_influxdb-client.UNKNOWN_COLUMN.html | 2 +- ...luxdata_influxdb-client.consoleLogger.html | 2 +- ...nfluxdata_influxdb-client.currentTime.html | 2 +- ...fluxdb-client.dateToProtocolTimestamp.html | 2 +- .../_influxdata_influxdb-client.escape.html | 2 +- ...data_influxdb-client.symbolObservable.html | 2 +- ...xdata_influxdb-client.typeSerializers.html | 2 +- 641 files changed, 1846 insertions(+), 1850 deletions(-) diff --git a/classes/_influxdata_influxdb-client-apis.AuthorizationsAPI.html b/classes/_influxdata_influxdb-client-apis.AuthorizationsAPI.html index 9df4e343..8f5b7f2a 100644 --- a/classes/_influxdata_influxdb-client-apis.AuthorizationsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.AuthorizationsAPI.html @@ -1,5 +1,5 @@ AuthorizationsAPI | Documentation

Authorizations API

-

Constructors

Constructors

Methods

Returns AuthorizationsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.BackupAPI.html b/classes/_influxdata_influxdb-client-apis.BackupAPI.html index c32a4a51..d7954c95 100644 --- a/classes/_influxdata_influxdb-client-apis.BackupAPI.html +++ b/classes/_influxdata_influxdb-client-apis.BackupAPI.html @@ -1,23 +1,23 @@ BackupAPI | Documentation

Backup API

-

Constructors

Constructors

Methods

  • Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x. +

Returns BackupAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.BucketsAPI.html b/classes/_influxdata_influxdb-client-apis.BucketsAPI.html index cc125997..65fcde06 100644 --- a/classes/_influxdata_influxdb-client-apis.BucketsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.BucketsAPI.html @@ -1,5 +1,5 @@ BucketsAPI | Documentation

Buckets API

-

Constructors

Constructors

Methods

Returns BucketsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.ChecksAPI.html b/classes/_influxdata_influxdb-client-apis.ChecksAPI.html index 4e9446dc..5bb970be 100644 --- a/classes/_influxdata_influxdb-client-apis.ChecksAPI.html +++ b/classes/_influxdata_influxdb-client-apis.ChecksAPI.html @@ -1,5 +1,5 @@ ChecksAPI | Documentation

Checks API

-

Constructors

Constructors

Methods

Returns ChecksAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.ConfigAPI.html b/classes/_influxdata_influxdb-client-apis.ConfigAPI.html index 1013d7b3..230bc6f3 100644 --- a/classes/_influxdata_influxdb-client-apis.ConfigAPI.html +++ b/classes/_influxdata_influxdb-client-apis.ConfigAPI.html @@ -1,11 +1,11 @@ ConfigAPI | Documentation

Config API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns ConfigAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.DashboardsAPI.html b/classes/_influxdata_influxdb-client-apis.DashboardsAPI.html index e180de92..31386d9a 100644 --- a/classes/_influxdata_influxdb-client-apis.DashboardsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.DashboardsAPI.html @@ -1,5 +1,5 @@ DashboardsAPI | Documentation

Dashboards API

-

Constructors

Constructors

Methods

Returns DashboardsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.DbrpsAPI.html b/classes/_influxdata_influxdb-client-apis.DbrpsAPI.html index 643280bd..ee09ae9b 100644 --- a/classes/_influxdata_influxdb-client-apis.DbrpsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.DbrpsAPI.html @@ -1,5 +1,5 @@ DbrpsAPI | Documentation

Dbrps API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns DbrpsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.DebugAPI.html b/classes/_influxdata_influxdb-client-apis.DebugAPI.html index ad2f84d0..3c74afa3 100644 --- a/classes/_influxdata_influxdb-client-apis.DebugAPI.html +++ b/classes/_influxdata_influxdb-client-apis.DebugAPI.html @@ -1,5 +1,5 @@ DebugAPI | Documentation

Debug API

-

Constructors

Constructors

Methods

Returns DebugAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.DeleteAPI.html b/classes/_influxdata_influxdb-client-apis.DeleteAPI.html index 6e5e4e1b..ae8cb256 100644 --- a/classes/_influxdata_influxdb-client-apis.DeleteAPI.html +++ b/classes/_influxdata_influxdb-client-apis.DeleteAPI.html @@ -1,11 +1,11 @@ DeleteAPI | Documentation

Delete API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns DeleteAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.FlagsAPI.html b/classes/_influxdata_influxdb-client-apis.FlagsAPI.html index 9c5ee30b..9b1cc3ce 100644 --- a/classes/_influxdata_influxdb-client-apis.FlagsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.FlagsAPI.html @@ -1,11 +1,11 @@ FlagsAPI | Documentation

Flags API

-

Constructors

Constructors

Methods

Constructors

Methods

  • Return the feature flags for the currently authenticated user. +

Returns FlagsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.FluxScriptInvocationAPI.html b/classes/_influxdata_influxdb-client-apis.FluxScriptInvocationAPI.html index 9050cc0d..81d4245e 100644 --- a/classes/_influxdata_influxdb-client-apis.FluxScriptInvocationAPI.html +++ b/classes/_influxdata_influxdb-client-apis.FluxScriptInvocationAPI.html @@ -1,14 +1,14 @@ FluxScriptInvocationAPI | Documentation

FluxScriptInvocationAPI executes flux 'API invokable script' and parses the result CSV annotated data. See https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/ .

-

Constructors

Constructors

Methods

Constructors

Methods

  • Invoke returns a parsed response data stream that executes +

Returns FluxScriptInvocationAPI

Methods

  • Invoke returns a parsed response data stream that executes the supplied script when asked for data.

    Parameters

    • scriptID: string

      script identifier

    • Optionalparams: Record<string, any>

      script parameters

    Returns AnnotatedCSVResponse

    response with various methods to process data from the returned annotated CSV response data stream

    -
+
diff --git a/classes/_influxdata_influxdb-client-apis.HealthAPI.html b/classes/_influxdata_influxdb-client-apis.HealthAPI.html index 1cfc8601..97b15034 100644 --- a/classes/_influxdata_influxdb-client-apis.HealthAPI.html +++ b/classes/_influxdata_influxdb-client-apis.HealthAPI.html @@ -1,11 +1,11 @@ HealthAPI | Documentation

Health API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns HealthAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.LabelsAPI.html b/classes/_influxdata_influxdb-client-apis.LabelsAPI.html index 0e77fc88..549bae68 100644 --- a/classes/_influxdata_influxdb-client-apis.LabelsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.LabelsAPI.html @@ -1,5 +1,5 @@ LabelsAPI | Documentation

Labels API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns LabelsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.MeAPI.html b/classes/_influxdata_influxdb-client-apis.MeAPI.html index c88c57df..eceee648 100644 --- a/classes/_influxdata_influxdb-client-apis.MeAPI.html +++ b/classes/_influxdata_influxdb-client-apis.MeAPI.html @@ -1,17 +1,17 @@ MeAPI | Documentation

Me API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns MeAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.MetricsAPI.html b/classes/_influxdata_influxdb-client-apis.MetricsAPI.html index 0faad79b..842f4e8b 100644 --- a/classes/_influxdata_influxdb-client-apis.MetricsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.MetricsAPI.html @@ -1,11 +1,11 @@ MetricsAPI | Documentation

Metrics API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns MetricsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.NotificationEndpointsAPI.html b/classes/_influxdata_influxdb-client-apis.NotificationEndpointsAPI.html index bd5cd5aa..0294936d 100644 --- a/classes/_influxdata_influxdb-client-apis.NotificationEndpointsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.NotificationEndpointsAPI.html @@ -1,5 +1,5 @@ NotificationEndpointsAPI | Documentation

NotificationEndpoints API

-

Constructors

Constructors

Methods

Returns NotificationEndpointsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.NotificationRulesAPI.html b/classes/_influxdata_influxdb-client-apis.NotificationRulesAPI.html index 304277fe..6756f0cb 100644 --- a/classes/_influxdata_influxdb-client-apis.NotificationRulesAPI.html +++ b/classes/_influxdata_influxdb-client-apis.NotificationRulesAPI.html @@ -1,5 +1,5 @@ NotificationRulesAPI | Documentation

NotificationRules API

-

Constructors

Constructors

Methods

Returns NotificationRulesAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.OrgsAPI.html b/classes/_influxdata_influxdb-client-apis.OrgsAPI.html index 2a045507..3c5be8d3 100644 --- a/classes/_influxdata_influxdb-client-apis.OrgsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.OrgsAPI.html @@ -1,5 +1,5 @@ OrgsAPI | Documentation

Orgs API

-

Constructors

Constructors

Methods

Returns OrgsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.PingAPI.html b/classes/_influxdata_influxdb-client-apis.PingAPI.html index a0ab3caf..34c376ed 100644 --- a/classes/_influxdata_influxdb-client-apis.PingAPI.html +++ b/classes/_influxdata_influxdb-client-apis.PingAPI.html @@ -1,11 +1,11 @@ PingAPI | Documentation

Ping API

-

Constructors

Constructors

Methods

Constructors

Methods

  • Get the status and version of the instance. +

Returns PingAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.QueryAPI.html b/classes/_influxdata_influxdb-client-apis.QueryAPI.html index 647590dd..23b545ba 100644 --- a/classes/_influxdata_influxdb-client-apis.QueryAPI.html +++ b/classes/_influxdata_influxdb-client-apis.QueryAPI.html @@ -1,5 +1,5 @@ QueryAPI | Documentation

Query API

-

Constructors

Constructors

Methods

Returns QueryAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.ReadyAPI.html b/classes/_influxdata_influxdb-client-apis.ReadyAPI.html index 2e42da74..5cc50197 100644 --- a/classes/_influxdata_influxdb-client-apis.ReadyAPI.html +++ b/classes/_influxdata_influxdb-client-apis.ReadyAPI.html @@ -1,11 +1,11 @@ ReadyAPI | Documentation

Ready API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns ReadyAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.RemotesAPI.html b/classes/_influxdata_influxdb-client-apis.RemotesAPI.html index 8b80cc02..258d27d2 100644 --- a/classes/_influxdata_influxdb-client-apis.RemotesAPI.html +++ b/classes/_influxdata_influxdb-client-apis.RemotesAPI.html @@ -1,5 +1,5 @@ RemotesAPI | Documentation

Remotes API

-

Constructors

Constructors

Methods

Returns RemotesAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.ReplicationsAPI.html b/classes/_influxdata_influxdb-client-apis.ReplicationsAPI.html index 229a7a8d..53a1a190 100644 --- a/classes/_influxdata_influxdb-client-apis.ReplicationsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.ReplicationsAPI.html @@ -1,5 +1,5 @@ ReplicationsAPI | Documentation

Replications API

-

Constructors

Constructors

Methods

Returns ReplicationsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.ResourcesAPI.html b/classes/_influxdata_influxdb-client-apis.ResourcesAPI.html index b3a3a194..d35eeb85 100644 --- a/classes/_influxdata_influxdb-client-apis.ResourcesAPI.html +++ b/classes/_influxdata_influxdb-client-apis.ResourcesAPI.html @@ -1,11 +1,11 @@ ResourcesAPI | Documentation

Resources API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns ResourcesAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.RestoreAPI.html b/classes/_influxdata_influxdb-client-apis.RestoreAPI.html index 1c9bdf3b..63b16115 100644 --- a/classes/_influxdata_influxdb-client-apis.RestoreAPI.html +++ b/classes/_influxdata_influxdb-client-apis.RestoreAPI.html @@ -1,5 +1,5 @@ RestoreAPI | Documentation

Restore API

-

Constructors

Constructors

Methods

Returns RestoreAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.RootAPI.html b/classes/_influxdata_influxdb-client-apis.RootAPI.html index 39b70588..722540e9 100644 --- a/classes/_influxdata_influxdb-client-apis.RootAPI.html +++ b/classes/_influxdata_influxdb-client-apis.RootAPI.html @@ -1,11 +1,11 @@ RootAPI | Documentation

Root API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns RootAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.ScrapersAPI.html b/classes/_influxdata_influxdb-client-apis.ScrapersAPI.html index 8f24099d..08eb5b8a 100644 --- a/classes/_influxdata_influxdb-client-apis.ScrapersAPI.html +++ b/classes/_influxdata_influxdb-client-apis.ScrapersAPI.html @@ -1,5 +1,5 @@ ScrapersAPI | Documentation

Scrapers API

-

Constructors

Constructors

Methods

Returns ScrapersAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.ScriptsAPI.html b/classes/_influxdata_influxdb-client-apis.ScriptsAPI.html index acc2c635..d899e58d 100644 --- a/classes/_influxdata_influxdb-client-apis.ScriptsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.ScriptsAPI.html @@ -1,5 +1,5 @@ ScriptsAPI | Documentation

Scripts API

-

Constructors

Constructors

Methods

Returns ScriptsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.SetupAPI.html b/classes/_influxdata_influxdb-client-apis.SetupAPI.html index 6d085079..8884075f 100644 --- a/classes/_influxdata_influxdb-client-apis.SetupAPI.html +++ b/classes/_influxdata_influxdb-client-apis.SetupAPI.html @@ -1,17 +1,17 @@ SetupAPI | Documentation

Setup API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns SetupAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.SigninAPI.html b/classes/_influxdata_influxdb-client-apis.SigninAPI.html index 204c9002..50700344 100644 --- a/classes/_influxdata_influxdb-client-apis.SigninAPI.html +++ b/classes/_influxdata_influxdb-client-apis.SigninAPI.html @@ -1,11 +1,11 @@ SigninAPI | Documentation

Signin API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns SigninAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.SignoutAPI.html b/classes/_influxdata_influxdb-client-apis.SignoutAPI.html index 4a99c5ee..ef1e28a4 100644 --- a/classes/_influxdata_influxdb-client-apis.SignoutAPI.html +++ b/classes/_influxdata_influxdb-client-apis.SignoutAPI.html @@ -1,11 +1,11 @@ SignoutAPI | Documentation

Signout API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns SignoutAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.SourcesAPI.html b/classes/_influxdata_influxdb-client-apis.SourcesAPI.html index f5b10798..d7d1e21b 100644 --- a/classes/_influxdata_influxdb-client-apis.SourcesAPI.html +++ b/classes/_influxdata_influxdb-client-apis.SourcesAPI.html @@ -1,5 +1,5 @@ SourcesAPI | Documentation

Sources API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns SourcesAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.StacksAPI.html b/classes/_influxdata_influxdb-client-apis.StacksAPI.html index d9783eea..e0cd9d95 100644 --- a/classes/_influxdata_influxdb-client-apis.StacksAPI.html +++ b/classes/_influxdata_influxdb-client-apis.StacksAPI.html @@ -1,5 +1,5 @@ StacksAPI | Documentation

Stacks API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns StacksAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.TasksAPI.html b/classes/_influxdata_influxdb-client-apis.TasksAPI.html index 472b2f96..72371afc 100644 --- a/classes/_influxdata_influxdb-client-apis.TasksAPI.html +++ b/classes/_influxdata_influxdb-client-apis.TasksAPI.html @@ -1,5 +1,5 @@ TasksAPI | Documentation

Tasks API

-

Constructors

Constructors

Methods

Returns TasksAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.TelegrafAPI.html b/classes/_influxdata_influxdb-client-apis.TelegrafAPI.html index be2dc7c2..2560fc7d 100644 --- a/classes/_influxdata_influxdb-client-apis.TelegrafAPI.html +++ b/classes/_influxdata_influxdb-client-apis.TelegrafAPI.html @@ -1,11 +1,11 @@ TelegrafAPI | Documentation

Telegraf API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns TelegrafAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.TelegrafsAPI.html b/classes/_influxdata_influxdb-client-apis.TelegrafsAPI.html index 3c135065..4370d3ad 100644 --- a/classes/_influxdata_influxdb-client-apis.TelegrafsAPI.html +++ b/classes/_influxdata_influxdb-client-apis.TelegrafsAPI.html @@ -1,5 +1,5 @@ TelegrafsAPI | Documentation

Telegrafs API

-

Constructors

Constructors

Methods

Returns TelegrafsAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.TemplatesAPI.html b/classes/_influxdata_influxdb-client-apis.TemplatesAPI.html index a15f2095..217a43f8 100644 --- a/classes/_influxdata_influxdb-client-apis.TemplatesAPI.html +++ b/classes/_influxdata_influxdb-client-apis.TemplatesAPI.html @@ -1,17 +1,17 @@ TemplatesAPI | Documentation

Templates API

-

Constructors

Constructors

Methods

Returns TemplatesAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.UsersAPI.html b/classes/_influxdata_influxdb-client-apis.UsersAPI.html index f8c3408c..74ce148f 100644 --- a/classes/_influxdata_influxdb-client-apis.UsersAPI.html +++ b/classes/_influxdata_influxdb-client-apis.UsersAPI.html @@ -1,5 +1,5 @@ UsersAPI | Documentation

Users API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns UsersAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.VariablesAPI.html b/classes/_influxdata_influxdb-client-apis.VariablesAPI.html index f7c86733..8637ced4 100644 --- a/classes/_influxdata_influxdb-client-apis.VariablesAPI.html +++ b/classes/_influxdata_influxdb-client-apis.VariablesAPI.html @@ -1,5 +1,5 @@ VariablesAPI | Documentation

Variables API

-

Constructors

Constructors

Methods

Returns VariablesAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client-apis.WriteAPI.html b/classes/_influxdata_influxdb-client-apis.WriteAPI.html index 1e109fb1..dbc454f0 100644 --- a/classes/_influxdata_influxdb-client-apis.WriteAPI.html +++ b/classes/_influxdata_influxdb-client-apis.WriteAPI.html @@ -1,11 +1,11 @@ WriteAPI | Documentation

Write API

-

Constructors

Constructors

Methods

Constructors

Methods

Returns WriteAPI

Methods

+
diff --git a/classes/_influxdata_influxdb-client.AbortError.html b/classes/_influxdata_influxdb-client.AbortError.html index 6a314069..0819a6ed 100644 --- a/classes/_influxdata_influxdb-client.AbortError.html +++ b/classes/_influxdata_influxdb-client.AbortError.html @@ -1,5 +1,5 @@ AbortError | Documentation

AbortError indicates that the communication with the server was aborted

-

Hierarchy

  • Error
    • AbortError

Implements

Constructors

Hierarchy

  • Error
    • AbortError

Implements

Constructors

Properties

message name stack? @@ -8,10 +8,10 @@

Methods

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_influxdata_influxdb-client.HttpError.html b/classes/_influxdata_influxdb-client.HttpError.html index 5c89092f..e5df9d91 100644 --- a/classes/_influxdata_influxdb-client.HttpError.html +++ b/classes/_influxdata_influxdb-client.HttpError.html @@ -1,5 +1,5 @@ HttpError | Documentation

A general HTTP error.

-

Hierarchy

  • Error
    • HttpError

Implements

Constructors

Hierarchy

  • Error
    • HttpError

Implements

Constructors

Properties

body? code contentType? @@ -15,12 +15,12 @@

Methods

Constructors

  • Parameters

    • statusCode: number
    • statusMessage: undefined | string
    • Optionalbody: string
    • OptionalretryAfter: null | string
    • OptionalcontentType: null | string
    • Optionalmessage: string
    • Optionalheaders: HttpHeaders

    Returns HttpError

Properties

body?: string
code: undefined | string

application error code, when available

-
contentType?: null | string
headers?: HttpHeaders
json: any

json error response

-
message: string
name: string
stack?: string
statusCode: number
statusMessage: undefined | string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

Constructors

  • Parameters

    • statusCode: number
    • statusMessage: undefined | string
    • Optionalbody: string
    • OptionalretryAfter: null | string
    • OptionalcontentType: null | string
    • Optionalmessage: string
    • Optionalheaders: HttpHeaders

    Returns HttpError

Properties

body?: string
code: undefined | string

application error code, when available

+
contentType?: null | string
headers?: HttpHeaders
json: any

json error response

+
message: string
name: string
stack?: string
statusCode: number
statusMessage: undefined | string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_influxdata_influxdb-client.IllegalArgumentError.html b/classes/_influxdata_influxdb-client.IllegalArgumentError.html index 594ce891..46d367b1 100644 --- a/classes/_influxdata_influxdb-client.IllegalArgumentError.html +++ b/classes/_influxdata_influxdb-client.IllegalArgumentError.html @@ -1,12 +1,12 @@ IllegalArgumentError | Documentation

IllegalArgumentError is thrown when illegal argument is supplied.

-

Hierarchy

  • Error
    • IllegalArgumentError

Constructors

Hierarchy

  • Error
    • IllegalArgumentError

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_influxdata_influxdb-client.InfluxDB.html b/classes/_influxdata_influxdb-client.InfluxDB.html index a911dae5..83640d45 100644 --- a/classes/_influxdata_influxdb-client.InfluxDB.html +++ b/classes/_influxdata_influxdb-client.InfluxDB.html @@ -1,20 +1,20 @@ InfluxDB | Documentation

InfluxDB entry point that configures communication with InfluxDB server and provide APIs to write and query data.

-

Constructors

Constructors

Properties

processCSVResponse: (
    executor: APIExecutor,
    iterableResultExecutor: IterableResultExecutor,
) => AnnotatedCSVResponse
transport: Transport

Methods

Returns InfluxDB

Properties

processCSVResponse: (
    executor: APIExecutor,
    iterableResultExecutor: IterableResultExecutor,
) => AnnotatedCSVResponse
transport: Transport

Methods

  • Creates WriteApi for the supplied organization and bucket. BEWARE that returned instances must be closed +

  • Creates WriteApi for the supplied organization and bucket. BEWARE that returned instances must be closed in order to flush the remaining data and close already scheduled retry executions.

    Parameters

+
diff --git a/classes/_influxdata_influxdb-client.LineSplitter.html b/classes/_influxdata_influxdb-client.LineSplitter.html index 8cadb1f5..280a78ba 100644 --- a/classes/_influxdata_influxdb-client.LineSplitter.html +++ b/classes/_influxdata_influxdb-client.LineSplitter.html @@ -1,16 +1,16 @@ LineSplitter | Documentation

Optimized tokenizer of a single CSV line.

-

Constructors

Constructors

Properties

Accessors

Methods

Constructors

Properties

lastSplitLength: number

last length of elements in

-
reusedValues: string[]

returned value when reused

-

Accessors

Methods

reusedValues: string[]

returned value when reused

+

Accessors

Methods

  • Splits the supplied line to elements that are separated by comma with values possibly escaped within double quotes ("value")

    Parameters

    • line: undefined | null | string

      line

    Returns string[]

    array of splitted parts

    -
+
diff --git a/classes/_influxdata_influxdb-client.Point.html b/classes/_influxdata_influxdb-client.Point.html index 942c269f..3a7c3607 100644 --- a/classes/_influxdata_influxdb-client.Point.html +++ b/classes/_influxdata_influxdb-client.Point.html @@ -1,5 +1,5 @@ Point | Documentation

Point defines values of a single measurement.

-

Constructors

Constructors

Properties

Methods

booleanField floatField @@ -13,34 +13,34 @@ uintField

Constructors

  • Create a new Point with specified a measurement name.

    Parameters

    • OptionalmeasurementName: string

      the measurement name

      -

    Returns Point

Properties

fields: { [key: string]: string } = {}

escaped field values

-

Methods

  • Adds a boolean field.

    +

Returns Point

Properties

fields: { [key: string]: string } = {}

escaped field values

+

Methods

  • Adds a number field.

    Parameters

    • name: string

      field name

    • value: any

      field value

    Returns Point

    this

    NaN/Infinity/-Infinity is supplied

    -
  • Adds an integer field.

    +
  • Adds an integer field.

    Parameters

    • name: string

      field name

    • value: any

      field value

    Returns Point

    this

    NaN or out of int64 range value is supplied

    -
  • Sets point's measurement.

    +
+
diff --git a/classes/_influxdata_influxdb-client.RequestTimedOutError.html b/classes/_influxdata_influxdb-client.RequestTimedOutError.html index 10fd2f70..846cb1d9 100644 --- a/classes/_influxdata_influxdb-client.RequestTimedOutError.html +++ b/classes/_influxdata_influxdb-client.RequestTimedOutError.html @@ -1,5 +1,5 @@ RequestTimedOutError | Documentation

RequestTimedOutError indicates request timeout in the communication with the server

-

Hierarchy

  • Error
    • RequestTimedOutError

Implements

Constructors

Hierarchy

  • Error
    • RequestTimedOutError

Implements

Constructors

Properties

message name stack? @@ -8,10 +8,10 @@

Methods

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/functions/_influxdata_influxdb-client-giraffe.acceptMaxTableLength.html b/functions/_influxdata_influxdb-client-giraffe.acceptMaxTableLength.html index e29c66bb..075af1ec 100644 --- a/functions/_influxdata_influxdb-client-giraffe.acceptMaxTableLength.html +++ b/functions/_influxdata_influxdb-client-giraffe.acceptMaxTableLength.html @@ -2,4 +2,4 @@ if the table reaches the specified max rows.

Parameters

Returns AcceptRowFunction

AcceptRowFunction that enforces that most max rows are processed

-
+
diff --git a/functions/_influxdata_influxdb-client-giraffe.createCollector.html b/functions/_influxdata_influxdb-client-giraffe.createCollector.html index 6ad69bff..4069f18d 100644 --- a/functions/_influxdata_influxdb-client-giraffe.createCollector.html +++ b/functions/_influxdata_influxdb-client-giraffe.createCollector.html @@ -3,4 +3,4 @@
  • reject: (reason?: any) => void

    called upon error

  • tableFactory: GiraffeTableFactory
  • tableOptions: TableOptions = {}

    tableOptions allow to filter or even stop the processing of rows, or restrict the columns to collect

  • Returns FluxResultObserver<string[]>

    FluxResultObserver that collects table data from result rows

    -
    +
    diff --git a/functions/_influxdata_influxdb-client-giraffe.csvToFromFluxResult.html b/functions/_influxdata_influxdb-client-giraffe.csvToFromFluxResult.html index 89def144..c2243118 100644 --- a/functions/_influxdata_influxdb-client-giraffe.csvToFromFluxResult.html +++ b/functions/_influxdata_influxdb-client-giraffe.csvToFromFluxResult.html @@ -3,4 +3,4 @@
  • tableFactory: GiraffeTableFactory

    creates a new Giraffe table

  • OptionaltableOptions: TableOptions

    tableOptions allows to filter or even stop the processing of rows, specify maximum rows or restrict the columns to collect

  • Returns FromFluxResult

    a new FromFluxResult instance

    -
    +
    diff --git a/functions/_influxdata_influxdb-client-giraffe.csvToTable.html b/functions/_influxdata_influxdb-client-giraffe.csvToTable.html index f372dfa8..6249795c 100644 --- a/functions/_influxdata_influxdb-client-giraffe.csvToTable.html +++ b/functions/_influxdata_influxdb-client-giraffe.csvToTable.html @@ -3,4 +3,4 @@
  • tableFactory: GiraffeTableFactory

    creates a new Giraffe table

  • OptionaltableOptions: TableOptions

    tableOptions allows to filter or even stop the processing of rows, specify maximum rows or restrict the columns to collect.

  • Returns Table

    a new Table instance

    -
    +
    diff --git a/functions/_influxdata_influxdb-client-giraffe.queryToFromFluxResult.html b/functions/_influxdata_influxdb-client-giraffe.queryToFromFluxResult.html index 2a85425c..ff5785c9 100644 --- a/functions/_influxdata_influxdb-client-giraffe.queryToFromFluxResult.html +++ b/functions/_influxdata_influxdb-client-giraffe.queryToFromFluxResult.html @@ -4,4 +4,4 @@
  • tableFactory: GiraffeTableFactory

    creates a new Giraffe table

  • OptionaltableOptions: TableOptions

    tableOptions allows to filter or even stop the processing of rows, specify maximum rows or restrict the columns to collect

  • Returns Promise<FromFluxResult>

    a Promise with query results

    -
    +
    diff --git a/functions/_influxdata_influxdb-client-giraffe.queryToTable.html b/functions/_influxdata_influxdb-client-giraffe.queryToTable.html index f9ba438b..ab40032a 100644 --- a/functions/_influxdata_influxdb-client-giraffe.queryToTable.html +++ b/functions/_influxdata_influxdb-client-giraffe.queryToTable.html @@ -4,4 +4,4 @@
  • tableFactory: GiraffeTableFactory

    creates a new Giraffe table

  • OptionaltableOptions: TableOptions

    tableOptions allows to filter or even stop the processing of rows, specify maximum rows or restrict the columns to collect.

  • Returns Promise<Table>

    Promise with query results

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.canRetryHttpCall.html b/functions/_influxdata_influxdb-client.canRetryHttpCall.html index eb001e93..bb816118 100644 --- a/functions/_influxdata_influxdb-client.canRetryHttpCall.html +++ b/functions/_influxdata_influxdb-client.canRetryHttpCall.html @@ -1,4 +1,4 @@ canRetryHttpCall | Documentation
    • Tests the error in order to know if an HTTP call can be retried.

      Parameters

      • error: any

        error to test

      Returns boolean

      true for a retriable error

      -
    +
    diff --git a/functions/_influxdata_influxdb-client.chunksToLines.html b/functions/_influxdata_influxdb-client.chunksToLines.html index 651347a5..22738467 100644 --- a/functions/_influxdata_influxdb-client.chunksToLines.html +++ b/functions/_influxdata_influxdb-client.chunksToLines.html @@ -3,4 +3,4 @@

    Parameters

    Returns CommunicationObserver<Uint8Array>

    communication obrver to accept Uint8Arrays

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.chunksToLinesIterable.html b/functions/_influxdata_influxdb-client.chunksToLinesIterable.html index b1187491..d7a1fc94 100644 --- a/functions/_influxdata_influxdb-client.chunksToLinesIterable.html +++ b/functions/_influxdata_influxdb-client.chunksToLinesIterable.html @@ -3,4 +3,4 @@

    Parameters

    Returns AsyncIterableIterator<string>

    iterable of lines

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.convertTimeToNanos.html b/functions/_influxdata_influxdb-client.convertTimeToNanos.html index cc2170f7..5d81dd65 100644 --- a/functions/_influxdata_influxdb-client.convertTimeToNanos.html +++ b/functions/_influxdata_influxdb-client.convertTimeToNanos.html @@ -1,4 +1,4 @@ convertTimeToNanos | Documentation
    • convertTimeToNanos converts Point's timestamp to a string.

      Parameters

      • value: undefined | string | number | Date

        supported timestamp value

      Returns string | undefined

      line protocol value

      -
    +
    diff --git a/functions/_influxdata_influxdb-client.createFluxTableColumn.html b/functions/_influxdata_influxdb-client.createFluxTableColumn.html index 9bff28a4..3608999c 100644 --- a/functions/_influxdata_influxdb-client.createFluxTableColumn.html +++ b/functions/_influxdata_influxdb-client.createFluxTableColumn.html @@ -1,4 +1,4 @@ createFluxTableColumn | Documentation
    +
    diff --git a/functions/_influxdata_influxdb-client.createFluxTableMetaData.html b/functions/_influxdata_influxdb-client.createFluxTableMetaData.html index 3c8af214..be4b6be9 100644 --- a/functions/_influxdata_influxdb-client.createFluxTableMetaData.html +++ b/functions/_influxdata_influxdb-client.createFluxTableMetaData.html @@ -3,4 +3,4 @@

    Returns FluxTableMetaData

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.createTextDecoderCombiner.html b/functions/_influxdata_influxdb-client.createTextDecoderCombiner.html index 4e58d395..7cc1cf29 100644 --- a/functions/_influxdata_influxdb-client.createTextDecoderCombiner.html +++ b/functions/_influxdata_influxdb-client.createTextDecoderCombiner.html @@ -1,3 +1,3 @@ createTextDecoderCombiner | Documentation
    +

    Returns ChunkCombiner

    diff --git a/functions/_influxdata_influxdb-client.flux.html b/functions/_influxdata_influxdb-client.flux.html index eb72d000..1112a769 100644 --- a/functions/_influxdata_influxdb-client.flux.html +++ b/functions/_influxdata_influxdb-client.flux.html @@ -1,3 +1,3 @@ flux | Documentation
    +

    Parameters

    Returns ParameterizedQuery

    diff --git a/functions/_influxdata_influxdb-client.fluxBool.html b/functions/_influxdata_influxdb-client.fluxBool.html index cdfc1386..6eead774 100644 --- a/functions/_influxdata_influxdb-client.fluxBool.html +++ b/functions/_influxdata_influxdb-client.fluxBool.html @@ -1,2 +1,2 @@ fluxBool | Documentation
    +

    Parameters

    Returns FluxParameterLike

    diff --git a/functions/_influxdata_influxdb-client.fluxDateTime.html b/functions/_influxdata_influxdb-client.fluxDateTime.html index acb3eda8..a5a65d74 100644 --- a/functions/_influxdata_influxdb-client.fluxDateTime.html +++ b/functions/_influxdata_influxdb-client.fluxDateTime.html @@ -1,2 +1,2 @@ fluxDateTime | Documentation
    +

    Parameters

    Returns FluxParameterLike

    diff --git a/functions/_influxdata_influxdb-client.fluxDuration.html b/functions/_influxdata_influxdb-client.fluxDuration.html index ff581799..eeb4a8df 100644 --- a/functions/_influxdata_influxdb-client.fluxDuration.html +++ b/functions/_influxdata_influxdb-client.fluxDuration.html @@ -1,2 +1,2 @@ fluxDuration | Documentation
    +

    Parameters

    Returns FluxParameterLike

    diff --git a/functions/_influxdata_influxdb-client.fluxExpression.html b/functions/_influxdata_influxdb-client.fluxExpression.html index 2a5d1fb8..7e14b508 100644 --- a/functions/_influxdata_influxdb-client.fluxExpression.html +++ b/functions/_influxdata_influxdb-client.fluxExpression.html @@ -1,4 +1,4 @@ fluxExpression | Documentation
    +
    diff --git a/functions/_influxdata_influxdb-client.fluxFloat.html b/functions/_influxdata_influxdb-client.fluxFloat.html index 1b06b5d7..97f3a128 100644 --- a/functions/_influxdata_influxdb-client.fluxFloat.html +++ b/functions/_influxdata_influxdb-client.fluxFloat.html @@ -1,2 +1,2 @@ fluxFloat | Documentation
    +

    Parameters

    Returns FluxParameterLike

    diff --git a/functions/_influxdata_influxdb-client.fluxInteger.html b/functions/_influxdata_influxdb-client.fluxInteger.html index 185e8533..60f77a3f 100644 --- a/functions/_influxdata_influxdb-client.fluxInteger.html +++ b/functions/_influxdata_influxdb-client.fluxInteger.html @@ -1,2 +1,2 @@ fluxInteger | Documentation
    +

    Parameters

    Returns FluxParameterLike

    diff --git a/functions/_influxdata_influxdb-client.fluxRegExp.html b/functions/_influxdata_influxdb-client.fluxRegExp.html index 5a043719..d2147220 100644 --- a/functions/_influxdata_influxdb-client.fluxRegExp.html +++ b/functions/_influxdata_influxdb-client.fluxRegExp.html @@ -1,4 +1,4 @@ fluxRegExp | Documentation
    +

    Parameters

    Returns FluxParameterLike

    diff --git a/functions/_influxdata_influxdb-client.fluxString.html b/functions/_influxdata_influxdb-client.fluxString.html index 6b073f28..b9c2235f 100644 --- a/functions/_influxdata_influxdb-client.fluxString.html +++ b/functions/_influxdata_influxdb-client.fluxString.html @@ -1,2 +1,2 @@ fluxString | Documentation
    +

    Parameters

    Returns FluxParameterLike

    diff --git a/functions/_influxdata_influxdb-client.getRetryDelay.html b/functions/_influxdata_influxdb-client.getRetryDelay.html index 7e49e527..717344f2 100644 --- a/functions/_influxdata_influxdb-client.getRetryDelay.html +++ b/functions/_influxdata_influxdb-client.getRetryDelay.html @@ -1,2 +1,2 @@ getRetryDelay | Documentation
    • Gets retry delay from the supplied error, possibly using random number up to retryJitter.

      -

      Parameters

      • Optionalerror: Error
      • OptionalretryJitter: number

      Returns number

    +

    Parameters

    Returns number

    diff --git a/functions/_influxdata_influxdb-client.isStatusCodeRetriable.html b/functions/_influxdata_influxdb-client.isStatusCodeRetriable.html index 720cf359..315758c5 100644 --- a/functions/_influxdata_influxdb-client.isStatusCodeRetriable.html +++ b/functions/_influxdata_influxdb-client.isStatusCodeRetriable.html @@ -1,2 +1,2 @@ isStatusCodeRetriable | Documentation
    • isStatusCodeRetriable checks whether the supplied HTTP status code is retriable.

      -

      Parameters

      • statusCode: number

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/functions/_influxdata_influxdb-client.linesToRowsIterable.html b/functions/_influxdata_influxdb-client.linesToRowsIterable.html index 89680a1c..472bde96 100644 --- a/functions/_influxdata_influxdb-client.linesToRowsIterable.html +++ b/functions/_influxdata_influxdb-client.linesToRowsIterable.html @@ -1,4 +1,4 @@ linesToRowsIterable | Documentation
    • LinesToRowsIterable is a transformation that accepts an iterable of flux annotated CSV lines and returns an iterable of rows (row values and table metadata).

      -

      Parameters

      • source: AsyncIterable<string>

      Returns AsyncIterableIterator<Row>

    +

    Parameters

    Returns AsyncIterableIterator<Row>

    diff --git a/functions/_influxdata_influxdb-client.linesToTables.html b/functions/_influxdata_influxdb-client.linesToTables.html index c818835e..c4a28aa6 100644 --- a/functions/_influxdata_influxdb-client.linesToTables.html +++ b/functions/_influxdata_influxdb-client.linesToTables.html @@ -1,3 +1,3 @@ linesToTables | Documentation
    +

    Parameters

    Returns CommunicationObserver<string>

    diff --git a/functions/_influxdata_influxdb-client.newFluxTableColumn.html b/functions/_influxdata_influxdb-client.newFluxTableColumn.html index d5e75c10..c8f7d49f 100644 --- a/functions/_influxdata_influxdb-client.newFluxTableColumn.html +++ b/functions/_influxdata_influxdb-client.newFluxTableColumn.html @@ -1,3 +1,3 @@ newFluxTableColumn | Documentation
    +
    diff --git a/functions/_influxdata_influxdb-client.sanitizeFloat.html b/functions/_influxdata_influxdb-client.sanitizeFloat.html index 209c0073..077da518 100644 --- a/functions/_influxdata_influxdb-client.sanitizeFloat.html +++ b/functions/_influxdata_influxdb-client.sanitizeFloat.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    sanitized float value

    Error if the the value cannot be sanitized

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.sanitizeInteger.html b/functions/_influxdata_influxdb-client.sanitizeInteger.html index 10f0362f..7afea40d 100644 --- a/functions/_influxdata_influxdb-client.sanitizeInteger.html +++ b/functions/_influxdata_influxdb-client.sanitizeInteger.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    sanitized integer value

    Error if the the value cannot be sanitized

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.serializeDateTimeAsDate.html b/functions/_influxdata_influxdb-client.serializeDateTimeAsDate.html index af21ce84..a8eb3e88 100644 --- a/functions/_influxdata_influxdb-client.serializeDateTimeAsDate.html +++ b/functions/_influxdata_influxdb-client.serializeDateTimeAsDate.html @@ -2,4 +2,4 @@ for 'dateTime:RFC3339' query result data type. Empty value is converted to null.

    Returns void

    Please note that the result has millisecond precision whereas InfluxDB returns dateTime in nanosecond precision.

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.serializeDateTimeAsNumber.html b/functions/_influxdata_influxdb-client.serializeDateTimeAsNumber.html index efecb074..d016c657 100644 --- a/functions/_influxdata_influxdb-client.serializeDateTimeAsNumber.html +++ b/functions/_influxdata_influxdb-client.serializeDateTimeAsNumber.html @@ -2,4 +2,4 @@ for 'dateTime:RFC3339' query result data type. Empty value is converted to null.

    Returns void

    Please note that the result has millisecond precision whereas InfluxDB returns dateTime in nanosecond precision.

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.serializeDateTimeAsString.html b/functions/_influxdata_influxdb-client.serializeDateTimeAsString.html index fa12ccad..5c33ca5c 100644 --- a/functions/_influxdata_influxdb-client.serializeDateTimeAsString.html +++ b/functions/_influxdata_influxdb-client.serializeDateTimeAsString.html @@ -1,3 +1,3 @@ serializeDateTimeAsString | Documentation
    • serializeDateTimeAsString changes type serializers to return string values for dateTime:RFC3339 query result data type. Empty value is converted to null.

      -

      Returns void

    +

    Returns void

    diff --git a/functions/_influxdata_influxdb-client.setLogger.html b/functions/_influxdata_influxdb-client.setLogger.html index 8a874496..c174feb8 100644 --- a/functions/_influxdata_influxdb-client.setLogger.html +++ b/functions/_influxdata_influxdb-client.setLogger.html @@ -1,4 +1,4 @@ setLogger | Documentation
    +
    diff --git a/functions/_influxdata_influxdb-client.stringToLines.html b/functions/_influxdata_influxdb-client.stringToLines.html index 4663c268..10bbb90a 100644 --- a/functions/_influxdata_influxdb-client.stringToLines.html +++ b/functions/_influxdata_influxdb-client.stringToLines.html @@ -3,4 +3,4 @@

    Parameters

    Returns void

    communication obrver to accept Uint8Arrays

    -
    +
    diff --git a/functions/_influxdata_influxdb-client.toFluxValue.html b/functions/_influxdata_influxdb-client.toFluxValue.html index 06a2477f..1a64910f 100644 --- a/functions/_influxdata_influxdb-client.toFluxValue.html +++ b/functions/_influxdata_influxdb-client.toFluxValue.html @@ -1,4 +1,4 @@ toFluxValue | Documentation
    • Escapes content of the supplied parameter so that it can be safely embedded into flux query.

      Parameters

      • value: any

        parameter value

      Returns string

      sanitized flux value or an empty string if it cannot be converted

      -
    +
    diff --git a/functions/_influxdata_influxdb-client.useProcessHrtime.html b/functions/_influxdata_influxdb-client.useProcessHrtime.html index 0d6560d4..cc22e876 100644 --- a/functions/_influxdata_influxdb-client.useProcessHrtime.html +++ b/functions/_influxdata_influxdb-client.useProcessHrtime.html @@ -1 +1 @@ -useProcessHrtime | Documentation
    +useProcessHrtime | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ASTResponse.html b/interfaces/_influxdata_influxdb-client-apis.ASTResponse.html index aa5ce79e..483a0e4c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ASTResponse.html +++ b/interfaces/_influxdata_influxdb-client-apis.ASTResponse.html @@ -1,3 +1,3 @@ ASTResponse | Documentation

    Contains the AST for the supplied Flux query

    -
    interface ASTResponse {
        ast?: Package;
    }

    Properties

    Properties

    ast?: Package
    +
    interface ASTResponse {
        ast?: Package;
    }

    Properties

    Properties

    ast?: Package
    diff --git a/interfaces/_influxdata_influxdb-client-apis.AddResourceMemberRequestBody.html b/interfaces/_influxdata_influxdb-client-apis.AddResourceMemberRequestBody.html index 169b266a..75d13e97 100644 --- a/interfaces/_influxdata_influxdb-client-apis.AddResourceMemberRequestBody.html +++ b/interfaces/_influxdata_influxdb-client-apis.AddResourceMemberRequestBody.html @@ -1,5 +1,5 @@ -AddResourceMemberRequestBody | Documentation
    interface AddResourceMemberRequestBody {
        id: string;
        name?: string;
    }

    Properties

    id +AddResourceMemberRequestBody | Documentation
    interface AddResourceMemberRequestBody {
        id: string;
        name?: string;
    }

    Properties

    Properties

    id: string

    The ID of the user to add to the resource.

    -
    name?: string

    The name of the user to add to the resource.

    -
    +
    name?: string

    The name of the user to add to the resource.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.AnalyzeQueryResponse.html b/interfaces/_influxdata_influxdb-client-apis.AnalyzeQueryResponse.html index 2c31f9c1..b6e5c714 100644 --- a/interfaces/_influxdata_influxdb-client-apis.AnalyzeQueryResponse.html +++ b/interfaces/_influxdata_influxdb-client-apis.AnalyzeQueryResponse.html @@ -1,2 +1,2 @@ -AnalyzeQueryResponse | Documentation
    interface AnalyzeQueryResponse {
        errors?: {
            character?: number;
            column?: number;
            line?: number;
            message?: string;
        }[];
    }

    Properties

    Properties

    errors?: {
        character?: number;
        column?: number;
        line?: number;
        message?: string;
    }[]
    +AnalyzeQueryResponse | Documentation
    interface AnalyzeQueryResponse {
        errors?: {
            character?: number;
            column?: number;
            line?: number;
            message?: string;
        }[];
    }

    Properties

    Properties

    errors?: {
        character?: number;
        column?: number;
        line?: number;
        message?: string;
    }[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ApplyTemplateRequest.html b/interfaces/_influxdata_influxdb-client-apis.ApplyTemplateRequest.html index c9267845..a2f353c5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ApplyTemplateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ApplyTemplateRequest.html @@ -1,3 +1,3 @@ -ApplyTemplateRequest | Documentation
    interface ApplyTemplateRequest {
        body: TemplateApply;
    }

    Properties

    body +ApplyTemplateRequest | Documentation
    interface ApplyTemplateRequest {
        body: TemplateApply;
    }

    Properties

    Properties

    Parameters for applying templates.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ArrayExpression.html b/interfaces/_influxdata_influxdb-client-apis.ArrayExpression.html index 67e6b3cc..b3174c52 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ArrayExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.ArrayExpression.html @@ -1,5 +1,5 @@ ArrayExpression | Documentation

    Used to create and directly specify the elements of an array object

    -
    interface ArrayExpression {
        elements?: Expression[];
        type?: string;
    }

    Properties

    interface ArrayExpression {
        elements?: Expression[];
        type?: string;
    }

    Properties

    Properties

    elements?: Expression[]

    Elements of the array

    -
    type?: string
    +
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.AuthorizationUpdateRequest.html b/interfaces/_influxdata_influxdb-client-apis.AuthorizationUpdateRequest.html index e6f7f067..ebb9b259 100644 --- a/interfaces/_influxdata_influxdb-client-apis.AuthorizationUpdateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.AuthorizationUpdateRequest.html @@ -1,5 +1,5 @@ -AuthorizationUpdateRequest | Documentation
    interface AuthorizationUpdateRequest {
        description?: string;
        status?: "active" | "inactive";
    }

    Properties

    description? +AuthorizationUpdateRequest | Documentation
    interface AuthorizationUpdateRequest {
        description?: string;
        status?: "active" | "inactive";
    }

    Properties

    description?: string

    A description of the token.

    -
    status?: "active" | "inactive"

    Status of the token. If inactive, requests using the token will be rejected.

    -
    +
    status?: "active" | "inactive"

    Status of the token. If inactive, requests using the token will be rejected.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Authorizations.html b/interfaces/_influxdata_influxdb-client-apis.Authorizations.html index 07bdc808..efaac888 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Authorizations.html +++ b/interfaces/_influxdata_influxdb-client-apis.Authorizations.html @@ -1,3 +1,3 @@ -Authorizations | Documentation
    interface Authorizations {
        authorizations?: Authorization[];
        links?: Links;
    }

    Properties

    authorizations? +Authorizations | Documentation
    interface Authorizations {
        authorizations?: Authorization[];
        links?: Links;
    }

    Properties

    authorizations?: Authorization[]
    links?: Links
    +

    Properties

    authorizations?: Authorization[]
    links?: Links
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Axes.html b/interfaces/_influxdata_influxdb-client-apis.Axes.html index 4cb523c8..6b2cf95c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Axes.html +++ b/interfaces/_influxdata_influxdb-client-apis.Axes.html @@ -1,4 +1,4 @@ Axes | Documentation

    The viewport for a View's visualizations

    -
    interface Axes {
        x: Axis;
        y: Axis;
    }

    Properties

    x +
    interface Axes {
        x: Axis;
        y: Axis;
    }

    Properties

    x y -

    Properties

    x: Axis
    y: Axis
    +

    Properties

    x: Axis
    y: Axis
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Axis.html b/interfaces/_influxdata_influxdb-client-apis.Axis.html index 60e36970..d857c9be 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Axis.html +++ b/interfaces/_influxdata_influxdb-client-apis.Axis.html @@ -1,13 +1,13 @@ Axis | Documentation

    Axis used in a visualization.

    -
    interface Axis {
        base?: "" | "2" | "10";
        bounds?: string[];
        label?: string;
        prefix?: string;
        scale?: AxisScale;
        suffix?: string;
    }

    Properties

    interface Axis {
        base?: "" | "2" | "10";
        bounds?: string[];
        label?: string;
        prefix?: string;
        scale?: AxisScale;
        suffix?: string;
    }

    Properties

    base?: "" | "2" | "10"

    Radix for formatting axis values.

    -
    bounds?: string[]

    The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits.

    -
    label?: string

    Description of the axis.

    -
    prefix?: string

    Label prefix for formatting axis values.

    -
    scale?: AxisScale
    suffix?: string

    Label suffix for formatting axis values.

    -
    +
    bounds?: string[]

    The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits.

    +
    label?: string

    Description of the axis.

    +
    prefix?: string

    Label prefix for formatting axis values.

    +
    scale?: AxisScale
    suffix?: string

    Label suffix for formatting axis values.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BadStatement.html b/interfaces/_influxdata_influxdb-client-apis.BadStatement.html index 5d7858ac..c833c353 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BadStatement.html +++ b/interfaces/_influxdata_influxdb-client-apis.BadStatement.html @@ -1,5 +1,5 @@ BadStatement | Documentation

    A placeholder for statements for which no correct statement nodes can be created

    -
    interface BadStatement {
        text?: string;
        type?: string;
    }

    Properties

    interface BadStatement {
        text?: string;
        type?: string;
    }

    Properties

    Properties

    text?: string

    Raw source text

    -
    type?: string
    +
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BandViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.BandViewProperties.html index 0fa5fcdf..f718c07d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BandViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.BandViewProperties.html @@ -1,4 +1,4 @@ -BandViewProperties | Documentation
    interface BandViewProperties {
        adaptiveZoomHide?: boolean;
        axes: Axes;
        colors: DashboardColor[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        geom: XYGeom;
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        lowerColumn?: string;
        mainColumn?: string;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        timeFormat?: string;
        type: "band";
        upperColumn?: string;
        xColumn?: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yColumn?: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide? +BandViewProperties | Documentation
    interface BandViewProperties {
        adaptiveZoomHide?: boolean;
        axes: Axes;
        colors: DashboardColor[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        geom: XYGeom;
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        lowerColumn?: string;
        mainColumn?: string;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        timeFormat?: string;
        type: "band";
        upperColumn?: string;
        xColumn?: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yColumn?: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide?: boolean
    axes: Axes
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    geom: XYGeom
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    lowerColumn?: string
    mainColumn?: string
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    staticLegend?: StaticLegend
    timeFormat?: string
    type: "band"
    upperColumn?: string
    xColumn?: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yColumn?: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    +

    Properties

    adaptiveZoomHide?: boolean
    axes: Axes
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    +
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    geom: XYGeom
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    lowerColumn?: string
    mainColumn?: string
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    staticLegend?: StaticLegend
    timeFormat?: string
    type: "band"
    upperColumn?: string
    xColumn?: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yColumn?: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BinaryExpression.html b/interfaces/_influxdata_influxdb-client-apis.BinaryExpression.html index 7374da99..53c9664c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BinaryExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.BinaryExpression.html @@ -1,6 +1,6 @@ BinaryExpression | Documentation

    uses binary operators to act on two operands in an expression

    -
    interface BinaryExpression {
        left?: Expression;
        operator?: string;
        right?: Expression;
        type?: string;
    }

    Properties

    interface BinaryExpression {
        left?: Expression;
        operator?: string;
        right?: Expression;
        type?: string;
    }

    Properties

    left?: Expression
    operator?: string
    right?: Expression
    type?: string
    +

    Properties

    left?: Expression
    operator?: string
    right?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Block.html b/interfaces/_influxdata_influxdb-client-apis.Block.html index d4ed430a..073af812 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Block.html +++ b/interfaces/_influxdata_influxdb-client-apis.Block.html @@ -1,5 +1,5 @@ Block | Documentation

    A set of statements

    -
    interface Block {
        body?: Statement[];
        type?: string;
    }

    Properties

    interface Block {
        body?: Statement[];
        type?: string;
    }

    Properties

    Properties

    body?: Statement[]

    Block body

    -
    type?: string
    +
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BooleanLiteral.html b/interfaces/_influxdata_influxdb-client-apis.BooleanLiteral.html index 78096b9a..23aa1e5f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BooleanLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.BooleanLiteral.html @@ -1,4 +1,4 @@ BooleanLiteral | Documentation

    Represents boolean values

    -
    interface BooleanLiteral {
        type?: string;
        value?: boolean;
    }

    Properties

    interface BooleanLiteral {
        type?: string;
        value?: boolean;
    }

    Properties

    Properties

    type?: string
    value?: boolean
    +

    Properties

    type?: string
    value?: boolean
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Bucket.html b/interfaces/_influxdata_influxdb-client-apis.Bucket.html index 1b65ff3e..93b6792b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Bucket.html +++ b/interfaces/_influxdata_influxdb-client-apis.Bucket.html @@ -1,4 +1,4 @@ -Bucket | Documentation
    interface Bucket {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        links?: {
            labels?: string;
            members?: string;
            org?: string;
            owners?: string;
            self?: string;
            write?: string;
        };
        name: string;
        orgID?: string;
        retentionRules: RetentionRules;
        rp?: string;
        schemaType?: SchemaType;
        type?: "user"
        | "system";
        updatedAt?: string;
    }

    Properties

    createdAt? +Bucket | Documentation
    interface Bucket {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        links?: {
            labels?: string;
            members?: string;
            org?: string;
            owners?: string;
            self?: string;
            write?: string;
        };
        name: string;
        orgID?: string;
        retentionRules: RetentionRules;
        rp?: string;
        schemaType?: SchemaType;
        type?: "user"
        | "system";
        updatedAt?: string;
    }

    Properties

    createdAt?: string
    description?: string
    id?: string
    labels?: Labels
    links?: {
        labels?: string;
        members?: string;
        org?: string;
        owners?: string;
        self?: string;
        write?: string;
    }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this bucket.

      +

    Properties

    createdAt?: string
    description?: string
    id?: string
    labels?: Labels
    links?: {
        labels?: string;
        members?: string;
        org?: string;
        owners?: string;
        self?: string;
        write?: string;
    }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this bucket.

    • Optionalmembers?: string

      URL to retrieve members that can read this bucket.

    • Optionalorg?: string

      URL to retrieve parent organization for this bucket.

    • Optionalowners?: string

      URL to retrieve owners that can read and write to this bucket.

    • Optionalself?: string

      URL for this bucket.

    • Optionalwrite?: string

      URL to write line protocol to this bucket.

      -
    name: string
    orgID?: string
    retentionRules: RetentionRules
    rp?: string
    schemaType?: SchemaType
    type?: "user" | "system"
    updatedAt?: string
    +
    name: string
    orgID?: string
    retentionRules: RetentionRules
    rp?: string
    schemaType?: SchemaType
    type?: "user" | "system"
    updatedAt?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BucketMetadataManifest.html b/interfaces/_influxdata_influxdb-client-apis.BucketMetadataManifest.html index 800fba03..e6790bff 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BucketMetadataManifest.html +++ b/interfaces/_influxdata_influxdb-client-apis.BucketMetadataManifest.html @@ -1,8 +1,8 @@ -BucketMetadataManifest | Documentation
    interface BucketMetadataManifest {
        bucketID: string;
        bucketName: string;
        defaultRetentionPolicy: string;
        description?: string;
        organizationID: string;
        organizationName: string;
        retentionPolicies: RetentionPolicyManifests;
    }

    Properties

    bucketID +BucketMetadataManifest | Documentation
    interface BucketMetadataManifest {
        bucketID: string;
        bucketName: string;
        defaultRetentionPolicy: string;
        description?: string;
        organizationID: string;
        organizationName: string;
        retentionPolicies: RetentionPolicyManifests;
    }

    Properties

    bucketID: string
    bucketName: string
    defaultRetentionPolicy: string
    description?: string
    organizationID: string
    organizationName: string
    retentionPolicies: RetentionPolicyManifests
    +

    Properties

    bucketID: string
    bucketName: string
    defaultRetentionPolicy: string
    description?: string
    organizationID: string
    organizationName: string
    retentionPolicies: RetentionPolicyManifests
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BucketShardMapping.html b/interfaces/_influxdata_influxdb-client-apis.BucketShardMapping.html index 3537d145..c52d2a18 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BucketShardMapping.html +++ b/interfaces/_influxdata_influxdb-client-apis.BucketShardMapping.html @@ -1,3 +1,3 @@ -BucketShardMapping | Documentation
    interface BucketShardMapping {
        newId: number;
        oldId: number;
    }

    Properties

    newId +BucketShardMapping | Documentation
    interface BucketShardMapping {
        newId: number;
        oldId: number;
    }

    Properties

    Properties

    newId: number
    oldId: number
    +

    Properties

    newId: number
    oldId: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Buckets.html b/interfaces/_influxdata_influxdb-client-apis.Buckets.html index fb80136e..479c8f51 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Buckets.html +++ b/interfaces/_influxdata_influxdb-client-apis.Buckets.html @@ -1,3 +1,3 @@ -Buckets | Documentation
    interface Buckets {
        buckets?: Bucket[];
        links?: Links;
    }

    Properties

    buckets? +Buckets | Documentation
    interface Buckets {
        buckets?: Bucket[];
        links?: Links;
    }

    Properties

    Properties

    buckets?: Bucket[]
    links?: Links
    +

    Properties

    buckets?: Bucket[]
    links?: Links
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BuilderConfig.html b/interfaces/_influxdata_influxdb-client-apis.BuilderConfig.html index 3c278180..3ff9a7e1 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BuilderConfig.html +++ b/interfaces/_influxdata_influxdb-client-apis.BuilderConfig.html @@ -1,5 +1,5 @@ -BuilderConfig | Documentation
    interface BuilderConfig {
        aggregateWindow?: { fillValues?: boolean; period?: string };
        buckets?: string[];
        functions?: BuilderFunctionsType[];
        tags?: BuilderTagsType[];
    }

    Properties

    aggregateWindow? +BuilderConfig | Documentation
    interface BuilderConfig {
        aggregateWindow?: { fillValues?: boolean; period?: string };
        buckets?: string[];
        functions?: BuilderFunctionsType[];
        tags?: BuilderTagsType[];
    }

    Properties

    aggregateWindow?: { fillValues?: boolean; period?: string }
    buckets?: string[]
    functions?: BuilderFunctionsType[]
    +

    Properties

    aggregateWindow?: { fillValues?: boolean; period?: string }
    buckets?: string[]
    functions?: BuilderFunctionsType[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BuilderFunctionsType.html b/interfaces/_influxdata_influxdb-client-apis.BuilderFunctionsType.html index d23431ef..3c086f3b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BuilderFunctionsType.html +++ b/interfaces/_influxdata_influxdb-client-apis.BuilderFunctionsType.html @@ -1,2 +1,2 @@ -BuilderFunctionsType | Documentation
    interface BuilderFunctionsType {
        name?: string;
    }

    Properties

    Properties

    name?: string
    +BuilderFunctionsType | Documentation
    interface BuilderFunctionsType {
        name?: string;
    }

    Properties

    Properties

    name?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BuilderTagsType.html b/interfaces/_influxdata_influxdb-client-apis.BuilderTagsType.html index 7d04730c..16c59224 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BuilderTagsType.html +++ b/interfaces/_influxdata_influxdb-client-apis.BuilderTagsType.html @@ -1,4 +1,4 @@ -BuilderTagsType | Documentation
    interface BuilderTagsType {
        aggregateFunctionType?: BuilderAggregateFunctionType;
        key?: string;
        values?: string[];
    }

    Properties

    aggregateFunctionType? +BuilderTagsType | Documentation
    interface BuilderTagsType {
        aggregateFunctionType?: BuilderAggregateFunctionType;
        key?: string;
        values?: string[];
    }

    Properties

    aggregateFunctionType?: BuilderAggregateFunctionType
    key?: string
    values?: string[]
    +

    Properties

    aggregateFunctionType?: BuilderAggregateFunctionType
    key?: string
    values?: string[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.BuiltinStatement.html b/interfaces/_influxdata_influxdb-client-apis.BuiltinStatement.html index a6dfbd28..fb80a8a2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.BuiltinStatement.html +++ b/interfaces/_influxdata_influxdb-client-apis.BuiltinStatement.html @@ -1,4 +1,4 @@ BuiltinStatement | Documentation

    Declares a builtin identifier and its type

    -
    interface BuiltinStatement {
        id?: Identifier;
        type?: string;
    }

    Properties

    id? +
    interface BuiltinStatement {
        id?: Identifier;
        type?: string;
    }

    Properties

    Properties

    type?: string
    +

    Properties

    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CallExpression.html b/interfaces/_influxdata_influxdb-client-apis.CallExpression.html index 4e543577..5fc33471 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CallExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.CallExpression.html @@ -1,6 +1,6 @@ CallExpression | Documentation

    Represents a function call

    -
    interface CallExpression {
        arguments?: Expression[];
        callee?: Expression;
        type?: string;
    }

    Properties

    interface CallExpression {
        arguments?: Expression[];
        callee?: Expression;
        type?: string;
    }

    Properties

    arguments?: Expression[]

    Function arguments

    -
    callee?: Expression
    type?: string
    +
    callee?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Cell.html b/interfaces/_influxdata_influxdb-client-apis.Cell.html index 4ac73b6c..7750eb0f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Cell.html +++ b/interfaces/_influxdata_influxdb-client-apis.Cell.html @@ -1,9 +1,9 @@ -Cell | Documentation
    interface Cell {
        h?: number;
        id?: string;
        links?: { self?: string; view?: string };
        viewID?: string;
        w?: number;
        x?: number;
        y?: number;
    }

    Properties

    h? +Cell | Documentation
    interface Cell {
        h?: number;
        id?: string;
        links?: { self?: string; view?: string };
        viewID?: string;
        w?: number;
        x?: number;
        y?: number;
    }

    Properties

    Properties

    h?: number
    id?: string
    links?: { self?: string; view?: string }
    viewID?: string

    The reference to a view from the views API.

    -
    w?: number
    x?: number
    y?: number
    +

    Properties

    h?: number
    id?: string
    links?: { self?: string; view?: string }
    viewID?: string

    The reference to a view from the views API.

    +
    w?: number
    x?: number
    y?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CellUpdate.html b/interfaces/_influxdata_influxdb-client-apis.CellUpdate.html index 0fa00954..a37baaac 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CellUpdate.html +++ b/interfaces/_influxdata_influxdb-client-apis.CellUpdate.html @@ -1,5 +1,5 @@ -CellUpdate | Documentation
    interface CellUpdate {
        h?: number;
        w?: number;
        x?: number;
        y?: number;
    }

    Properties

    h? +CellUpdate | Documentation
    interface CellUpdate {
        h?: number;
        w?: number;
        x?: number;
        y?: number;
    }

    Properties

    Properties

    h?: number
    w?: number
    x?: number
    y?: number
    +

    Properties

    h?: number
    w?: number
    x?: number
    y?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CheckBase.html b/interfaces/_influxdata_influxdb-client-apis.CheckBase.html index 1fa1644b..6662c975 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CheckBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.CheckBase.html @@ -1,4 +1,4 @@ -CheckBase | Documentation
    interface CheckBase {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        lastRunError?: string;
        lastRunStatus?: "failed" | "success" | "canceled";
        latestCompleted?: string;
        links?: {
            labels?: string;
            members?: string;
            owners?: string;
            query?: string;
            self?: string;
        };
        name: string;
        orgID: string;
        ownerID?: string;
        query: DashboardQuery;
        status?: TaskStatusType;
        taskID?: string;
        updatedAt?: string;
    }

    Properties

    createdAt? +CheckBase | Documentation
    interface CheckBase {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        lastRunError?: string;
        lastRunStatus?: "failed" | "success" | "canceled";
        latestCompleted?: string;
        links?: {
            labels?: string;
            members?: string;
            owners?: string;
            query?: string;
            self?: string;
        };
        name: string;
        orgID: string;
        ownerID?: string;
        query: DashboardQuery;
        status?: TaskStatusType;
        taskID?: string;
        updatedAt?: string;
    }

    Properties

    Properties

    createdAt?: string
    description?: string

    An optional description of the check.

    -
    id?: string
    labels?: Labels
    lastRunError?: string
    lastRunStatus?: "failed" | "success" | "canceled"
    latestCompleted?: string

    A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

    -
    links?: {
        labels?: string;
        members?: string;
        owners?: string;
        query?: string;
        self?: string;
    }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this check

      +

    Properties

    createdAt?: string
    description?: string

    An optional description of the check.

    +
    id?: string
    labels?: Labels
    lastRunError?: string
    lastRunStatus?: "failed" | "success" | "canceled"
    latestCompleted?: string

    A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

    +
    links?: {
        labels?: string;
        members?: string;
        owners?: string;
        query?: string;
        self?: string;
    }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this check

    • Optionalmembers?: string

      URL to retrieve members for this check

    • Optionalowners?: string

      URL to retrieve owners for this check

    • Optionalquery?: string

      URL to retrieve flux script for this check

    • Optionalself?: string

      URL for this check

      -
    name: string
    orgID: string

    The ID of the organization that owns this check.

    -
    ownerID?: string

    The ID of creator used to create this check.

    -
    taskID?: string

    The ID of the task associated with this check.

    -
    updatedAt?: string
    +
    name: string
    orgID: string

    The ID of the organization that owns this check.

    +
    ownerID?: string

    The ID of creator used to create this check.

    +
    taskID?: string

    The ID of the task associated with this check.

    +
    updatedAt?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CheckPatch.html b/interfaces/_influxdata_influxdb-client-apis.CheckPatch.html index aaca202e..d89c1a27 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CheckPatch.html +++ b/interfaces/_influxdata_influxdb-client-apis.CheckPatch.html @@ -1,4 +1,4 @@ -CheckPatch | Documentation
    interface CheckPatch {
        description?: string;
        name?: string;
        status?: "active" | "inactive";
    }

    Properties

    description? +CheckPatch | Documentation
    interface CheckPatch {
        description?: string;
        name?: string;
        status?: "active" | "inactive";
    }

    Properties

    description?: string
    name?: string
    status?: "active" | "inactive"
    +

    Properties

    description?: string
    name?: string
    status?: "active" | "inactive"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CheckViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.CheckViewProperties.html index 28cf9ec6..342e54f0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CheckViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.CheckViewProperties.html @@ -1,4 +1,4 @@ -CheckViewProperties | Documentation
    interface CheckViewProperties {
        adaptiveZoomHide?: boolean;
        check?: CheckDiscriminator;
        checkID: string;
        colors: DashboardColor[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        type: "check";
    }

    Properties

    adaptiveZoomHide? +CheckViewProperties | Documentation
    interface CheckViewProperties {
        adaptiveZoomHide?: boolean;
        check?: CheckDiscriminator;
        checkID: string;
        colors: DashboardColor[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        type: "check";
    }

    Properties

    adaptiveZoomHide?: boolean
    checkID: string
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    type: "check"
    +

    Properties

    adaptiveZoomHide?: boolean
    checkID: string
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    +
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    type: "check"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Checks.html b/interfaces/_influxdata_influxdb-client-apis.Checks.html index 49a03a9c..674e09bd 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Checks.html +++ b/interfaces/_influxdata_influxdb-client-apis.Checks.html @@ -1,3 +1,3 @@ -Checks | Documentation
    interface Checks {
        checks?: CheckDiscriminator[];
        links?: Links;
    }

    Properties

    checks? +Checks | Documentation
    interface Checks {
        checks?: CheckDiscriminator[];
        links?: Links;
    }

    Properties

    Properties

    links?: Links
    +

    Properties

    links?: Links
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ConditionalExpression.html b/interfaces/_influxdata_influxdb-client-apis.ConditionalExpression.html index 2a4db241..263d4e3b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ConditionalExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.ConditionalExpression.html @@ -1,6 +1,6 @@ ConditionalExpression | Documentation

    Selects one of two expressions, Alternate or Consequent, depending on a third boolean expression, Test

    -
    interface ConditionalExpression {
        alternate?: Expression;
        consequent?: Expression;
        test?: Expression;
        type?: string;
    }

    Properties

    interface ConditionalExpression {
        alternate?: Expression;
        consequent?: Expression;
        test?: Expression;
        type?: string;
    }

    Properties

    alternate?: Expression
    consequent?: Expression
    test?: Expression
    type?: string
    +

    Properties

    alternate?: Expression
    consequent?: Expression
    test?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Config.html b/interfaces/_influxdata_influxdb-client-apis.Config.html index d0c7cdbc..a7152978 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Config.html +++ b/interfaces/_influxdata_influxdb-client-apis.Config.html @@ -1,2 +1,2 @@ -Config | Documentation
    interface Config {
        config?: any;
    }

    Properties

    Properties

    config?: any
    +Config | Documentation
    interface Config {
        config?: any;
    }

    Properties

    Properties

    config?: any
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ConstantVariableProperties.html b/interfaces/_influxdata_influxdb-client-apis.ConstantVariableProperties.html index 400f8ac0..fb7858bd 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ConstantVariableProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.ConstantVariableProperties.html @@ -1,3 +1,3 @@ -ConstantVariableProperties | Documentation
    interface ConstantVariableProperties {
        type?: "constant";
        values?: string[];
    }

    Properties

    type? +ConstantVariableProperties | Documentation
    interface ConstantVariableProperties {
        type?: "constant";
        values?: string[];
    }

    Properties

    Properties

    type?: "constant"
    values?: string[]
    +

    Properties

    type?: "constant"
    values?: string[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CreateCell.html b/interfaces/_influxdata_influxdb-client-apis.CreateCell.html index 4bc18bcd..075aac59 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CreateCell.html +++ b/interfaces/_influxdata_influxdb-client-apis.CreateCell.html @@ -1,8 +1,8 @@ -CreateCell | Documentation
    interface CreateCell {
        h?: number;
        name?: string;
        usingView?: string;
        w?: number;
        x?: number;
        y?: number;
    }

    Properties

    h? +CreateCell | Documentation
    interface CreateCell {
        h?: number;
        name?: string;
        usingView?: string;
        w?: number;
        x?: number;
        y?: number;
    }

    Properties

    Properties

    h?: number
    name?: string
    usingView?: string

    Makes a copy of the provided view.

    -
    w?: number
    x?: number
    y?: number
    +

    Properties

    h?: number
    name?: string
    usingView?: string

    Makes a copy of the provided view.

    +
    w?: number
    x?: number
    y?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CreateCheckRequest.html b/interfaces/_influxdata_influxdb-client-apis.CreateCheckRequest.html index fa0b1a7c..2d0119a4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CreateCheckRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.CreateCheckRequest.html @@ -1,3 +1,3 @@ -CreateCheckRequest | Documentation
    interface CreateCheckRequest {
        body: CheckDiscriminator;
    }

    Properties

    body +CreateCheckRequest | Documentation
    interface CreateCheckRequest {
        body: CheckDiscriminator;
    }

    Properties

    Properties

    Check to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CreateDashboardRequest.html b/interfaces/_influxdata_influxdb-client-apis.CreateDashboardRequest.html index 51268dab..55084817 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CreateDashboardRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.CreateDashboardRequest.html @@ -1,7 +1,7 @@ -CreateDashboardRequest | Documentation
    interface CreateDashboardRequest {
        description?: string;
        name: string;
        orgID: string;
    }

    Properties

    description? +CreateDashboardRequest | Documentation
    interface CreateDashboardRequest {
        description?: string;
        name: string;
        orgID: string;
    }

    Properties

    description?: string

    The user-facing description of the dashboard.

    -
    name: string

    The user-facing name of the dashboard.

    -
    orgID: string

    The ID of the organization that owns the dashboard.

    -
    +
    name: string

    The user-facing name of the dashboard.

    +
    orgID: string

    The ID of the organization that owns the dashboard.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CreateNotificationEndpointRequest.html b/interfaces/_influxdata_influxdb-client-apis.CreateNotificationEndpointRequest.html index e2ee7480..72bd5669 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CreateNotificationEndpointRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.CreateNotificationEndpointRequest.html @@ -1,3 +1,3 @@ -CreateNotificationEndpointRequest | Documentation
    interface CreateNotificationEndpointRequest {
        body: NotificationEndpointDiscriminator;
    }

    Properties

    body +CreateNotificationEndpointRequest | Documentation
    interface CreateNotificationEndpointRequest {
        body: NotificationEndpointDiscriminator;
    }

    Properties

    Properties

    Notification endpoint to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CreateNotificationRuleRequest.html b/interfaces/_influxdata_influxdb-client-apis.CreateNotificationRuleRequest.html index 84889f9f..5ade564e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CreateNotificationRuleRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.CreateNotificationRuleRequest.html @@ -1,3 +1,3 @@ -CreateNotificationRuleRequest | Documentation
    interface CreateNotificationRuleRequest {
        body: NotificationRuleDiscriminator;
    }

    Properties

    body +CreateNotificationRuleRequest | Documentation
    interface CreateNotificationRuleRequest {
        body: NotificationRuleDiscriminator;
    }

    Properties

    Properties

    Notification rule to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.CreateStackRequest.html b/interfaces/_influxdata_influxdb-client-apis.CreateStackRequest.html index a577dacd..ab1a7c64 100644 --- a/interfaces/_influxdata_influxdb-client-apis.CreateStackRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.CreateStackRequest.html @@ -1,3 +1,3 @@ -CreateStackRequest | Documentation
    interface CreateStackRequest {
        body: {
            description?: string;
            name?: string;
            orgID?: string;
            urls?: string[];
        };
    }

    Properties

    body +CreateStackRequest | Documentation
    interface CreateStackRequest {
        body: {
            description?: string;
            name?: string;
            orgID?: string;
            urls?: string[];
        };
    }

    Properties

    Properties

    body: { description?: string; name?: string; orgID?: string; urls?: string[] }

    The stack to create.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DBRP.html b/interfaces/_influxdata_influxdb-client-apis.DBRP.html index 7af83b5e..c3df76d5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DBRP.html +++ b/interfaces/_influxdata_influxdb-client-apis.DBRP.html @@ -1,4 +1,4 @@ -DBRP | Documentation
    interface DBRP {
        bucketID: string;
        database: string;
        default: boolean;
        id: string;
        links?: Links;
        orgID: string;
        retention_policy: string;
        virtual?: boolean;
    }

    Properties

    bucketID +DBRP | Documentation
    interface DBRP {
        bucketID: string;
        database: string;
        default: boolean;
        id: string;
        links?: Links;
        orgID: string;
        retention_policy: string;
        virtual?: boolean;
    }

    Properties

    Properties

    bucketID: string

    The ID of the bucket used as the target for the translation.

    -
    database: string

    InfluxDB v1 database

    -
    default: boolean

    Mapping represents the default retention policy for the database specified.

    -
    id: string

    The ID of the DBRP mapping.

    -
    links?: Links
    orgID: string

    The ID of the organization.

    -
    retention_policy: string

    InfluxDB v1 retention policy

    -
    virtual?: boolean

    Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS.

    -
    +
    database: string

    InfluxDB v1 database

    +
    default: boolean

    Mapping represents the default retention policy for the database specified.

    +
    id: string

    The ID of the DBRP mapping.

    +
    links?: Links
    orgID: string

    The ID of the organization.

    +
    retention_policy: string

    InfluxDB v1 retention policy

    +
    virtual?: boolean

    Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DBRPCreate.html b/interfaces/_influxdata_influxdb-client-apis.DBRPCreate.html index e4ea26e4..ce742686 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DBRPCreate.html +++ b/interfaces/_influxdata_influxdb-client-apis.DBRPCreate.html @@ -1,13 +1,13 @@ -DBRPCreate | Documentation
    interface DBRPCreate {
        bucketID: string;
        database: string;
        default?: boolean;
        org?: string;
        orgID?: string;
        retention_policy: string;
    }

    Properties

    bucketID +DBRPCreate | Documentation
    interface DBRPCreate {
        bucketID: string;
        database: string;
        default?: boolean;
        org?: string;
        orgID?: string;
        retention_policy: string;
    }

    Properties

    bucketID: string

    The ID of the bucket used as the target for the translation.

    -
    database: string

    InfluxDB v1 database

    -
    default?: boolean

    Mapping represents the default retention policy for the database specified.

    -
    org?: string

    The name of the organization that owns this mapping.

    -
    orgID?: string

    The ID of the organization.

    -
    retention_policy: string

    InfluxDB v1 retention policy

    -
    +
    database: string

    InfluxDB v1 database

    +
    default?: boolean

    Mapping represents the default retention policy for the database specified.

    +
    org?: string

    The name of the organization that owns this mapping.

    +
    orgID?: string

    The ID of the organization.

    +
    retention_policy: string

    InfluxDB v1 retention policy

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DBRPGet.html b/interfaces/_influxdata_influxdb-client-apis.DBRPGet.html index fd8f465b..43a21c50 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DBRPGet.html +++ b/interfaces/_influxdata_influxdb-client-apis.DBRPGet.html @@ -1,2 +1,2 @@ -DBRPGet | Documentation
    interface DBRPGet {
        content?: DBRP;
    }

    Properties

    Properties

    content?: DBRP
    +DBRPGet | Documentation
    interface DBRPGet {
        content?: DBRP;
    }

    Properties

    Properties

    content?: DBRP
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DBRPUpdate.html b/interfaces/_influxdata_influxdb-client-apis.DBRPUpdate.html index 69571c37..26abfd85 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DBRPUpdate.html +++ b/interfaces/_influxdata_influxdb-client-apis.DBRPUpdate.html @@ -1,4 +1,4 @@ -DBRPUpdate | Documentation
    interface DBRPUpdate {
        default?: boolean;
        retention_policy?: string;
    }

    Properties

    default? +DBRPUpdate | Documentation
    interface DBRPUpdate {
        default?: boolean;
        retention_policy?: string;
    }

    Properties

    default?: boolean
    retention_policy?: string

    InfluxDB v1 retention policy

    -
    +

    Properties

    default?: boolean
    retention_policy?: string

    InfluxDB v1 retention policy

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DBRPs.html b/interfaces/_influxdata_influxdb-client-apis.DBRPs.html index 1653c121..022f5d23 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DBRPs.html +++ b/interfaces/_influxdata_influxdb-client-apis.DBRPs.html @@ -1,2 +1,2 @@ -DBRPs | Documentation
    interface DBRPs {
        content?: DBRP[];
    }

    Properties

    Properties

    content?: DBRP[]
    +DBRPs | Documentation
    interface DBRPs {
        content?: DBRP[];
    }

    Properties

    Properties

    content?: DBRP[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DashboardColor.html b/interfaces/_influxdata_influxdb-client-apis.DashboardColor.html index d161f01b..c257c418 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DashboardColor.html +++ b/interfaces/_influxdata_influxdb-client-apis.DashboardColor.html @@ -1,12 +1,12 @@ DashboardColor | Documentation

    Defines an encoding of data value into color space.

    -
    interface DashboardColor {
        hex: string;
        id: string;
        name: string;
        type: "text" | "min" | "max" | "threshold" | "scale" | "background";
        value: number;
    }

    Properties

    hex +
    interface DashboardColor {
        hex: string;
        id: string;
        name: string;
        type: "text" | "min" | "max" | "threshold" | "scale" | "background";
        value: number;
    }

    Properties

    Properties

    hex: string

    The hex number of the color

    -
    id: string

    The unique ID of the view color.

    -
    name: string

    The user-facing name of the hex color.

    -
    type: "text" | "min" | "max" | "threshold" | "scale" | "background"

    Type is how the color is used.

    -
    value: number

    The data value mapped to this color.

    -
    +
    id: string

    The unique ID of the view color.

    +
    name: string

    The user-facing name of the hex color.

    +
    type: "text" | "min" | "max" | "threshold" | "scale" | "background"

    Type is how the color is used.

    +
    value: number

    The data value mapped to this color.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DashboardQuery.html b/interfaces/_influxdata_influxdb-client-apis.DashboardQuery.html index 7d3e98c0..5c40eaf4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DashboardQuery.html +++ b/interfaces/_influxdata_influxdb-client-apis.DashboardQuery.html @@ -1,6 +1,6 @@ -DashboardQuery | Documentation
    interface DashboardQuery {
        builderConfig?: BuilderConfig;
        editMode?: QueryEditMode;
        name?: string;
        text?: string;
    }

    Properties

    builderConfig? +DashboardQuery | Documentation
    interface DashboardQuery {
        builderConfig?: BuilderConfig;
        editMode?: QueryEditMode;
        name?: string;
        text?: string;
    }

    Properties

    builderConfig?: BuilderConfig
    editMode?: QueryEditMode
    name?: string
    text?: string

    The text of the Flux query.

    -
    +

    Properties

    builderConfig?: BuilderConfig
    editMode?: QueryEditMode
    name?: string
    text?: string

    The text of the Flux query.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Dashboards.html b/interfaces/_influxdata_influxdb-client-apis.Dashboards.html index 4483483e..87dbedaa 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Dashboards.html +++ b/interfaces/_influxdata_influxdb-client-apis.Dashboards.html @@ -1,3 +1,3 @@ -Dashboards | Documentation
    interface Dashboards {
        dashboards?: Dashboard[];
        links?: Links;
    }

    Properties

    dashboards? +Dashboards | Documentation
    interface Dashboards {
        dashboards?: Dashboard[];
        links?: Links;
    }

    Properties

    Properties

    dashboards?: Dashboard[]
    links?: Links
    +

    Properties

    dashboards?: Dashboard[]
    links?: Links
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DateTimeLiteral.html b/interfaces/_influxdata_influxdb-client-apis.DateTimeLiteral.html index 689a9f4a..0c929ce8 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DateTimeLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.DateTimeLiteral.html @@ -1,4 +1,4 @@ DateTimeLiteral | Documentation

    Represents an instant in time with nanosecond precision in RFC3339Nano date/time format.

    -
    interface DateTimeLiteral {
        type?: string;
        value?: string;
    }

    Properties

    interface DateTimeLiteral {
        type?: string;
        value?: string;
    }

    Properties

    Properties

    type?: string
    value?: string
    +

    Properties

    type?: string
    value?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DecimalPlaces.html b/interfaces/_influxdata_influxdb-client-apis.DecimalPlaces.html index 0f2a8be8..b14a9db5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DecimalPlaces.html +++ b/interfaces/_influxdata_influxdb-client-apis.DecimalPlaces.html @@ -1,6 +1,6 @@ DecimalPlaces | Documentation

    Indicates whether decimal places should be enforced, and how many digits it should show.

    -
    interface DecimalPlaces {
        digits?: number;
        isEnforced?: boolean;
    }

    Properties

    interface DecimalPlaces {
        digits?: number;
        isEnforced?: boolean;
    }

    Properties

    Properties

    digits?: number

    The number of digits after decimal to display

    -
    isEnforced?: boolean

    Indicates whether decimal point setting should be enforced

    -
    +
    isEnforced?: boolean

    Indicates whether decimal point setting should be enforced

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteAuthorizationsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteAuthorizationsIDRequest.html index aba0c74c..e7a27ca7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteAuthorizationsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteAuthorizationsIDRequest.html @@ -1,3 +1,3 @@ -DeleteAuthorizationsIDRequest | Documentation
    interface DeleteAuthorizationsIDRequest {
        authID: string;
    }

    Properties

    authID +DeleteAuthorizationsIDRequest | Documentation
    interface DeleteAuthorizationsIDRequest {
        authID: string;
    }

    Properties

    Properties

    authID: string

    The ID of the authorization to delete.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDLabelsIDRequest.html index be9ca3b7..046c901b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteBucketsIDLabelsIDRequest | Documentation
    interface DeleteBucketsIDLabelsIDRequest {
        bucketID: string;
        labelID: string;
    }

    Properties

    bucketID +DeleteBucketsIDLabelsIDRequest | Documentation
    interface DeleteBucketsIDLabelsIDRequest {
        bucketID: string;
        labelID: string;
    }

    Properties

    Properties

    bucketID: string

    The bucket ID.

    -
    labelID: string

    The ID of the label to delete.

    -
    +
    labelID: string

    The ID of the label to delete.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDMembersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDMembersIDRequest.html index 4c808683..6515639d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDMembersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDMembersIDRequest.html @@ -1,5 +1,5 @@ -DeleteBucketsIDMembersIDRequest | Documentation
    interface DeleteBucketsIDMembersIDRequest {
        bucketID: string;
        userID: string;
    }

    Properties

    bucketID +DeleteBucketsIDMembersIDRequest | Documentation
    interface DeleteBucketsIDMembersIDRequest {
        bucketID: string;
        userID: string;
    }

    Properties

    Properties

    bucketID: string

    The ID of the bucket to remove a user from.

    -
    userID: string

    The ID of the user to remove.

    -
    +
    userID: string

    The ID of the user to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDOwnersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDOwnersIDRequest.html index 651d7ba7..0ef660da 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDOwnersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDOwnersIDRequest.html @@ -1,5 +1,5 @@ -DeleteBucketsIDOwnersIDRequest | Documentation
    interface DeleteBucketsIDOwnersIDRequest {
        bucketID: string;
        userID: string;
    }

    Properties

    bucketID +DeleteBucketsIDOwnersIDRequest | Documentation
    interface DeleteBucketsIDOwnersIDRequest {
        bucketID: string;
        userID: string;
    }

    Properties

    Properties

    bucketID: string

    The bucket ID.

    -
    userID: string

    The ID of the owner to remove.

    -
    +
    userID: string

    The ID of the owner to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDRequest.html index 45b211b1..fc82cb2c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteBucketsIDRequest.html @@ -1,4 +1,4 @@ -DeleteBucketsIDRequest | Documentation
    interface DeleteBucketsIDRequest {
        bucketID: string;
    }

    Properties

    bucketID +DeleteBucketsIDRequest | Documentation
    interface DeleteBucketsIDRequest {
        bucketID: string;
    }

    Properties

    Properties

    bucketID: string

    Bucket ID. The ID of the bucket to delete.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDLabelsIDRequest.html index eee28a09..f60cb736 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteChecksIDLabelsIDRequest | Documentation
    interface DeleteChecksIDLabelsIDRequest {
        checkID: string;
        labelID: string;
    }

    Properties

    checkID +DeleteChecksIDLabelsIDRequest | Documentation
    interface DeleteChecksIDLabelsIDRequest {
        checkID: string;
        labelID: string;
    }

    Properties

    Properties

    checkID: string

    The check ID.

    -
    labelID: string

    The ID of the label to delete.

    -
    +
    labelID: string

    The ID of the label to delete.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDRequest.html index 8334789a..546ce9f4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteChecksIDRequest.html @@ -1,3 +1,3 @@ -DeleteChecksIDRequest | Documentation
    interface DeleteChecksIDRequest {
        checkID: string;
    }

    Properties

    checkID +DeleteChecksIDRequest | Documentation
    interface DeleteChecksIDRequest {
        checkID: string;
    }

    Properties

    Properties

    checkID: string

    The check ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteDBRPIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteDBRPIDRequest.html index 17929e2f..8517f3ab 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteDBRPIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteDBRPIDRequest.html @@ -1,7 +1,7 @@ -DeleteDBRPIDRequest | Documentation
    interface DeleteDBRPIDRequest {
        dbrpID: string;
        org?: string;
        orgID?: string;
    }

    Properties

    dbrpID +DeleteDBRPIDRequest | Documentation
    interface DeleteDBRPIDRequest {
        dbrpID: string;
        org?: string;
        orgID?: string;
    }

    Properties

    Properties

    dbrpID: string

    The database retention policy mapping

    -
    org?: string

    Specifies the organization name of the mapping

    -
    orgID?: string

    Specifies the organization ID of the mapping

    -
    +
    org?: string

    Specifies the organization name of the mapping

    +
    orgID?: string

    Specifies the organization ID of the mapping

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDCellsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDCellsIDRequest.html index 9832f7f2..32e599a7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDCellsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDCellsIDRequest.html @@ -1,5 +1,5 @@ -DeleteDashboardsIDCellsIDRequest | Documentation
    interface DeleteDashboardsIDCellsIDRequest {
        cellID: string;
        dashboardID: string;
    }

    Properties

    cellID +DeleteDashboardsIDCellsIDRequest | Documentation
    interface DeleteDashboardsIDCellsIDRequest {
        cellID: string;
        dashboardID: string;
    }

    Properties

    Properties

    cellID: string

    The ID of the cell to delete.

    -
    dashboardID: string

    The ID of the dashboard to delete.

    -
    +
    dashboardID: string

    The ID of the dashboard to delete.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDLabelsIDRequest.html index 9ed6b5c9..2eb2cfb6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteDashboardsIDLabelsIDRequest | Documentation
    interface DeleteDashboardsIDLabelsIDRequest {
        dashboardID: string;
        labelID: string;
    }

    Properties

    dashboardID +DeleteDashboardsIDLabelsIDRequest | Documentation
    interface DeleteDashboardsIDLabelsIDRequest {
        dashboardID: string;
        labelID: string;
    }

    Properties

    Properties

    dashboardID: string

    The dashboard ID.

    -
    labelID: string

    The ID of the label to delete.

    -
    +
    labelID: string

    The ID of the label to delete.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDMembersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDMembersIDRequest.html index 2cff3b4d..837b0a88 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDMembersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDMembersIDRequest.html @@ -1,5 +1,5 @@ -DeleteDashboardsIDMembersIDRequest | Documentation
    interface DeleteDashboardsIDMembersIDRequest {
        dashboardID: string;
        userID: string;
    }

    Properties

    dashboardID +DeleteDashboardsIDMembersIDRequest | Documentation
    interface DeleteDashboardsIDMembersIDRequest {
        dashboardID: string;
        userID: string;
    }

    Properties

    Properties

    dashboardID: string

    The dashboard ID.

    -
    userID: string

    The ID of the member to remove.

    -
    +
    userID: string

    The ID of the member to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDOwnersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDOwnersIDRequest.html index 2914886c..a4f2d45f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDOwnersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDOwnersIDRequest.html @@ -1,5 +1,5 @@ -DeleteDashboardsIDOwnersIDRequest | Documentation
    interface DeleteDashboardsIDOwnersIDRequest {
        dashboardID: string;
        userID: string;
    }

    Properties

    dashboardID +DeleteDashboardsIDOwnersIDRequest | Documentation
    interface DeleteDashboardsIDOwnersIDRequest {
        dashboardID: string;
        userID: string;
    }

    Properties

    Properties

    dashboardID: string

    The dashboard ID.

    -
    userID: string

    The ID of the owner to remove.

    -
    +
    userID: string

    The ID of the owner to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDRequest.html index c7e66f1b..1fd68bd7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteDashboardsIDRequest.html @@ -1,3 +1,3 @@ -DeleteDashboardsIDRequest | Documentation
    interface DeleteDashboardsIDRequest {
        dashboardID: string;
    }

    Properties

    dashboardID +DeleteDashboardsIDRequest | Documentation
    interface DeleteDashboardsIDRequest {
        dashboardID: string;
    }

    Properties

    Properties

    dashboardID: string

    The ID of the dashboard to update.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteLabelsIDRequest.html index 2f4eb1e7..94427bd5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteLabelsIDRequest.html @@ -1,3 +1,3 @@ -DeleteLabelsIDRequest | Documentation
    interface DeleteLabelsIDRequest {
        labelID: string;
    }

    Properties

    labelID +DeleteLabelsIDRequest | Documentation
    interface DeleteLabelsIDRequest {
        labelID: string;
    }

    Properties

    Properties

    labelID: string

    The ID of the label to delete.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDLabelsIDRequest.html index 90fbd85d..78e1638d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteNotificationEndpointsIDLabelsIDRequest | Documentation
    interface DeleteNotificationEndpointsIDLabelsIDRequest {
        endpointID: string;
        labelID: string;
    }

    Properties

    endpointID +DeleteNotificationEndpointsIDLabelsIDRequest | Documentation
    interface DeleteNotificationEndpointsIDLabelsIDRequest {
        endpointID: string;
        labelID: string;
    }

    Properties

    Properties

    endpointID: string

    The notification endpoint ID.

    -
    labelID: string

    The ID of the label to delete.

    -
    +
    labelID: string

    The ID of the label to delete.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDRequest.html index fed564eb..7e123252 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationEndpointsIDRequest.html @@ -1,3 +1,3 @@ -DeleteNotificationEndpointsIDRequest | Documentation
    interface DeleteNotificationEndpointsIDRequest {
        endpointID: string;
    }

    Properties

    endpointID +DeleteNotificationEndpointsIDRequest | Documentation
    interface DeleteNotificationEndpointsIDRequest {
        endpointID: string;
    }

    Properties

    Properties

    endpointID: string

    The notification endpoint ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDLabelsIDRequest.html index 9183a7d2..e1af24d3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteNotificationRulesIDLabelsIDRequest | Documentation
    interface DeleteNotificationRulesIDLabelsIDRequest {
        labelID: string;
        ruleID: string;
    }

    Properties

    labelID +DeleteNotificationRulesIDLabelsIDRequest | Documentation
    interface DeleteNotificationRulesIDLabelsIDRequest {
        labelID: string;
        ruleID: string;
    }

    Properties

    Properties

    labelID: string

    The ID of the label to delete.

    -
    ruleID: string

    The notification rule ID.

    -
    +
    ruleID: string

    The notification rule ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDRequest.html index 8a01d748..9f539685 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteNotificationRulesIDRequest.html @@ -1,3 +1,3 @@ -DeleteNotificationRulesIDRequest | Documentation
    interface DeleteNotificationRulesIDRequest {
        ruleID: string;
    }

    Properties

    ruleID +DeleteNotificationRulesIDRequest | Documentation
    interface DeleteNotificationRulesIDRequest {
        ruleID: string;
    }

    Properties

    Properties

    ruleID: string

    The notification rule ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDMembersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDMembersIDRequest.html index 0143d1ef..b2051c39 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDMembersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDMembersIDRequest.html @@ -1,5 +1,5 @@ -DeleteOrgsIDMembersIDRequest | Documentation
    interface DeleteOrgsIDMembersIDRequest {
        orgID: string;
        userID: string;
    }

    Properties

    orgID +DeleteOrgsIDMembersIDRequest | Documentation
    interface DeleteOrgsIDMembersIDRequest {
        orgID: string;
        userID: string;
    }

    Properties

    Properties

    orgID: string

    The ID of the organization to remove a user from.

    -
    userID: string

    The ID of the user to remove.

    -
    +
    userID: string

    The ID of the user to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDOwnersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDOwnersIDRequest.html index ea22c5fe..824fc3e7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDOwnersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDOwnersIDRequest.html @@ -1,5 +1,5 @@ -DeleteOrgsIDOwnersIDRequest | Documentation
    interface DeleteOrgsIDOwnersIDRequest {
        orgID: string;
        userID: string;
    }

    Properties

    orgID +DeleteOrgsIDOwnersIDRequest | Documentation
    interface DeleteOrgsIDOwnersIDRequest {
        orgID: string;
        userID: string;
    }

    Properties

    Properties

    orgID: string

    The ID of the organization to remove an owner from.

    -
    userID: string

    The ID of the user to remove.

    -
    +
    userID: string

    The ID of the user to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDRequest.html index f3b610da..13fdf8af 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDRequest.html @@ -1,3 +1,3 @@ -DeleteOrgsIDRequest | Documentation
    interface DeleteOrgsIDRequest {
        orgID: string;
    }

    Properties

    orgID +DeleteOrgsIDRequest | Documentation
    interface DeleteOrgsIDRequest {
        orgID: string;
    }

    Properties

    Properties

    orgID: string

    The ID of the organization to delete.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDSecretsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDSecretsIDRequest.html index 04185fa4..01e3fd4c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDSecretsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteOrgsIDSecretsIDRequest.html @@ -1,5 +1,5 @@ -DeleteOrgsIDSecretsIDRequest | Documentation
    interface DeleteOrgsIDSecretsIDRequest {
        orgID: string;
        secretID: string;
    }

    Properties

    orgID +DeleteOrgsIDSecretsIDRequest | Documentation
    interface DeleteOrgsIDSecretsIDRequest {
        orgID: string;
        secretID: string;
    }

    Properties

    Properties

    orgID: string

    The organization ID.

    -
    secretID: string

    The secret ID.

    -
    +
    secretID: string

    The secret ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeletePredicateRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeletePredicateRequest.html index 75c3ef25..cad25efa 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeletePredicateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeletePredicateRequest.html @@ -1,10 +1,10 @@ DeletePredicateRequest | Documentation

    The delete predicate request.

    -
    interface DeletePredicateRequest {
        predicate?: string;
        start: string;
        stop: string;
    }

    Properties

    interface DeletePredicateRequest {
        predicate?: string;
        start: string;
        stop: string;
    }

    Properties

    Properties

    predicate?: string

    An expression in delete predicate syntax.

    -
    start: string

    A timestamp (RFC3339 date/time format). +

    start: string

    A timestamp (RFC3339 date/time format). The earliest time to delete from.

    -
    stop: string

    A timestamp (RFC3339 date/time format). +

    stop: string

    A timestamp (RFC3339 date/time format). The latest time to delete from.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteRemoteConnectionByIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteRemoteConnectionByIDRequest.html index 2a11c286..a5e3ce58 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteRemoteConnectionByIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteRemoteConnectionByIDRequest.html @@ -1,2 +1,2 @@ -DeleteRemoteConnectionByIDRequest | Documentation
    interface DeleteRemoteConnectionByIDRequest {
        remoteID: string;
    }

    Properties

    Properties

    remoteID: string
    +DeleteRemoteConnectionByIDRequest | Documentation
    interface DeleteRemoteConnectionByIDRequest {
        remoteID: string;
    }

    Properties

    Properties

    remoteID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteReplicationByIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteReplicationByIDRequest.html index aefd71b9..0b2e5b34 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteReplicationByIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteReplicationByIDRequest.html @@ -1,2 +1,2 @@ -DeleteReplicationByIDRequest | Documentation
    interface DeleteReplicationByIDRequest {
        replicationID: string;
    }

    Properties

    Properties

    replicationID: string
    +DeleteReplicationByIDRequest | Documentation
    interface DeleteReplicationByIDRequest {
        replicationID: string;
    }

    Properties

    Properties

    replicationID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDLabelsIDRequest.html index 39de4cad..76315da5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteScrapersIDLabelsIDRequest | Documentation
    interface DeleteScrapersIDLabelsIDRequest {
        labelID: string;
        scraperTargetID: string;
    }

    Properties

    labelID +DeleteScrapersIDLabelsIDRequest | Documentation
    interface DeleteScrapersIDLabelsIDRequest {
        labelID: string;
        scraperTargetID: string;
    }

    Properties

    labelID: string

    The label ID.

    -
    scraperTargetID: string

    The scraper target ID.

    -
    +
    scraperTargetID: string

    The scraper target ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDMembersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDMembersIDRequest.html index 70e4d5d1..58f1352f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDMembersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDMembersIDRequest.html @@ -1,5 +1,5 @@ -DeleteScrapersIDMembersIDRequest | Documentation
    interface DeleteScrapersIDMembersIDRequest {
        scraperTargetID: string;
        userID: string;
    }

    Properties

    scraperTargetID +DeleteScrapersIDMembersIDRequest | Documentation
    interface DeleteScrapersIDMembersIDRequest {
        scraperTargetID: string;
        userID: string;
    }

    Properties

    scraperTargetID: string

    The scraper target ID.

    -
    userID: string

    The ID of member to remove.

    -
    +
    userID: string

    The ID of member to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDOwnersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDOwnersIDRequest.html index 8c960125..f4eb9d9f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDOwnersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDOwnersIDRequest.html @@ -1,5 +1,5 @@ -DeleteScrapersIDOwnersIDRequest | Documentation
    interface DeleteScrapersIDOwnersIDRequest {
        scraperTargetID: string;
        userID: string;
    }

    Properties

    scraperTargetID +DeleteScrapersIDOwnersIDRequest | Documentation
    interface DeleteScrapersIDOwnersIDRequest {
        scraperTargetID: string;
        userID: string;
    }

    Properties

    scraperTargetID: string

    The scraper target ID.

    -
    userID: string

    The ID of owner to remove.

    -
    +
    userID: string

    The ID of owner to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDRequest.html index 3fe8bb47..6f298d96 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteScrapersIDRequest.html @@ -1,3 +1,3 @@ -DeleteScrapersIDRequest | Documentation
    interface DeleteScrapersIDRequest {
        scraperTargetID: string;
    }

    Properties

    scraperTargetID +DeleteScrapersIDRequest | Documentation
    interface DeleteScrapersIDRequest {
        scraperTargetID: string;
    }

    Properties

    Properties

    scraperTargetID: string

    The identifier of the scraper target.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteScriptsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteScriptsIDRequest.html index efa99f4f..2001d68a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteScriptsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteScriptsIDRequest.html @@ -1,4 +1,4 @@ -DeleteScriptsIDRequest | Documentation
    interface DeleteScriptsIDRequest {
        scriptID: string;
    }

    Properties

    scriptID +DeleteScriptsIDRequest | Documentation
    interface DeleteScriptsIDRequest {
        scriptID: string;
    }

    Properties

    Properties

    scriptID: string

    A script ID. Specifies the script to delete.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteSourcesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteSourcesIDRequest.html index a7fc8c54..90690976 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteSourcesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteSourcesIDRequest.html @@ -1,3 +1,3 @@ -DeleteSourcesIDRequest | Documentation
    interface DeleteSourcesIDRequest {
        sourceID: string;
    }

    Properties

    sourceID +DeleteSourcesIDRequest | Documentation
    interface DeleteSourcesIDRequest {
        sourceID: string;
    }

    Properties

    Properties

    sourceID: string

    The source ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteStackRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteStackRequest.html index cc601830..77cacde9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteStackRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteStackRequest.html @@ -1,5 +1,5 @@ -DeleteStackRequest | Documentation
    interface DeleteStackRequest {
        orgID: string;
        stack_id: string;
    }

    Properties

    orgID +DeleteStackRequest | Documentation
    interface DeleteStackRequest {
        orgID: string;
        stack_id: string;
    }

    Properties

    Properties

    orgID: string

    The identifier of the organization.

    -
    stack_id: string

    The identifier of the stack.

    -
    +
    stack_id: string

    The identifier of the stack.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDLabelsIDRequest.html index 762f31d0..8b91583a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteTasksIDLabelsIDRequest | Documentation
    interface DeleteTasksIDLabelsIDRequest {
        labelID: string;
        taskID: string;
    }

    Properties

    labelID +DeleteTasksIDLabelsIDRequest | Documentation
    interface DeleteTasksIDLabelsIDRequest {
        labelID: string;
        taskID: string;
    }

    Properties

    Properties

    labelID: string

    The ID of the label to delete.

    -
    taskID: string

    The ID of the task to delete the label from.

    -
    +
    taskID: string

    The ID of the task to delete the label from.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDMembersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDMembersIDRequest.html index cfcdbfac..c45738bc 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDMembersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDMembersIDRequest.html @@ -1,5 +1,5 @@ -DeleteTasksIDMembersIDRequest | Documentation
    interface DeleteTasksIDMembersIDRequest {
        taskID: string;
        userID: string;
    }

    Properties

    taskID +DeleteTasksIDMembersIDRequest | Documentation
    interface DeleteTasksIDMembersIDRequest {
        taskID: string;
        userID: string;
    }

    Properties

    Properties

    taskID: string

    The task ID.

    -
    userID: string

    The ID of the member to remove.

    -
    +
    userID: string

    The ID of the member to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDOwnersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDOwnersIDRequest.html index e9f6aa1a..e37d4b13 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDOwnersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDOwnersIDRequest.html @@ -1,5 +1,5 @@ -DeleteTasksIDOwnersIDRequest | Documentation
    interface DeleteTasksIDOwnersIDRequest {
        taskID: string;
        userID: string;
    }

    Properties

    taskID +DeleteTasksIDOwnersIDRequest | Documentation
    interface DeleteTasksIDOwnersIDRequest {
        taskID: string;
        userID: string;
    }

    Properties

    Properties

    taskID: string

    The task ID.

    -
    userID: string

    The ID of the owner to remove.

    -
    +
    userID: string

    The ID of the owner to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRequest.html index 2a66d724..dd915c48 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRequest.html @@ -1,3 +1,3 @@ -DeleteTasksIDRequest | Documentation
    interface DeleteTasksIDRequest {
        taskID: string;
    }

    Properties

    taskID +DeleteTasksIDRequest | Documentation
    interface DeleteTasksIDRequest {
        taskID: string;
    }

    Properties

    Properties

    taskID: string

    The ID of the task to delete.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRunsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRunsIDRequest.html index 5290af5e..2fa876c3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRunsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTasksIDRunsIDRequest.html @@ -1,5 +1,5 @@ -DeleteTasksIDRunsIDRequest | Documentation
    interface DeleteTasksIDRunsIDRequest {
        runID: string;
        taskID: string;
    }

    Properties

    runID +DeleteTasksIDRunsIDRequest | Documentation
    interface DeleteTasksIDRunsIDRequest {
        runID: string;
        taskID: string;
    }

    Properties

    Properties

    runID: string

    The ID of the task run to cancel.

    -
    taskID: string

    The ID of the task to cancel.

    -
    +
    taskID: string

    The ID of the task to cancel.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDLabelsIDRequest.html index e87487ff..8ce14012 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteTelegrafsIDLabelsIDRequest | Documentation
    interface DeleteTelegrafsIDLabelsIDRequest {
        labelID: string;
        telegrafID: string;
    }

    Properties

    labelID +DeleteTelegrafsIDLabelsIDRequest | Documentation
    interface DeleteTelegrafsIDLabelsIDRequest {
        labelID: string;
        telegrafID: string;
    }

    Properties

    Properties

    labelID: string

    The label ID.

    -
    telegrafID: string

    The Telegraf config ID.

    -
    +
    telegrafID: string

    The Telegraf config ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDMembersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDMembersIDRequest.html index 9ff93568..8e17bb25 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDMembersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDMembersIDRequest.html @@ -1,5 +1,5 @@ -DeleteTelegrafsIDMembersIDRequest | Documentation
    interface DeleteTelegrafsIDMembersIDRequest {
        telegrafID: string;
        userID: string;
    }

    Properties

    telegrafID +DeleteTelegrafsIDMembersIDRequest | Documentation
    interface DeleteTelegrafsIDMembersIDRequest {
        telegrafID: string;
        userID: string;
    }

    Properties

    Properties

    telegrafID: string

    The Telegraf config ID.

    -
    userID: string

    The ID of the member to remove.

    -
    +
    userID: string

    The ID of the member to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDOwnersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDOwnersIDRequest.html index d0669337..cb3bb46d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDOwnersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDOwnersIDRequest.html @@ -1,5 +1,5 @@ -DeleteTelegrafsIDOwnersIDRequest | Documentation
    interface DeleteTelegrafsIDOwnersIDRequest {
        telegrafID: string;
        userID: string;
    }

    Properties

    telegrafID +DeleteTelegrafsIDOwnersIDRequest | Documentation
    interface DeleteTelegrafsIDOwnersIDRequest {
        telegrafID: string;
        userID: string;
    }

    Properties

    Properties

    telegrafID: string

    The Telegraf config ID.

    -
    userID: string

    The ID of the owner to remove.

    -
    +
    userID: string

    The ID of the owner to remove.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDRequest.html index f658a185..91300b2b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteTelegrafsIDRequest.html @@ -1,3 +1,3 @@ -DeleteTelegrafsIDRequest | Documentation
    interface DeleteTelegrafsIDRequest {
        telegrafID: string;
    }

    Properties

    telegrafID +DeleteTelegrafsIDRequest | Documentation
    interface DeleteTelegrafsIDRequest {
        telegrafID: string;
    }

    Properties

    Properties

    telegrafID: string

    The Telegraf configuration ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteUsersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteUsersIDRequest.html index 76d4a97f..32238b52 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteUsersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteUsersIDRequest.html @@ -1,3 +1,3 @@ -DeleteUsersIDRequest | Documentation
    interface DeleteUsersIDRequest {
        userID: string;
    }

    Properties

    userID +DeleteUsersIDRequest | Documentation
    interface DeleteUsersIDRequest {
        userID: string;
    }

    Properties

    Properties

    userID: string

    The ID of the user to delete.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDLabelsIDRequest.html index 61372ae8..0ee23b66 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDLabelsIDRequest.html @@ -1,5 +1,5 @@ -DeleteVariablesIDLabelsIDRequest | Documentation
    interface DeleteVariablesIDLabelsIDRequest {
        labelID: string;
        variableID: string;
    }

    Properties

    labelID +DeleteVariablesIDLabelsIDRequest | Documentation
    interface DeleteVariablesIDLabelsIDRequest {
        labelID: string;
        variableID: string;
    }

    Properties

    Properties

    labelID: string

    The label ID to delete.

    -
    variableID: string

    The variable ID.

    -
    +
    variableID: string

    The variable ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDRequest.html index f1f8a1cd..199b2955 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.DeleteVariablesIDRequest.html @@ -1,3 +1,3 @@ -DeleteVariablesIDRequest | Documentation
    interface DeleteVariablesIDRequest {
        variableID: string;
    }

    Properties

    variableID +DeleteVariablesIDRequest | Documentation
    interface DeleteVariablesIDRequest {
        variableID: string;
    }

    Properties

    Properties

    variableID: string

    The variable ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Dialect.html b/interfaces/_influxdata_influxdb-client-apis.Dialect.html index 12075fb2..7e6c7406 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Dialect.html +++ b/interfaces/_influxdata_influxdb-client-apis.Dialect.html @@ -2,7 +2,7 @@ Default output is annotated CSV with headers.

    For more information about tabular data dialect, see W3 metadata vocabulary for tabular data.

    -
    interface Dialect {
        annotations?: ("default" | "group" | "datatype")[];
        commentPrefix?: string;
        dateTimeFormat?: "RFC3339" | "RFC3339Nano";
        delimiter?: string;
        header?: boolean;
    }

    Properties

    interface Dialect {
        annotations?: ("default" | "group" | "datatype")[];
        commentPrefix?: string;
        dateTimeFormat?: "RFC3339" | "RFC3339Nano";
        delimiter?: string;
        header?: boolean;
    }

    Properties

    annotations? commentPrefix? dateTimeFormat? delimiter? @@ -14,8 +14,8 @@

    For more information about annotations in tabular data, see W3 metadata vocabulary for tabular data.

    -
    commentPrefix?: string

    The character prefixed to comment strings. Default is a number sign (#).

    -
    dateTimeFormat?: "RFC3339" | "RFC3339Nano"

    The format for timestamps in results. +

    commentPrefix?: string

    The character prefixed to comment strings. Default is a number sign (#).

    +
    dateTimeFormat?: "RFC3339" | "RFC3339Nano"

    The format for timestamps in results. Default is RFC3339 date/time format. To include nanoseconds in timestamps, use RFC3339Nano.

    @@ -36,6 +36,6 @@
    -
    delimiter?: string

    The separator used between cells. Default is a comma (,).

    -
    header?: boolean

    If true, the results contain a header row.

    -
    +
    delimiter?: string

    The separator used between cells. Default is a comma (,).

    +
    header?: boolean

    If true, the results contain a header row.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DictExpression.html b/interfaces/_influxdata_influxdb-client-apis.DictExpression.html index 4d2cdba0..9ec4125b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DictExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.DictExpression.html @@ -1,5 +1,5 @@ DictExpression | Documentation

    Used to create and directly specify the elements of a dictionary

    -
    interface DictExpression {
        elements?: DictItem[];
        type?: string;
    }

    Properties

    interface DictExpression {
        elements?: DictItem[];
        type?: string;
    }

    Properties

    Properties

    elements?: DictItem[]

    Elements of the dictionary

    -
    type?: string
    +
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DictItem.html b/interfaces/_influxdata_influxdb-client-apis.DictItem.html index e9656024..32be465f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DictItem.html +++ b/interfaces/_influxdata_influxdb-client-apis.DictItem.html @@ -1,5 +1,5 @@ DictItem | Documentation

    A key-value pair in a dictionary.

    -
    interface DictItem {
        key?: Expression;
        type?: string;
        val?: Expression;
    }

    Properties

    interface DictItem {
        key?: Expression;
        type?: string;
        val?: Expression;
    }

    Properties

    Properties

    type?: string
    +

    Properties

    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Duration.html b/interfaces/_influxdata_influxdb-client-apis.Duration.html index adadab9a..d44f082e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Duration.html +++ b/interfaces/_influxdata_influxdb-client-apis.Duration.html @@ -1,5 +1,5 @@ Duration | Documentation

    A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed.

    -
    interface Duration {
        magnitude?: number;
        type?: string;
        unit?: string;
    }

    Properties

    interface Duration {
        magnitude?: number;
        type?: string;
        unit?: string;
    }

    Properties

    Properties

    magnitude?: number
    type?: string
    unit?: string
    +

    Properties

    magnitude?: number
    type?: string
    unit?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.DurationLiteral.html b/interfaces/_influxdata_influxdb-client-apis.DurationLiteral.html index dce7bff5..17810191 100644 --- a/interfaces/_influxdata_influxdb-client-apis.DurationLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.DurationLiteral.html @@ -1,5 +1,5 @@ DurationLiteral | Documentation

    Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration

    -
    interface DurationLiteral {
        type?: string;
        values?: Duration[];
    }

    Properties

    interface DurationLiteral {
        type?: string;
        values?: Duration[];
    }

    Properties

    Properties

    type?: string
    values?: Duration[]

    Duration values

    -
    +

    Properties

    type?: string
    values?: Duration[]

    Duration values

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Error.html b/interfaces/_influxdata_influxdb-client-apis.Error.html index 4f5ceb41..21843e74 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Error.html +++ b/interfaces/_influxdata_influxdb-client-apis.Error.html @@ -1,9 +1,9 @@ -Error | Documentation
    interface Error {
        code:
            | "internal error"
            | "not found"
            | "conflict"
            | "invalid"
            | "unprocessable entity"
            | "empty value"
            | "unavailable"
            | "forbidden"
            | "too many requests"
            | "unauthorized"
            | "method not allowed"
            | "request too large"
            | "unsupported media type";
        err?: string;
        message?: string;
        op?: string;
    }

    Properties

    code +Error | Documentation
    interface Error {
        code:
            | "internal error"
            | "not found"
            | "conflict"
            | "invalid"
            | "unprocessable entity"
            | "empty value"
            | "unavailable"
            | "forbidden"
            | "too many requests"
            | "unauthorized"
            | "method not allowed"
            | "request too large"
            | "unsupported media type";
        err?: string;
        message?: string;
        op?: string;
    }

    Properties

    Properties

    code:
        | "internal error"
        | "not found"
        | "conflict"
        | "invalid"
        | "unprocessable entity"
        | "empty value"
        | "unavailable"
        | "forbidden"
        | "too many requests"
        | "unauthorized"
        | "method not allowed"
        | "request too large"
        | "unsupported media type"

    code is the machine-readable error code.

    -
    err?: string

    Stack of errors that occurred during processing of the request. Useful for debugging.

    -
    message?: string

    Human-readable message.

    -
    op?: string

    Describes the logical code operation when the error occurred. Useful for debugging.

    -
    +
    err?: string

    Stack of errors that occurred during processing of the request. Useful for debugging.

    +
    message?: string

    Human-readable message.

    +
    op?: string

    Describes the logical code operation when the error occurred. Useful for debugging.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ExecutionOptions.html b/interfaces/_influxdata_influxdb-client-apis.ExecutionOptions.html index 7c0bf733..daef2ce3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ExecutionOptions.html +++ b/interfaces/_influxdata_influxdb-client-apis.ExecutionOptions.html @@ -1,6 +1,6 @@ ExecutionOptions | Documentation

    ExecutionOptions contains execution options for a flux script.

    -
    interface ExecutionOptions {
        gzip?: boolean;
        headers?: { [key: string]: string };
    }

    Properties

    interface ExecutionOptions {
        gzip?: boolean;
        headers?: { [key: string]: string };
    }

    Properties

    Properties

    gzip?: boolean

    Requests gzip encoded response.

    -
    headers?: { [key: string]: string }

    HTTP headers that will be sent with every query request.

    -
    +
    headers?: { [key: string]: string }

    HTTP headers that will be sent with every query request.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ExportTemplateRequest.html b/interfaces/_influxdata_influxdb-client-apis.ExportTemplateRequest.html index 719c5eda..24639ad3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ExportTemplateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ExportTemplateRequest.html @@ -1,3 +1,3 @@ -ExportTemplateRequest | Documentation
    interface ExportTemplateRequest {
        body: TemplateExportByID | TemplateExportByName;
    }

    Properties

    body +ExportTemplateRequest | Documentation
    interface ExportTemplateRequest {
        body: TemplateExportByID | TemplateExportByName;
    }

    Properties

    Properties

    Export resources as an InfluxDB template.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ExpressionStatement.html b/interfaces/_influxdata_influxdb-client-apis.ExpressionStatement.html index 0c609c26..53aa7ff6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ExpressionStatement.html +++ b/interfaces/_influxdata_influxdb-client-apis.ExpressionStatement.html @@ -1,4 +1,4 @@ ExpressionStatement | Documentation

    May consist of an expression that doesn't return a value and is executed solely for its side-effects

    -
    interface ExpressionStatement {
        expression?: Expression;
        type?: string;
    }

    Properties

    interface ExpressionStatement {
        expression?: Expression;
        type?: string;
    }

    Properties

    Properties

    expression?: Expression
    type?: string
    +

    Properties

    expression?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.File.html b/interfaces/_influxdata_influxdb-client-apis.File.html index 5a4dac87..05be0f5b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.File.html +++ b/interfaces/_influxdata_influxdb-client-apis.File.html @@ -1,10 +1,10 @@ File | Documentation

    Represents a source from a single file

    -
    interface File {
        body?: Statement[];
        imports?: ImportDeclaration[];
        name?: string;
        package?: PackageClause;
        type?: string;
    }

    Properties

    interface File {
        body?: Statement[];
        imports?: ImportDeclaration[];
        name?: string;
        package?: PackageClause;
        type?: string;
    }

    Properties

    body?: Statement[]

    List of Flux statements

    -
    imports?: ImportDeclaration[]

    A list of package imports

    -
    name?: string

    The name of the file.

    -
    package?: PackageClause
    type?: string
    +
    imports?: ImportDeclaration[]

    A list of package imports

    +
    name?: string

    The name of the file.

    +
    package?: PackageClause
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.FloatLiteral.html b/interfaces/_influxdata_influxdb-client-apis.FloatLiteral.html index 05e4b307..f6699019 100644 --- a/interfaces/_influxdata_influxdb-client-apis.FloatLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.FloatLiteral.html @@ -1,4 +1,4 @@ FloatLiteral | Documentation

    Represents floating point numbers according to the double representations defined by the IEEE-754-1985

    -
    interface FloatLiteral {
        type?: string;
        value?: number;
    }

    Properties

    interface FloatLiteral {
        type?: string;
        value?: number;
    }

    Properties

    Properties

    type?: string
    value?: number
    +

    Properties

    type?: string
    value?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.FluxResponse.html b/interfaces/_influxdata_influxdb-client-apis.FluxResponse.html index 4d19296a..841b7368 100644 --- a/interfaces/_influxdata_influxdb-client-apis.FluxResponse.html +++ b/interfaces/_influxdata_influxdb-client-apis.FluxResponse.html @@ -1,3 +1,3 @@ FluxResponse | Documentation

    Rendered flux that backs the check or notification.

    -
    interface FluxResponse {
        flux?: string;
    }

    Properties

    Properties

    flux?: string
    +
    interface FluxResponse {
        flux?: string;
    }

    Properties

    Properties

    flux?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.FluxSuggestion.html b/interfaces/_influxdata_influxdb-client-apis.FluxSuggestion.html index 3efff51b..2e6ab280 100644 --- a/interfaces/_influxdata_influxdb-client-apis.FluxSuggestion.html +++ b/interfaces/_influxdata_influxdb-client-apis.FluxSuggestion.html @@ -1,3 +1,3 @@ -FluxSuggestion | Documentation
    interface FluxSuggestion {
        name?: string;
        params?: any;
    }

    Properties

    name? +FluxSuggestion | Documentation
    interface FluxSuggestion {
        name?: string;
        params?: any;
    }

    Properties

    Properties

    name?: string
    params?: any
    +

    Properties

    name?: string
    params?: any
    diff --git a/interfaces/_influxdata_influxdb-client-apis.FluxSuggestions.html b/interfaces/_influxdata_influxdb-client-apis.FluxSuggestions.html index 0750dea4..62ad17a6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.FluxSuggestions.html +++ b/interfaces/_influxdata_influxdb-client-apis.FluxSuggestions.html @@ -1,2 +1,2 @@ -FluxSuggestions | Documentation
    interface FluxSuggestions {
        funcs?: FluxSuggestion[];
    }

    Properties

    Properties

    funcs?: FluxSuggestion[]
    +FluxSuggestions | Documentation
    interface FluxSuggestions {
        funcs?: FluxSuggestion[];
    }

    Properties

    Properties

    funcs?: FluxSuggestion[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.FunctionExpression.html b/interfaces/_influxdata_influxdb-client-apis.FunctionExpression.html index e01bdeed..3c49a6cc 100644 --- a/interfaces/_influxdata_influxdb-client-apis.FunctionExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.FunctionExpression.html @@ -1,6 +1,6 @@ FunctionExpression | Documentation

    Function expression

    -
    interface FunctionExpression {
        body?: Node;
        params?: Property[];
        type?: string;
    }

    Properties

    interface FunctionExpression {
        body?: Node;
        params?: Property[];
        type?: string;
    }

    Properties

    Properties

    body?: Node
    params?: Property[]

    Function parameters

    -
    type?: string
    +

    Properties

    body?: Node
    params?: Property[]

    Function parameters

    +
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GaugeViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.GaugeViewProperties.html index 76143db4..9fd7159a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GaugeViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.GaugeViewProperties.html @@ -1,4 +1,4 @@ -GaugeViewProperties | Documentation
    interface GaugeViewProperties {
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        note: string;
        prefix: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        suffix: string;
        tickPrefix: string;
        tickSuffix: string;
        type: "gauge";
    }

    Properties

    colors +GaugeViewProperties | Documentation
    interface GaugeViewProperties {
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        note: string;
        prefix: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        suffix: string;
        tickPrefix: string;
        tickSuffix: string;
        type: "gauge";
    }

    Properties

    Properties

    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    decimalPlaces: DecimalPlaces
    note: string
    prefix: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    suffix: string
    tickPrefix: string
    tickSuffix: string
    type: "gauge"
    +
    decimalPlaces: DecimalPlaces
    note: string
    prefix: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    suffix: string
    tickPrefix: string
    tickSuffix: string
    type: "gauge"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GeoViewLayerProperties.html b/interfaces/_influxdata_influxdb-client-apis.GeoViewLayerProperties.html index e3e3c5e1..e13c7ae8 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GeoViewLayerProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.GeoViewLayerProperties.html @@ -1,2 +1,2 @@ -GeoViewLayerProperties | Documentation
    interface GeoViewLayerProperties {
        type: "heatmap" | "circleMap" | "pointMap" | "trackMap";
    }

    Properties

    Properties

    type: "heatmap" | "circleMap" | "pointMap" | "trackMap"
    +GeoViewLayerProperties | Documentation
    interface GeoViewLayerProperties {
        type: "heatmap" | "circleMap" | "pointMap" | "trackMap";
    }

    Properties

    Properties

    type: "heatmap" | "circleMap" | "pointMap" | "trackMap"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GeoViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.GeoViewProperties.html index e0dc665a..7f804e49 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GeoViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.GeoViewProperties.html @@ -1,4 +1,4 @@ -GeoViewProperties | Documentation
    interface GeoViewProperties {
        allowPanAndZoom: boolean;
        center: { lat: number; lon: number };
        colors?: DashboardColor[];
        detectCoordinateFields: boolean;
        latLonColumns?: LatLonColumns;
        layers: any[];
        mapStyle?: string;
        note: string;
        queries: DashboardQuery[];
        s2Column?: string;
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        type: "geo";
        useS2CellID?: boolean;
        zoom: number;
    }

    Properties

    allowPanAndZoom +GeoViewProperties | Documentation
    interface GeoViewProperties {
        allowPanAndZoom: boolean;
        center: { lat: number; lon: number };
        colors?: DashboardColor[];
        detectCoordinateFields: boolean;
        latLonColumns?: LatLonColumns;
        layers: any[];
        mapStyle?: string;
        note: string;
        queries: DashboardQuery[];
        s2Column?: string;
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        type: "geo";
        useS2CellID?: boolean;
        zoom: number;
    }

    Properties

    allowPanAndZoom: boolean

    If true, map zoom and pan controls are enabled on the dashboard view

    -
    center: { lat: number; lon: number }

    Coordinates of the center of the map

    +
    center: { lat: number; lon: number }

    Coordinates of the center of the map

    Type declaration

    • lat: number

      Latitude of the center of the map

    • lon: number

      Longitude of the center of the map

      -
    colors?: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    detectCoordinateFields: boolean

    If true, search results get automatically regroupped so that lon,lat and value are treated as columns

    -
    latLonColumns?: LatLonColumns
    layers: any[]

    List of individual layers shown in the map

    -
    mapStyle?: string

    Define map type - regular, satellite etc.

    -
    note: string
    queries: DashboardQuery[]
    s2Column?: string

    String to define the column

    -
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    type: "geo"
    useS2CellID?: boolean

    If true, S2 column is used to calculate lat/lon

    -
    zoom: number

    Zoom level used for initial display of the map

    -
    +
    colors?: DashboardColor[]

    Colors define color encoding of data into a visualization

    +
    detectCoordinateFields: boolean

    If true, search results get automatically regroupped so that lon,lat and value are treated as columns

    +
    latLonColumns?: LatLonColumns
    layers: any[]

    List of individual layers shown in the map

    +
    mapStyle?: string

    Define map type - regular, satellite etc.

    +
    note: string
    queries: DashboardQuery[]
    s2Column?: string

    String to define the column

    +
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    type: "geo"
    useS2CellID?: boolean

    If true, S2 column is used to calculate lat/lon

    +
    zoom: number

    Zoom level used for initial display of the map

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsIDRequest.html index e6617a22..75598aba 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsIDRequest.html @@ -1,3 +1,3 @@ -GetAuthorizationsIDRequest | Documentation
    interface GetAuthorizationsIDRequest {
        authID: string;
    }

    Properties

    authID +GetAuthorizationsIDRequest | Documentation
    interface GetAuthorizationsIDRequest {
        authID: string;
    }

    Properties

    Properties

    authID: string

    The ID of the authorization to get.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsRequest.html index 9c5d72ac..0e471f6a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetAuthorizationsRequest.html @@ -1,12 +1,12 @@ -GetAuthorizationsRequest | Documentation
    interface GetAuthorizationsRequest {
        org?: string;
        orgID?: string;
        user?: string;
        userID?: string;
    }

    Properties

    org? +GetAuthorizationsRequest | Documentation
    interface GetAuthorizationsRequest {
        org?: string;
        orgID?: string;
        user?: string;
        userID?: string;
    }

    Properties

    org?: string

    An organization name. Only returns authorizations that belong to this organization.

    -
    orgID?: string

    An organization ID. Only returns authorizations that belong to this organization.

    -
    user?: string

    A user name. +

    orgID?: string

    An organization ID. Only returns authorizations that belong to this organization.

    +
    user?: string

    A user name. Only returns authorizations scoped to this user.

    -
    userID?: string

    A user ID. +

    userID?: string

    A user ID. Only returns authorizations scoped to this user.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBackupKVRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBackupKVRequest.html index 341ee17a..9c5d712e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBackupKVRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBackupKVRequest.html @@ -1 +1 @@ -GetBackupKVRequest | Documentation
    +GetBackupKVRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBackupMetadataRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBackupMetadataRequest.html index a229abfb..f4d7acb0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBackupMetadataRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBackupMetadataRequest.html @@ -1 +1 @@ -GetBackupMetadataRequest | Documentation
    +GetBackupMetadataRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBackupShardIdRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBackupShardIdRequest.html index 322464d2..ef434332 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBackupShardIdRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBackupShardIdRequest.html @@ -1,5 +1,5 @@ -GetBackupShardIdRequest | Documentation
    interface GetBackupShardIdRequest {
        shardID: number;
        since?: string;
    }

    Properties

    shardID +GetBackupShardIdRequest | Documentation
    interface GetBackupShardIdRequest {
        shardID: number;
        since?: string;
    }

    Properties

    Properties

    shardID: number

    The shard ID.

    -
    since?: string

    The earliest time RFC3339 date/time format to include in the snapshot.

    -
    +
    since?: string

    The earliest time RFC3339 date/time format to include in the snapshot.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDLabelsRequest.html index 13405008..595d4ca3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetBucketsIDLabelsRequest | Documentation
    interface GetBucketsIDLabelsRequest {
        bucketID: string;
    }

    Properties

    bucketID +GetBucketsIDLabelsRequest | Documentation
    interface GetBucketsIDLabelsRequest {
        bucketID: string;
    }

    Properties

    Properties

    bucketID: string

    The ID of the bucket to retrieve labels for.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDMembersRequest.html index cb4518cd..5a03041a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDMembersRequest.html @@ -1,3 +1,3 @@ -GetBucketsIDMembersRequest | Documentation
    interface GetBucketsIDMembersRequest {
        bucketID: string;
    }

    Properties

    bucketID +GetBucketsIDMembersRequest | Documentation
    interface GetBucketsIDMembersRequest {
        bucketID: string;
    }

    Properties

    Properties

    bucketID: string

    The ID of the bucket to retrieve users for.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDOwnersRequest.html index e3e3d36f..83fa0922 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDOwnersRequest.html @@ -1,3 +1,3 @@ -GetBucketsIDOwnersRequest | Documentation
    interface GetBucketsIDOwnersRequest {
        bucketID: string;
    }

    Properties

    bucketID +GetBucketsIDOwnersRequest | Documentation
    interface GetBucketsIDOwnersRequest {
        bucketID: string;
    }

    Properties

    Properties

    bucketID: string

    The bucket ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDRequest.html index b054a0af..d2164a9c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBucketsIDRequest.html @@ -1,3 +1,3 @@ -GetBucketsIDRequest | Documentation
    interface GetBucketsIDRequest {
        bucketID: string;
    }

    Properties

    bucketID +GetBucketsIDRequest | Documentation
    interface GetBucketsIDRequest {
        bucketID: string;
    }

    Properties

    Properties

    bucketID: string

    The ID of the bucket to retrieve.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetBucketsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetBucketsRequest.html index aa5ae0cc..5fdbddd9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetBucketsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetBucketsRequest.html @@ -1,4 +1,4 @@ -GetBucketsRequest | Documentation
    interface GetBucketsRequest {
        after?: string;
        id?: string;
        limit?: number;
        name?: string;
        offset?: number;
        org?: string;
        orgID?: string;
    }

    Properties

    after? +GetBucketsRequest | Documentation
    interface GetBucketsRequest {
        after?: string;
        id?: string;
        limit?: number;
        name?: string;
        offset?: number;
        org?: string;
        orgID?: string;
    }

    Properties

    after? id? limit? name? @@ -6,14 +6,14 @@ org? orgID?

    Properties

    after?: string

    Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset.

    -
    id?: string

    Bucket ID. +

    id?: string

    Bucket ID. Only returns the bucket with this ID.

    -
    limit?: number

    Limits the number of records returned. Default is 20.

    -
    name?: string

    Bucket name. +

    limit?: number

    Limits the number of records returned. Default is 20.

    +
    name?: string

    Bucket name. Only returns buckets with this specific name.

    -
    offset?: number

    The offset for pagination. +

    offset?: number

    The offset for pagination. The number of records to skip.

    -
    org?: string

    Organization name. +

    org?: string

    Organization name. The name of the organization.

    • Doesn't use org or orgID.
    • @@ -23,7 +23,7 @@
    • Accepts either org or orgID.
    • InfluxDB creates the bucket within this organization.
    -
    orgID?: string

    Organization ID. +

    orgID?: string

    Organization ID. The organization ID.

    • Doesn't use org or orgID.
    • @@ -33,4 +33,4 @@
    • Accepts either org or orgID.
    • InfluxDB creates the bucket within this organization.
    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetChecksIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetChecksIDLabelsRequest.html index 309cdb13..590f6486 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetChecksIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetChecksIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetChecksIDLabelsRequest | Documentation
    interface GetChecksIDLabelsRequest {
        checkID: string;
    }

    Properties

    checkID +GetChecksIDLabelsRequest | Documentation
    interface GetChecksIDLabelsRequest {
        checkID: string;
    }

    Properties

    Properties

    checkID: string

    The check ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetChecksIDQueryRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetChecksIDQueryRequest.html index c5f5aed8..b8294f6f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetChecksIDQueryRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetChecksIDQueryRequest.html @@ -1,3 +1,3 @@ -GetChecksIDQueryRequest | Documentation
    interface GetChecksIDQueryRequest {
        checkID: string;
    }

    Properties

    checkID +GetChecksIDQueryRequest | Documentation
    interface GetChecksIDQueryRequest {
        checkID: string;
    }

    Properties

    Properties

    checkID: string

    The check ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetChecksIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetChecksIDRequest.html index 95dfbd7d..ffa43d54 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetChecksIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetChecksIDRequest.html @@ -1,3 +1,3 @@ -GetChecksIDRequest | Documentation
    interface GetChecksIDRequest {
        checkID: string;
    }

    Properties

    checkID +GetChecksIDRequest | Documentation
    interface GetChecksIDRequest {
        checkID: string;
    }

    Properties

    Properties

    checkID: string

    The check ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetChecksRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetChecksRequest.html index b6d3dde7..0c83014f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetChecksRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetChecksRequest.html @@ -1,8 +1,8 @@ -GetChecksRequest | Documentation
    interface GetChecksRequest {
        limit?: number;
        offset?: number;
        orgID: string;
    }

    Properties

    limit? +GetChecksRequest | Documentation
    interface GetChecksRequest {
        limit?: number;
        offset?: number;
        orgID: string;
    }

    Properties

    Properties

    limit?: number

    Limits the number of records returned. Default is 20.

    -
    offset?: number

    The offset for pagination. +

    offset?: number

    The offset for pagination. The number of records to skip.

    -
    orgID: string

    Only show checks that belong to a specific organization ID.

    -
    +
    orgID: string

    Only show checks that belong to a specific organization ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetConfigRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetConfigRequest.html index a0c8ad58..d2f9ec95 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetConfigRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetConfigRequest.html @@ -1 +1 @@ -GetConfigRequest | Documentation
    +GetConfigRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDBRPsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDBRPsIDRequest.html index 552caf1d..f17ca658 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDBRPsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDBRPsIDRequest.html @@ -1,7 +1,7 @@ -GetDBRPsIDRequest | Documentation
    interface GetDBRPsIDRequest {
        dbrpID: string;
        org?: string;
        orgID?: string;
    }

    Properties

    dbrpID +GetDBRPsIDRequest | Documentation
    interface GetDBRPsIDRequest {
        dbrpID: string;
        org?: string;
        orgID?: string;
    }

    Properties

    Properties

    dbrpID: string

    The database retention policy mapping ID

    -
    org?: string

    Specifies the organization name of the mapping

    -
    orgID?: string

    Specifies the organization ID of the mapping

    -
    +
    org?: string

    Specifies the organization name of the mapping

    +
    orgID?: string

    Specifies the organization ID of the mapping

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDBRPsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDBRPsRequest.html index 16541216..706db535 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDBRPsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDBRPsRequest.html @@ -1,4 +1,4 @@ -GetDBRPsRequest | Documentation
    interface GetDBRPsRequest {
        bucketID?: string;
        db?: string;
        default?: any;
        id?: string;
        org?: string;
        orgID?: string;
        rp?: string;
    }

    Properties

    bucketID? +GetDBRPsRequest | Documentation
    interface GetDBRPsRequest {
        bucketID?: string;
        db?: string;
        default?: any;
        id?: string;
        org?: string;
        orgID?: string;
        rp?: string;
    }

    Properties

    bucketID? db? default? id? @@ -6,10 +6,10 @@ orgID? rp?

    Properties

    bucketID?: string

    Specifies the bucket ID to filter on

    -
    db?: string

    Specifies the database to filter on

    -
    default?: any

    Specifies filtering on default

    -
    id?: string

    Specifies the mapping ID to filter on

    -
    org?: string

    Specifies the organization name to filter on

    -
    orgID?: string

    Specifies the organization ID to filter on

    -
    rp?: string

    Specifies the retention policy to filter on

    -
    +
    db?: string

    Specifies the database to filter on

    +
    default?: any

    Specifies filtering on default

    +
    id?: string

    Specifies the mapping ID to filter on

    +
    org?: string

    Specifies the organization name to filter on

    +
    orgID?: string

    Specifies the organization ID to filter on

    +
    rp?: string

    Specifies the retention policy to filter on

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDCellsIDViewRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDCellsIDViewRequest.html index 834c0eb2..8c78b82e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDCellsIDViewRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDCellsIDViewRequest.html @@ -1,5 +1,5 @@ -GetDashboardsIDCellsIDViewRequest | Documentation
    interface GetDashboardsIDCellsIDViewRequest {
        cellID: string;
        dashboardID: string;
    }

    Properties

    cellID +GetDashboardsIDCellsIDViewRequest | Documentation
    interface GetDashboardsIDCellsIDViewRequest {
        cellID: string;
        dashboardID: string;
    }

    Properties

    Properties

    cellID: string

    The cell ID.

    -
    dashboardID: string

    The dashboard ID.

    -
    +
    dashboardID: string

    The dashboard ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDLabelsRequest.html index 4f9db592..f6dfdb9b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetDashboardsIDLabelsRequest | Documentation
    interface GetDashboardsIDLabelsRequest {
        dashboardID: string;
    }

    Properties

    dashboardID +GetDashboardsIDLabelsRequest | Documentation
    interface GetDashboardsIDLabelsRequest {
        dashboardID: string;
    }

    Properties

    Properties

    dashboardID: string

    The dashboard ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDMembersRequest.html index 9ae77be1..9ffa1233 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDMembersRequest.html @@ -1,3 +1,3 @@ -GetDashboardsIDMembersRequest | Documentation
    interface GetDashboardsIDMembersRequest {
        dashboardID: string;
    }

    Properties

    dashboardID +GetDashboardsIDMembersRequest | Documentation
    interface GetDashboardsIDMembersRequest {
        dashboardID: string;
    }

    Properties

    Properties

    dashboardID: string

    The dashboard ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDOwnersRequest.html index bcf1cf9e..119b21c7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDOwnersRequest.html @@ -1,3 +1,3 @@ -GetDashboardsIDOwnersRequest | Documentation
    interface GetDashboardsIDOwnersRequest {
        dashboardID: string;
    }

    Properties

    dashboardID +GetDashboardsIDOwnersRequest | Documentation
    interface GetDashboardsIDOwnersRequest {
        dashboardID: string;
    }

    Properties

    Properties

    dashboardID: string

    The dashboard ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDRequest.html index f59a9ae9..13b0c340 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsIDRequest.html @@ -1,5 +1,5 @@ -GetDashboardsIDRequest | Documentation
    interface GetDashboardsIDRequest {
        dashboardID: string;
        include?: string;
    }

    Properties

    dashboardID +GetDashboardsIDRequest | Documentation
    interface GetDashboardsIDRequest {
        dashboardID: string;
        include?: string;
    }

    Properties

    dashboardID: string

    The ID of the dashboard to update.

    -
    include?: string

    If properties, includes the cell view properties in the response.

    -
    +
    include?: string

    If properties, includes the cell view properties in the response.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsRequest.html index eb720ea2..a6b69f23 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDashboardsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDashboardsRequest.html @@ -1,4 +1,4 @@ -GetDashboardsRequest | Documentation
    interface GetDashboardsRequest {
        descending?: any;
        id?: any;
        limit?: number;
        offset?: number;
        org?: string;
        orgID?: string;
        owner?: string;
        sortBy?: string;
    }

    Properties

    descending? +GetDashboardsRequest | Documentation
    interface GetDashboardsRequest {
        descending?: any;
        id?: any;
        limit?: number;
        offset?: number;
        org?: string;
        orgID?: string;
        owner?: string;
        sortBy?: string;
    }

    Properties

    Properties

    descending?: any
    id?: any

    A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used.

    -
    limit?: number

    Limits the number of records returned. Default is 20.

    -
    offset?: number

    The offset for pagination. +

    Properties

    descending?: any
    id?: any

    A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used.

    +
    limit?: number

    Limits the number of records returned. Default is 20.

    +
    offset?: number

    The offset for pagination. The number of records to skip.

    -
    org?: string

    The name of the organization.

    -
    orgID?: string

    The identifier of the organization.

    -
    owner?: string

    A user identifier. Returns only dashboards where this user has the owner role.

    -
    sortBy?: string

    The column to sort by.

    -
    +
    org?: string

    The name of the organization.

    +
    orgID?: string

    The identifier of the organization.

    +
    owner?: string

    A user identifier. Returns only dashboards where this user has the owner role.

    +
    sortBy?: string

    The column to sort by.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllProfilesRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllProfilesRequest.html index 9dbafbff..95a194aa 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllProfilesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllProfilesRequest.html @@ -1,3 +1,3 @@ -GetDebugPprofAllProfilesRequest | Documentation
    interface GetDebugPprofAllProfilesRequest {
        cpu?: string;
    }

    Properties

    cpu? +GetDebugPprofAllProfilesRequest | Documentation
    interface GetDebugPprofAllProfilesRequest {
        cpu?: string;
    }

    Properties

    Properties

    cpu?: string

    Collects and returns CPU profiling data for the specified duration.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllocsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllocsRequest.html index 4e7fb5b5..418a061d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllocsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofAllocsRequest.html @@ -1,4 +1,4 @@ -GetDebugPprofAllocsRequest | Documentation
    interface GetDebugPprofAllocsRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    debug? +GetDebugPprofAllocsRequest | Documentation
    interface GetDebugPprofAllocsRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    Properties

    debug?: number
    • 0: (Default) Return the report as a gzip-compressed protocol buffer.
    • @@ -6,6 +6,6 @@ The report contains comments that translate addresses to function names and line numbers for debugging.

    debug=1 is mutually exclusive with the seconds query parameter.

    -
    seconds?: string

    Number of seconds to collect statistics.

    +
    seconds?: string

    Number of seconds to collect statistics.

    seconds is mutually exclusive with debug=1.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofBlockRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofBlockRequest.html index 4bb65cec..ce9bd717 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofBlockRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofBlockRequest.html @@ -1,4 +1,4 @@ -GetDebugPprofBlockRequest | Documentation
    interface GetDebugPprofBlockRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    debug? +GetDebugPprofBlockRequest | Documentation
    interface GetDebugPprofBlockRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    Properties

    debug?: number
    • 0: (Default) Return the report as a gzip-compressed protocol buffer.
    • @@ -6,6 +6,6 @@ The report contains comments that translate addresses to function names and line numbers for debugging.

    debug=1 is mutually exclusive with the seconds query parameter.

    -
    seconds?: string

    Number of seconds to collect statistics.

    +
    seconds?: string

    Number of seconds to collect statistics.

    seconds is mutually exclusive with debug=1.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofCmdlineRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofCmdlineRequest.html index 328fda32..e80dd564 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofCmdlineRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofCmdlineRequest.html @@ -1 +1 @@ -GetDebugPprofCmdlineRequest | Documentation
    +GetDebugPprofCmdlineRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofGoroutineRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofGoroutineRequest.html index 67f8d450..53a73c0e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofGoroutineRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofGoroutineRequest.html @@ -1,4 +1,4 @@ -GetDebugPprofGoroutineRequest | Documentation
    interface GetDebugPprofGoroutineRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    debug? +GetDebugPprofGoroutineRequest | Documentation
    interface GetDebugPprofGoroutineRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    Properties

    debug?: number
    • 0: (Default) Return the report as a gzip-compressed protocol buffer.
    • @@ -7,6 +7,6 @@ function names and line numbers for debugging.

    debug=1 is mutually exclusive with the seconds query parameter.

    -
    seconds?: string

    Number of seconds to collect statistics.

    +
    seconds?: string

    Number of seconds to collect statistics.

    seconds is mutually exclusive with debug=1.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofHeapRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofHeapRequest.html index eeda4b7b..2bed62c7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofHeapRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofHeapRequest.html @@ -1,4 +1,4 @@ -GetDebugPprofHeapRequest | Documentation
    interface GetDebugPprofHeapRequest {
        debug?: number;
        gc?: number;
        seconds?: string;
    }

    Properties

    debug? +GetDebugPprofHeapRequest | Documentation
    interface GetDebugPprofHeapRequest {
        debug?: number;
        gc?: number;
        seconds?: string;
    }

    Properties

    Properties

    debug?: number
      @@ -7,10 +7,10 @@ The report contains comments that translate addresses to function names and line numbers for debugging.

    debug=1 is mutually exclusive with the seconds query parameter.

    -
    gc?: number
      +
    gc?: number
    • 0: (Default) don't force garbage collection before sampling.
    • 1: Force garbage collection before sampling.
    -
    seconds?: string

    Number of seconds to collect statistics.

    +
    seconds?: string

    Number of seconds to collect statistics.

    seconds is mutually exclusive with debug=1.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofMutexRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofMutexRequest.html index 9c703f82..e2a31625 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofMutexRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofMutexRequest.html @@ -1,4 +1,4 @@ -GetDebugPprofMutexRequest | Documentation
    interface GetDebugPprofMutexRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    debug? +GetDebugPprofMutexRequest | Documentation
    interface GetDebugPprofMutexRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    Properties

    debug?: number
    • 0: (Default) Return the report as a gzip-compressed protocol buffer.
    • @@ -6,6 +6,6 @@ The report contains comments that translate addresses to function names and line numbers for debugging.

    debug=1 is mutually exclusive with the seconds query parameter.

    -
    seconds?: string

    Number of seconds to collect statistics.

    +
    seconds?: string

    Number of seconds to collect statistics.

    seconds is mutually exclusive with debug=1.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofProfileRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofProfileRequest.html index 4c822711..5692d018 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofProfileRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofProfileRequest.html @@ -1,3 +1,3 @@ -GetDebugPprofProfileRequest | Documentation
    interface GetDebugPprofProfileRequest {
        seconds?: string;
    }

    Properties

    seconds? +GetDebugPprofProfileRequest | Documentation
    interface GetDebugPprofProfileRequest {
        seconds?: string;
    }

    Properties

    Properties

    seconds?: string

    Number of seconds to collect profile data. Default is 30 seconds.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofThreadCreateRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofThreadCreateRequest.html index 665d9805..e29856ad 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofThreadCreateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofThreadCreateRequest.html @@ -1,4 +1,4 @@ -GetDebugPprofThreadCreateRequest | Documentation
    interface GetDebugPprofThreadCreateRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    debug? +GetDebugPprofThreadCreateRequest | Documentation
    interface GetDebugPprofThreadCreateRequest {
        debug?: number;
        seconds?: string;
    }

    Properties

    Properties

    debug?: number
    • 0: (Default) Return the report as a gzip-compressed protocol buffer.
    • @@ -6,6 +6,6 @@ The report contains comments that translate addresses to function names and line numbers for debugging.

    debug=1 is mutually exclusive with the seconds query parameter.

    -
    seconds?: string

    Number of seconds to collect statistics.

    +
    seconds?: string

    Number of seconds to collect statistics.

    seconds is mutually exclusive with debug=1.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofTraceRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofTraceRequest.html index ea391185..6d30b7e1 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofTraceRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetDebugPprofTraceRequest.html @@ -1,3 +1,3 @@ -GetDebugPprofTraceRequest | Documentation
    interface GetDebugPprofTraceRequest {
        seconds?: string;
    }

    Properties

    seconds? +GetDebugPprofTraceRequest | Documentation
    interface GetDebugPprofTraceRequest {
        seconds?: string;
    }

    Properties

    Properties

    seconds?: string

    Number of seconds to collect profile data.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetFlagsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetFlagsRequest.html index 4ef709ab..4541b4a1 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetFlagsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetFlagsRequest.html @@ -1 +1 @@ -GetFlagsRequest | Documentation
    +GetFlagsRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetHealthRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetHealthRequest.html index a18cae13..5d29d30f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetHealthRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetHealthRequest.html @@ -1 +1 @@ -GetHealthRequest | Documentation
    +GetHealthRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetLabelsIDRequest.html index 961ad611..8f7c9ef1 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetLabelsIDRequest.html @@ -1,3 +1,3 @@ -GetLabelsIDRequest | Documentation
    interface GetLabelsIDRequest {
        labelID: string;
    }

    Properties

    labelID +GetLabelsIDRequest | Documentation
    interface GetLabelsIDRequest {
        labelID: string;
    }

    Properties

    Properties

    labelID: string

    The ID of the label to update.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetLabelsRequest.html index 086addec..74e13635 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetLabelsRequest.html @@ -1,3 +1,3 @@ -GetLabelsRequest | Documentation
    interface GetLabelsRequest {
        orgID?: string;
    }

    Properties

    orgID? +GetLabelsRequest | Documentation
    interface GetLabelsRequest {
        orgID?: string;
    }

    Properties

    Properties

    orgID?: string

    The organization ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetMeRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetMeRequest.html index 5542fc17..228dbe66 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetMeRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetMeRequest.html @@ -1 +1 @@ -GetMeRequest | Documentation
    +GetMeRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetMetricsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetMetricsRequest.html index 85f78880..dda95407 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetMetricsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetMetricsRequest.html @@ -1 +1 @@ -GetMetricsRequest | Documentation
    +GetMetricsRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDLabelsRequest.html index 86d2cbf5..6e150877 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetNotificationEndpointsIDLabelsRequest | Documentation
    interface GetNotificationEndpointsIDLabelsRequest {
        endpointID: string;
    }

    Properties

    endpointID +GetNotificationEndpointsIDLabelsRequest | Documentation
    interface GetNotificationEndpointsIDLabelsRequest {
        endpointID: string;
    }

    Properties

    Properties

    endpointID: string

    The notification endpoint ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDRequest.html index 66d981dd..d696b6f5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsIDRequest.html @@ -1,3 +1,3 @@ -GetNotificationEndpointsIDRequest | Documentation
    interface GetNotificationEndpointsIDRequest {
        endpointID: string;
    }

    Properties

    endpointID +GetNotificationEndpointsIDRequest | Documentation
    interface GetNotificationEndpointsIDRequest {
        endpointID: string;
    }

    Properties

    Properties

    endpointID: string

    The notification endpoint ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsRequest.html index 3329cfdb..274a9d21 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetNotificationEndpointsRequest.html @@ -1,8 +1,8 @@ -GetNotificationEndpointsRequest | Documentation
    interface GetNotificationEndpointsRequest {
        limit?: number;
        offset?: number;
        orgID: string;
    }

    Properties

    limit? +GetNotificationEndpointsRequest | Documentation
    interface GetNotificationEndpointsRequest {
        limit?: number;
        offset?: number;
        orgID: string;
    }

    Properties

    Properties

    limit?: number

    Limits the number of records returned. Default is 20.

    -
    offset?: number

    The offset for pagination. +

    offset?: number

    The offset for pagination. The number of records to skip.

    -
    orgID: string

    Only show notification endpoints that belong to specific organization ID.

    -
    +
    orgID: string

    Only show notification endpoints that belong to specific organization ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDLabelsRequest.html index 57538487..d22e18f9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetNotificationRulesIDLabelsRequest | Documentation
    interface GetNotificationRulesIDLabelsRequest {
        ruleID: string;
    }

    Properties

    ruleID +GetNotificationRulesIDLabelsRequest | Documentation
    interface GetNotificationRulesIDLabelsRequest {
        ruleID: string;
    }

    Properties

    Properties

    ruleID: string

    The notification rule ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDQueryRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDQueryRequest.html index 42f41cb1..48787b7c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDQueryRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDQueryRequest.html @@ -1,3 +1,3 @@ -GetNotificationRulesIDQueryRequest | Documentation
    interface GetNotificationRulesIDQueryRequest {
        ruleID: string;
    }

    Properties

    ruleID +GetNotificationRulesIDQueryRequest | Documentation
    interface GetNotificationRulesIDQueryRequest {
        ruleID: string;
    }

    Properties

    Properties

    ruleID: string

    The notification rule ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDRequest.html index 32c2899c..26cada98 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesIDRequest.html @@ -1,3 +1,3 @@ -GetNotificationRulesIDRequest | Documentation
    interface GetNotificationRulesIDRequest {
        ruleID: string;
    }

    Properties

    ruleID +GetNotificationRulesIDRequest | Documentation
    interface GetNotificationRulesIDRequest {
        ruleID: string;
    }

    Properties

    Properties

    ruleID: string

    The notification rule ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesRequest.html index 4104fa98..8a691f39 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetNotificationRulesRequest.html @@ -1,12 +1,12 @@ -GetNotificationRulesRequest | Documentation
    interface GetNotificationRulesRequest {
        checkID?: string;
        limit?: number;
        offset?: number;
        orgID: string;
        tag?: string;
    }

    Properties

    checkID? +GetNotificationRulesRequest | Documentation
    interface GetNotificationRulesRequest {
        checkID?: string;
        limit?: number;
        offset?: number;
        orgID: string;
        tag?: string;
    }

    Properties

    checkID?: string

    Only show notifications that belong to the specific check ID.

    -
    limit?: number

    Limits the number of records returned. Default is 20.

    -
    offset?: number

    The offset for pagination. +

    limit?: number

    Limits the number of records returned. Default is 20.

    +
    offset?: number

    The offset for pagination. The number of records to skip.

    -
    orgID: string

    Only show notification rules that belong to a specific organization ID.

    -
    tag?: string

    Only return notification rules that "would match" statuses which contain the tag key value pairs provided.

    -
    +
    orgID: string

    Only show notification rules that belong to a specific organization ID.

    +
    tag?: string

    Only return notification rules that "would match" statuses which contain the tag key value pairs provided.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDMembersRequest.html index b9a3008f..a6fffa17 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDMembersRequest.html @@ -1,3 +1,3 @@ -GetOrgsIDMembersRequest | Documentation
    interface GetOrgsIDMembersRequest {
        orgID: string;
    }

    Properties

    orgID +GetOrgsIDMembersRequest | Documentation
    interface GetOrgsIDMembersRequest {
        orgID: string;
    }

    Properties

    Properties

    orgID: string

    The ID of the organization to retrieve users for.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDOwnersRequest.html index e407f8d3..fa3c2ee2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDOwnersRequest.html @@ -1,3 +1,3 @@ -GetOrgsIDOwnersRequest | Documentation
    interface GetOrgsIDOwnersRequest {
        orgID: string;
    }

    Properties

    orgID +GetOrgsIDOwnersRequest | Documentation
    interface GetOrgsIDOwnersRequest {
        orgID: string;
    }

    Properties

    Properties

    orgID: string

    The ID of the organization to list owners for.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDRequest.html index ea3ce65c..d2d20481 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDRequest.html @@ -1,3 +1,3 @@ -GetOrgsIDRequest | Documentation
    interface GetOrgsIDRequest {
        orgID: string;
    }

    Properties

    orgID +GetOrgsIDRequest | Documentation
    interface GetOrgsIDRequest {
        orgID: string;
    }

    Properties

    Properties

    orgID: string

    The ID of the organization to retrieve.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDSecretsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDSecretsRequest.html index 1b6ce638..b602eba4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDSecretsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetOrgsIDSecretsRequest.html @@ -1,3 +1,3 @@ -GetOrgsIDSecretsRequest | Documentation
    interface GetOrgsIDSecretsRequest {
        orgID: string;
    }

    Properties

    orgID +GetOrgsIDSecretsRequest | Documentation
    interface GetOrgsIDSecretsRequest {
        orgID: string;
    }

    Properties

    Properties

    orgID: string

    The organization ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetOrgsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetOrgsRequest.html index ff4ade51..202b20bf 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetOrgsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetOrgsRequest.html @@ -1,16 +1,16 @@ -GetOrgsRequest | Documentation
    interface GetOrgsRequest {
        descending?: any;
        limit?: number;
        offset?: number;
        org?: string;
        orgID?: string;
        userID?: string;
    }

    Properties

    descending? +GetOrgsRequest | Documentation
    interface GetOrgsRequest {
        descending?: any;
        limit?: number;
        offset?: number;
        org?: string;
        orgID?: string;
        userID?: string;
    }

    Properties

    descending?: any
    limit?: number

    Limits the number of records returned. Default is 20.

    -
    offset?: number

    The offset for pagination. +

    Properties

    descending?: any
    limit?: number

    Limits the number of records returned. Default is 20.

    +
    offset?: number

    The offset for pagination. The number of records to skip.

    -
    org?: string

    An organization name. +

    org?: string

    An organization name. Only returns organizations with this name.

    -
    orgID?: string

    An organization ID. +

    orgID?: string

    An organization ID. Only returns the organization with this ID.

    -
    userID?: string

    A user ID. +

    userID?: string

    A user ID. Only returns organizations where this user is a member or owner.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetPingRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetPingRequest.html index a0cacd6d..e7231919 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetPingRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetPingRequest.html @@ -1 +1 @@ -GetPingRequest | Documentation
    +GetPingRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsNameRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsNameRequest.html index 77192081..dfe3ba9f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsNameRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsNameRequest.html @@ -1,4 +1,4 @@ -GetQuerySuggestionsNameRequest | Documentation
    interface GetQuerySuggestionsNameRequest {
        name: string;
    }

    Properties

    name +GetQuerySuggestionsNameRequest | Documentation
    interface GetQuerySuggestionsNameRequest {
        name: string;
    }

    Properties

    Properties

    name: string

    A Flux Function name. Only returns functions with this name.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsRequest.html index 7afa8bde..0821d368 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetQuerySuggestionsRequest.html @@ -1 +1 @@ -GetQuerySuggestionsRequest | Documentation
    +GetQuerySuggestionsRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetReadyRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetReadyRequest.html index 5e9d1ba4..8b0f7cd5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetReadyRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetReadyRequest.html @@ -1 +1 @@ -GetReadyRequest | Documentation
    +GetReadyRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionByIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionByIDRequest.html index a9f6272b..c88cc439 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionByIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionByIDRequest.html @@ -1,2 +1,2 @@ -GetRemoteConnectionByIDRequest | Documentation
    interface GetRemoteConnectionByIDRequest {
        remoteID: string;
    }

    Properties

    Properties

    remoteID: string
    +GetRemoteConnectionByIDRequest | Documentation
    interface GetRemoteConnectionByIDRequest {
        remoteID: string;
    }

    Properties

    Properties

    remoteID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionsRequest.html index c465462f..a8f4095c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetRemoteConnectionsRequest.html @@ -1,5 +1,5 @@ -GetRemoteConnectionsRequest | Documentation
    interface GetRemoteConnectionsRequest {
        name?: string;
        orgID: string;
        remoteURL?: string;
    }

    Properties

    name? +GetRemoteConnectionsRequest | Documentation
    interface GetRemoteConnectionsRequest {
        name?: string;
        orgID: string;
        remoteURL?: string;
    }

    Properties

    Properties

    name?: string
    orgID: string

    The organization ID.

    -
    remoteURL?: string
    +

    Properties

    name?: string
    orgID: string

    The organization ID.

    +
    remoteURL?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetReplicationByIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetReplicationByIDRequest.html index b021156f..373039d0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetReplicationByIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetReplicationByIDRequest.html @@ -1,2 +1,2 @@ -GetReplicationByIDRequest | Documentation
    interface GetReplicationByIDRequest {
        replicationID: string;
    }

    Properties

    Properties

    replicationID: string
    +GetReplicationByIDRequest | Documentation
    interface GetReplicationByIDRequest {
        replicationID: string;
    }

    Properties

    Properties

    replicationID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetReplicationsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetReplicationsRequest.html index 54cb9fbd..b362f7bc 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetReplicationsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetReplicationsRequest.html @@ -1,6 +1,6 @@ -GetReplicationsRequest | Documentation
    interface GetReplicationsRequest {
        localBucketID?: string;
        name?: string;
        orgID: string;
        remoteID?: string;
    }

    Properties

    localBucketID? +GetReplicationsRequest | Documentation
    interface GetReplicationsRequest {
        localBucketID?: string;
        name?: string;
        orgID: string;
        remoteID?: string;
    }

    Properties

    localBucketID?: string
    name?: string
    orgID: string

    The organization ID.

    -
    remoteID?: string
    +

    Properties

    localBucketID?: string
    name?: string
    orgID: string

    The organization ID.

    +
    remoteID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetResourcesRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetResourcesRequest.html index 8b83358e..bf34be82 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetResourcesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetResourcesRequest.html @@ -1 +1 @@ -GetResourcesRequest | Documentation
    +GetResourcesRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetRoutesRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetRoutesRequest.html index 5056ceaf..a1640fa2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetRoutesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetRoutesRequest.html @@ -1 +1 @@ -GetRoutesRequest | Documentation
    +GetRoutesRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDLabelsRequest.html index 57991df0..b8eaf45e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetScrapersIDLabelsRequest | Documentation
    interface GetScrapersIDLabelsRequest {
        scraperTargetID: string;
    }

    Properties

    scraperTargetID +GetScrapersIDLabelsRequest | Documentation
    interface GetScrapersIDLabelsRequest {
        scraperTargetID: string;
    }

    Properties

    Properties

    scraperTargetID: string

    The scraper target ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDMembersRequest.html index b0ee281c..0d8eb773 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDMembersRequest.html @@ -1,3 +1,3 @@ -GetScrapersIDMembersRequest | Documentation
    interface GetScrapersIDMembersRequest {
        scraperTargetID: string;
    }

    Properties

    scraperTargetID +GetScrapersIDMembersRequest | Documentation
    interface GetScrapersIDMembersRequest {
        scraperTargetID: string;
    }

    Properties

    Properties

    scraperTargetID: string

    The scraper target ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDOwnersRequest.html index 947cc9c4..1584506a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDOwnersRequest.html @@ -1,3 +1,3 @@ -GetScrapersIDOwnersRequest | Documentation
    interface GetScrapersIDOwnersRequest {
        scraperTargetID: string;
    }

    Properties

    scraperTargetID +GetScrapersIDOwnersRequest | Documentation
    interface GetScrapersIDOwnersRequest {
        scraperTargetID: string;
    }

    Properties

    Properties

    scraperTargetID: string

    The scraper target ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDRequest.html index 3cb09c3f..0e43e5b1 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetScrapersIDRequest.html @@ -1,3 +1,3 @@ -GetScrapersIDRequest | Documentation
    interface GetScrapersIDRequest {
        scraperTargetID: string;
    }

    Properties

    scraperTargetID +GetScrapersIDRequest | Documentation
    interface GetScrapersIDRequest {
        scraperTargetID: string;
    }

    Properties

    Properties

    scraperTargetID: string

    The identifier of the scraper target.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetScrapersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetScrapersRequest.html index 04ed3226..ea0da7d0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetScrapersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetScrapersRequest.html @@ -1,9 +1,9 @@ -GetScrapersRequest | Documentation
    interface GetScrapersRequest {
        id?: any;
        name?: string;
        org?: string;
        orgID?: string;
    }

    Properties

    id? +GetScrapersRequest | Documentation
    interface GetScrapersRequest {
        id?: any;
        name?: string;
        org?: string;
        orgID?: string;
    }

    Properties

    Properties

    id?: any

    List of scraper target IDs to return. If both id and owner are specified, only id is used.

    -
    name?: string

    Specifies the name of the scraper target.

    -
    org?: string

    Specifies the organization name of the scraper target.

    -
    orgID?: string

    Specifies the organization ID of the scraper target.

    -
    +
    name?: string

    Specifies the name of the scraper target.

    +
    org?: string

    Specifies the organization name of the scraper target.

    +
    orgID?: string

    Specifies the organization ID of the scraper target.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetScriptsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetScriptsIDRequest.html index 69b0979c..478a0e0b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetScriptsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetScriptsIDRequest.html @@ -1,4 +1,4 @@ -GetScriptsIDRequest | Documentation
    interface GetScriptsIDRequest {
        scriptID: string;
    }

    Properties

    scriptID +GetScriptsIDRequest | Documentation
    interface GetScriptsIDRequest {
        scriptID: string;
    }

    Properties

    Properties

    scriptID: string

    A script ID. Specifies the script to retrieve.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetScriptsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetScriptsRequest.html index d279023d..f0d18695 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetScriptsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetScriptsRequest.html @@ -1,16 +1,16 @@ -GetScriptsRequest | Documentation
    interface GetScriptsRequest {
        labelContains?: string;
        labelNames?: any;
        limit?: number;
        name?: string;
        offset?: number;
    }

    Properties

    labelContains? +GetScriptsRequest | Documentation
    interface GetScriptsRequest {
        labelContains?: string;
        labelNames?: any;
        limit?: number;
        name?: string;
        offset?: number;
    }

    Properties

    labelContains?: string

    A part of the label name. Returns scripts that have a label that contains the specified phrase.

    -
    labelNames?: any

    A list of label names. +

    labelNames?: any

    A list of label names. Only returns scripts that have all the specified labels. To retrieve a script, each name you pass in labelNames must exactly match the label for a script.

    -
    limit?: number

    The maximum number of scripts to return. Default is 100.

    -
    name?: string

    The name of the script.

    -
    offset?: number

    The offset for pagination. +

    limit?: number

    The maximum number of scripts to return. Default is 100.

    +
    name?: string

    The name of the script.

    +
    offset?: number

    The offset for pagination. Specifies the number of records to skip in the result.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetSetupRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetSetupRequest.html index b9920a25..5bc578ce 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetSetupRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetSetupRequest.html @@ -1 +1 @@ -GetSetupRequest | Documentation
    +GetSetupRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDBucketsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDBucketsRequest.html index 753eadcd..a5f03179 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDBucketsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDBucketsRequest.html @@ -1,5 +1,5 @@ -GetSourcesIDBucketsRequest | Documentation
    interface GetSourcesIDBucketsRequest {
        org?: string;
        sourceID: string;
    }

    Properties

    org? +GetSourcesIDBucketsRequest | Documentation
    interface GetSourcesIDBucketsRequest {
        org?: string;
        sourceID: string;
    }

    Properties

    Properties

    org?: string

    The name of the organization.

    -
    sourceID: string

    The source ID.

    -
    +
    sourceID: string

    The source ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDHealthRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDHealthRequest.html index b9ded380..aff07f5d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDHealthRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDHealthRequest.html @@ -1,3 +1,3 @@ -GetSourcesIDHealthRequest | Documentation
    interface GetSourcesIDHealthRequest {
        sourceID: string;
    }

    Properties

    sourceID +GetSourcesIDHealthRequest | Documentation
    interface GetSourcesIDHealthRequest {
        sourceID: string;
    }

    Properties

    Properties

    sourceID: string

    The source ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDRequest.html index 9e4b5e56..07007a92 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetSourcesIDRequest.html @@ -1,3 +1,3 @@ -GetSourcesIDRequest | Documentation
    interface GetSourcesIDRequest {
        sourceID: string;
    }

    Properties

    sourceID +GetSourcesIDRequest | Documentation
    interface GetSourcesIDRequest {
        sourceID: string;
    }

    Properties

    Properties

    sourceID: string

    The source ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetSourcesRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetSourcesRequest.html index b896dd3d..77964324 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetSourcesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetSourcesRequest.html @@ -1,3 +1,3 @@ -GetSourcesRequest | Documentation
    interface GetSourcesRequest {
        org?: string;
    }

    Properties

    org? +GetSourcesRequest | Documentation
    interface GetSourcesRequest {
        org?: string;
    }

    Properties

    Properties

    org?: string

    The name of the organization.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLabelsRequest.html index f5dea273..5be92ccb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetTasksIDLabelsRequest | Documentation
    interface GetTasksIDLabelsRequest {
        taskID: string;
    }

    Properties

    taskID +GetTasksIDLabelsRequest | Documentation
    interface GetTasksIDLabelsRequest {
        taskID: string;
    }

    Properties

    Properties

    taskID: string

    The ID of the task to retrieve labels for.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLogsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLogsRequest.html index c87a401d..13967d74 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLogsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDLogsRequest.html @@ -1,3 +1,3 @@ -GetTasksIDLogsRequest | Documentation
    interface GetTasksIDLogsRequest {
        taskID: string;
    }

    Properties

    taskID +GetTasksIDLogsRequest | Documentation
    interface GetTasksIDLogsRequest {
        taskID: string;
    }

    Properties

    Properties

    taskID: string

    The task ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDMembersRequest.html index e6db9a02..135fc7d2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDMembersRequest.html @@ -1,3 +1,3 @@ -GetTasksIDMembersRequest | Documentation
    interface GetTasksIDMembersRequest {
        taskID: string;
    }

    Properties

    taskID +GetTasksIDMembersRequest | Documentation
    interface GetTasksIDMembersRequest {
        taskID: string;
    }

    Properties

    Properties

    taskID: string

    The task ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDOwnersRequest.html index f16a1b6f..d9110235 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDOwnersRequest.html @@ -1,3 +1,3 @@ -GetTasksIDOwnersRequest | Documentation
    interface GetTasksIDOwnersRequest {
        taskID: string;
    }

    Properties

    taskID +GetTasksIDOwnersRequest | Documentation
    interface GetTasksIDOwnersRequest {
        taskID: string;
    }

    Properties

    Properties

    taskID: string

    The ID of the task to retrieve owners for.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRequest.html index 92a9f703..fc55ec59 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRequest.html @@ -1,3 +1,3 @@ -GetTasksIDRequest | Documentation
    interface GetTasksIDRequest {
        taskID: string;
    }

    Properties

    taskID +GetTasksIDRequest | Documentation
    interface GetTasksIDRequest {
        taskID: string;
    }

    Properties

    Properties

    taskID: string

    The ID of the task to retrieve.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDLogsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDLogsRequest.html index 9ce3eb7b..3952b48e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDLogsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDLogsRequest.html @@ -1,5 +1,5 @@ -GetTasksIDRunsIDLogsRequest | Documentation
    interface GetTasksIDRunsIDLogsRequest {
        runID: string;
        taskID: string;
    }

    Properties

    runID +GetTasksIDRunsIDLogsRequest | Documentation
    interface GetTasksIDRunsIDLogsRequest {
        runID: string;
        taskID: string;
    }

    Properties

    Properties

    runID: string

    The ID of the run to get logs for.

    -
    taskID: string

    The ID of the task to get logs for.

    -
    +
    taskID: string

    The ID of the task to get logs for.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDRequest.html index 4e1c24bd..9b33c9a0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsIDRequest.html @@ -1,5 +1,5 @@ -GetTasksIDRunsIDRequest | Documentation
    interface GetTasksIDRunsIDRequest {
        runID: string;
        taskID: string;
    }

    Properties

    runID +GetTasksIDRunsIDRequest | Documentation
    interface GetTasksIDRunsIDRequest {
        runID: string;
        taskID: string;
    }

    Properties

    Properties

    runID: string

    The ID of the run to retrieve.

    -
    taskID: string

    The ID of the task to retrieve runs for.

    -
    +
    taskID: string

    The ID of the task to retrieve runs for.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsRequest.html index b431a578..fdec1de7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksIDRunsRequest.html @@ -1,14 +1,14 @@ -GetTasksIDRunsRequest | Documentation
    interface GetTasksIDRunsRequest {
        after?: string;
        afterTime?: string;
        beforeTime?: string;
        limit?: number;
        taskID: string;
    }

    Properties

    after? +GetTasksIDRunsRequest | Documentation
    interface GetTasksIDRunsRequest {
        after?: string;
        afterTime?: string;
        beforeTime?: string;
        limit?: number;
        taskID: string;
    }

    Properties

    after?: string

    A task run ID. Only returns runs created after this run.

    -
    afterTime?: string

    A timestamp (RFC3339 date/time format). +

    afterTime?: string

    A timestamp (RFC3339 date/time format). Only returns runs scheduled after this time.

    -
    beforeTime?: string

    A timestamp (RFC3339 date/time format). +

    beforeTime?: string

    A timestamp (RFC3339 date/time format). Only returns runs scheduled before this time.

    -
    limit?: number

    Limits the number of task runs returned. Default is 100.

    -
    taskID: string

    The ID of the task to get runs for. +

    limit?: number

    Limits the number of task runs returned. Default is 100.

    +
    taskID: string

    The ID of the task to get runs for. Only returns runs for this task.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTasksRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTasksRequest.html index 3368bdc1..75633a37 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTasksRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTasksRequest.html @@ -1,4 +1,4 @@ -GetTasksRequest | Documentation
    interface GetTasksRequest {
        after?: string;
        limit?: number;
        name?: string;
        org?: string;
        orgID?: string;
        status?: string;
        type?: string;
        user?: string;
    }

    Properties

    after? +GetTasksRequest | Documentation
    interface GetTasksRequest {
        after?: string;
        limit?: number;
        name?: string;
        org?: string;
        orgID?: string;
        status?: string;
        type?: string;
        user?: string;
    }

    Properties

    after? limit? name? org? @@ -8,25 +8,25 @@ user?

    Properties

    after?: string

    A task ID. Only returns tasks created after the specified task.

    -
    limit?: number

    The maximum number of tasks to return. +

    limit?: number

    The maximum number of tasks to return. Default is 100. The minimum is 1 and the maximum is 500.

    To reduce the payload size, combine type=basic and limit (see Request samples). For more information about the basic response, see the type parameter.

    -
    name?: string

    A task name. +

    name?: string

    A task name. Only returns tasks with the specified name. Different tasks may have the same name.

    -
    org?: string

    An organization name. +

    org?: string

    An organization name. Only returns tasks owned by the specified organization.

    -
    orgID?: string

    An organization ID. +

    orgID?: string

    An organization ID. Only returns tasks owned by the specified organization.

    -
    status?: string

    A task status. +

    status?: string

    A task status. Only returns tasks that have the specified status (active or inactive).

    -
    type?: string

    A task type (basic or system). +

    type?: string

    A task type (basic or system). Default is system. Specifies the level of detail for tasks in the response. The default (system) response contains all the metadata properties for tasks. To reduce the response size, pass basic to omit some task properties (flux, createdAt, updatedAt).

    -
    user?: string

    A user ID. +

    user?: string

    A user ID. Only returns tasks owned by the specified user.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafPluginsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafPluginsRequest.html index 77a6e9d3..522392f6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafPluginsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafPluginsRequest.html @@ -1,3 +1,3 @@ -GetTelegrafPluginsRequest | Documentation
    interface GetTelegrafPluginsRequest {
        type?: string;
    }

    Properties

    type? +GetTelegrafPluginsRequest | Documentation
    interface GetTelegrafPluginsRequest {
        type?: string;
    }

    Properties

    Properties

    type?: string

    The type of plugin desired.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDLabelsRequest.html index 28630a5b..5bf36a42 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetTelegrafsIDLabelsRequest | Documentation
    interface GetTelegrafsIDLabelsRequest {
        telegrafID: string;
    }

    Properties

    telegrafID +GetTelegrafsIDLabelsRequest | Documentation
    interface GetTelegrafsIDLabelsRequest {
        telegrafID: string;
    }

    Properties

    Properties

    telegrafID: string

    The Telegraf config ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDMembersRequest.html index 7ec80b81..328f5922 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDMembersRequest.html @@ -1,3 +1,3 @@ -GetTelegrafsIDMembersRequest | Documentation
    interface GetTelegrafsIDMembersRequest {
        telegrafID: string;
    }

    Properties

    telegrafID +GetTelegrafsIDMembersRequest | Documentation
    interface GetTelegrafsIDMembersRequest {
        telegrafID: string;
    }

    Properties

    Properties

    telegrafID: string

    The Telegraf config ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDOwnersRequest.html index 3f12466a..fc6fcda9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDOwnersRequest.html @@ -1,3 +1,3 @@ -GetTelegrafsIDOwnersRequest | Documentation
    interface GetTelegrafsIDOwnersRequest {
        telegrafID: string;
    }

    Properties

    telegrafID +GetTelegrafsIDOwnersRequest | Documentation
    interface GetTelegrafsIDOwnersRequest {
        telegrafID: string;
    }

    Properties

    Properties

    telegrafID: string

    The Telegraf configuration ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDRequest.html index 6429a981..f19144c8 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsIDRequest.html @@ -1,3 +1,3 @@ -GetTelegrafsIDRequest | Documentation
    interface GetTelegrafsIDRequest {
        telegrafID: string;
    }

    Properties

    telegrafID +GetTelegrafsIDRequest | Documentation
    interface GetTelegrafsIDRequest {
        telegrafID: string;
    }

    Properties

    Properties

    telegrafID: string

    The Telegraf configuration ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsRequest.html index 70368f27..07b05448 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetTelegrafsRequest.html @@ -1,3 +1,3 @@ -GetTelegrafsRequest | Documentation
    interface GetTelegrafsRequest {
        orgID?: string;
    }

    Properties

    orgID? +GetTelegrafsRequest | Documentation
    interface GetTelegrafsRequest {
        orgID?: string;
    }

    Properties

    Properties

    orgID?: string

    The organization ID the Telegraf config belongs to.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetUsersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetUsersIDRequest.html index 4f8cc838..1241e61c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetUsersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetUsersIDRequest.html @@ -1,3 +1,3 @@ -GetUsersIDRequest | Documentation
    interface GetUsersIDRequest {
        userID: string;
    }

    Properties

    userID +GetUsersIDRequest | Documentation
    interface GetUsersIDRequest {
        userID: string;
    }

    Properties

    Properties

    userID: string

    The user ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetUsersRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetUsersRequest.html index 6f778473..076efdbb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetUsersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetUsersRequest.html @@ -1,10 +1,10 @@ -GetUsersRequest | Documentation
    interface GetUsersRequest {
        after?: string;
        id?: string;
        limit?: number;
        name?: string;
        offset?: number;
    }

    Properties

    after? +GetUsersRequest | Documentation
    interface GetUsersRequest {
        after?: string;
        id?: string;
        limit?: number;
        name?: string;
        offset?: number;
    }

    Properties

    after?: string

    Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset.

    -
    id?: string
    limit?: number

    Limits the number of records returned. Default is 20.

    -
    name?: string
    offset?: number

    The offset for pagination. +

    id?: string
    limit?: number

    Limits the number of records returned. Default is 20.

    +
    name?: string
    offset?: number

    The offset for pagination. The number of records to skip.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDLabelsRequest.html index 8805241d..75f6c4aa 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDLabelsRequest.html @@ -1,3 +1,3 @@ -GetVariablesIDLabelsRequest | Documentation
    interface GetVariablesIDLabelsRequest {
        variableID: string;
    }

    Properties

    variableID +GetVariablesIDLabelsRequest | Documentation
    interface GetVariablesIDLabelsRequest {
        variableID: string;
    }

    Properties

    Properties

    variableID: string

    The variable ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDRequest.html index 4ae5b0d8..b9b43eb8 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetVariablesIDRequest.html @@ -1,3 +1,3 @@ -GetVariablesIDRequest | Documentation
    interface GetVariablesIDRequest {
        variableID: string;
    }

    Properties

    variableID +GetVariablesIDRequest | Documentation
    interface GetVariablesIDRequest {
        variableID: string;
    }

    Properties

    Properties

    variableID: string

    The variable ID.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.GetVariablesRequest.html b/interfaces/_influxdata_influxdb-client-apis.GetVariablesRequest.html index 8379f51a..fc722989 100644 --- a/interfaces/_influxdata_influxdb-client-apis.GetVariablesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.GetVariablesRequest.html @@ -1,5 +1,5 @@ -GetVariablesRequest | Documentation
    interface GetVariablesRequest {
        org?: string;
        orgID?: string;
    }

    Properties

    org? +GetVariablesRequest | Documentation
    interface GetVariablesRequest {
        org?: string;
        orgID?: string;
    }

    Properties

    Properties

    org?: string

    The name of the organization.

    -
    orgID?: string

    The organization ID.

    -
    +
    orgID?: string

    The organization ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.HTTPNotificationRuleBase.html b/interfaces/_influxdata_influxdb-client-apis.HTTPNotificationRuleBase.html index bcc10cca..15e4df5e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.HTTPNotificationRuleBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.HTTPNotificationRuleBase.html @@ -1,3 +1,3 @@ -HTTPNotificationRuleBase | Documentation
    interface HTTPNotificationRuleBase {
        type: "http";
        url?: string;
    }

    Properties

    type +HTTPNotificationRuleBase | Documentation
    interface HTTPNotificationRuleBase {
        type: "http";
        url?: string;
    }

    Properties

    Properties

    type: "http"
    url?: string
    +

    Properties

    type: "http"
    url?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.HealthCheck.html b/interfaces/_influxdata_influxdb-client-apis.HealthCheck.html index 96f42714..f16ee954 100644 --- a/interfaces/_influxdata_influxdb-client-apis.HealthCheck.html +++ b/interfaces/_influxdata_influxdb-client-apis.HealthCheck.html @@ -1,7 +1,7 @@ -HealthCheck | Documentation
    interface HealthCheck {
        checks?: HealthCheck[];
        commit?: string;
        message?: string;
        name: string;
        status: "pass" | "fail";
        version?: string;
    }

    Properties

    checks? +HealthCheck | Documentation
    interface HealthCheck {
        checks?: HealthCheck[];
        commit?: string;
        message?: string;
        name: string;
        status: "pass" | "fail";
        version?: string;
    }

    Properties

    checks?: HealthCheck[]
    commit?: string
    message?: string
    name: string
    status: "pass" | "fail"
    version?: string
    +

    Properties

    checks?: HealthCheck[]
    commit?: string
    message?: string
    name: string
    status: "pass" | "fail"
    version?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.HeatmapViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.HeatmapViewProperties.html index 1592cddf..ff39d9dd 100644 --- a/interfaces/_influxdata_influxdb-client-apis.HeatmapViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.HeatmapViewProperties.html @@ -1,4 +1,4 @@ -HeatmapViewProperties | Documentation
    interface HeatmapViewProperties {
        adaptiveZoomHide?: boolean;
        binSize: number;
        colors: string[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        timeFormat?: string;
        type: "heatmap";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
        xPrefix: string;
        xSuffix: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yAxisLabel: string;
        yColumn: string;
        yDomain: number[];
        yPrefix: string;
        ySuffix: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide? +HeatmapViewProperties | Documentation
    interface HeatmapViewProperties {
        adaptiveZoomHide?: boolean;
        binSize: number;
        colors: string[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        timeFormat?: string;
        type: "heatmap";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
        xPrefix: string;
        xSuffix: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yAxisLabel: string;
        yColumn: string;
        yDomain: number[];
        yPrefix: string;
        ySuffix: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide?: boolean
    binSize: number
    colors: string[]

    Colors define color encoding of data into a visualization

    -
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    timeFormat?: string
    type: "heatmap"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    xPrefix: string
    xSuffix: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yAxisLabel: string
    yColumn: string
    yDomain: number[]
    yPrefix: string
    ySuffix: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    +

    Properties

    adaptiveZoomHide?: boolean
    binSize: number
    colors: string[]

    Colors define color encoding of data into a visualization

    +
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    timeFormat?: string
    type: "heatmap"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    xPrefix: string
    xSuffix: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yAxisLabel: string
    yColumn: string
    yDomain: number[]
    yPrefix: string
    ySuffix: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.HistogramViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.HistogramViewProperties.html index c0ae28fa..1535504d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.HistogramViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.HistogramViewProperties.html @@ -1,4 +1,4 @@ -HistogramViewProperties | Documentation
    interface HistogramViewProperties {
        binCount: number;
        colors: DashboardColor[];
        fillColumns: string[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        position: "overlaid" | "stacked";
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        type: "histogram";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
    }

    Properties

    binCount +HistogramViewProperties | Documentation
    interface HistogramViewProperties {
        binCount: number;
        colors: DashboardColor[];
        fillColumns: string[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        position: "overlaid" | "stacked";
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        type: "histogram";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
    }

    Properties

    binCount: number
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    fillColumns: string[]
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    position: "overlaid" | "stacked"
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    type: "histogram"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    +

    Properties

    binCount: number
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    +
    fillColumns: string[]
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    position: "overlaid" | "stacked"
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    type: "histogram"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Identifier.html b/interfaces/_influxdata_influxdb-client-apis.Identifier.html index 360f1dbd..e590e2fe 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Identifier.html +++ b/interfaces/_influxdata_influxdb-client-apis.Identifier.html @@ -1,4 +1,4 @@ Identifier | Documentation

    A valid Flux identifier

    -
    interface Identifier {
        name?: string;
        type?: string;
    }

    Properties

    interface Identifier {
        name?: string;
        type?: string;
    }

    Properties

    Properties

    name?: string
    type?: string
    +

    Properties

    name?: string
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ImportDeclaration.html b/interfaces/_influxdata_influxdb-client-apis.ImportDeclaration.html index b47b79d1..1c6fc143 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ImportDeclaration.html +++ b/interfaces/_influxdata_influxdb-client-apis.ImportDeclaration.html @@ -1,5 +1,5 @@ ImportDeclaration | Documentation

    Declares a package import

    -
    interface ImportDeclaration {
        as?: Identifier;
        path?: StringLiteral;
        type?: string;
    }

    Properties

    as? +
    interface ImportDeclaration {
        as?: Identifier;
        path?: StringLiteral;
        type?: string;
    }

    Properties

    Properties

    type?: string
    +

    Properties

    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.IndexExpression.html b/interfaces/_influxdata_influxdb-client-apis.IndexExpression.html index c0523f3c..cbe72ba7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.IndexExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.IndexExpression.html @@ -1,5 +1,5 @@ IndexExpression | Documentation

    Represents indexing into an array

    -
    interface IndexExpression {
        array?: Expression;
        index?: Expression;
        type?: string;
    }

    Properties

    interface IndexExpression {
        array?: Expression;
        index?: Expression;
        type?: string;
    }

    Properties

    Properties

    array?: Expression
    index?: Expression
    type?: string
    +

    Properties

    array?: Expression
    index?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.IntegerLiteral.html b/interfaces/_influxdata_influxdb-client-apis.IntegerLiteral.html index 1ee0e211..dbc8793a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.IntegerLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.IntegerLiteral.html @@ -1,4 +1,4 @@ IntegerLiteral | Documentation

    Represents integer numbers

    -
    interface IntegerLiteral {
        type?: string;
        value?: string;
    }

    Properties

    interface IntegerLiteral {
        type?: string;
        value?: string;
    }

    Properties

    Properties

    type?: string
    value?: string
    +

    Properties

    type?: string
    value?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.IsOnboarding.html b/interfaces/_influxdata_influxdb-client-apis.IsOnboarding.html index afb69c53..40cfa29c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.IsOnboarding.html +++ b/interfaces/_influxdata_influxdb-client-apis.IsOnboarding.html @@ -1,4 +1,4 @@ -IsOnboarding | Documentation
    interface IsOnboarding {
        allowed?: boolean;
    }

    Properties

    allowed? +IsOnboarding | Documentation
    interface IsOnboarding {
        allowed?: boolean;
    }

    Properties

    Properties

    allowed?: boolean

    If true, the InfluxDB instance hasn't had initial setup; false otherwise.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Label.html b/interfaces/_influxdata_influxdb-client-apis.Label.html index e2d7fffc..d4497af4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Label.html +++ b/interfaces/_influxdata_influxdb-client-apis.Label.html @@ -1,7 +1,7 @@ -Label | Documentation
    interface Label {
        id?: string;
        name?: string;
        orgID?: string;
        properties?: any;
    }

    Properties

    id? +Label | Documentation
    interface Label {
        id?: string;
        name?: string;
        orgID?: string;
        properties?: any;
    }

    Properties

    id?: string
    name?: string
    orgID?: string
    properties?: any

    Key-value pairs associated with this label. +

    Properties

    id?: string
    name?: string
    orgID?: string
    properties?: any

    Key-value pairs associated with this label. To remove a property, send an update with an empty value ("") for the key.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LabelCreateRequest.html b/interfaces/_influxdata_influxdb-client-apis.LabelCreateRequest.html index 34ba31e8..2a99bb06 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LabelCreateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.LabelCreateRequest.html @@ -1,6 +1,6 @@ -LabelCreateRequest | Documentation
    interface LabelCreateRequest {
        name: string;
        orgID: string;
        properties?: any;
    }

    Properties

    name +LabelCreateRequest | Documentation
    interface LabelCreateRequest {
        name: string;
        orgID: string;
        properties?: any;
    }

    Properties

    Properties

    name: string
    orgID: string
    properties?: any

    Key-value pairs associated with this label.

    +

    Properties

    name: string
    orgID: string
    properties?: any

    Key-value pairs associated with this label.

    To remove a property, send an update with an empty value ("") for the key.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LabelMapping.html b/interfaces/_influxdata_influxdb-client-apis.LabelMapping.html index a4663334..bae929a9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LabelMapping.html +++ b/interfaces/_influxdata_influxdb-client-apis.LabelMapping.html @@ -1,4 +1,4 @@ -LabelMapping | Documentation
    interface LabelMapping {
        labelID?: string;
    }

    Properties

    labelID? +LabelMapping | Documentation
    interface LabelMapping {
        labelID?: string;
    }

    Properties

    Properties

    labelID?: string

    Label ID. The ID of the label to attach.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LabelResponse.html b/interfaces/_influxdata_influxdb-client-apis.LabelResponse.html index 1383f3a1..a988b6b2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LabelResponse.html +++ b/interfaces/_influxdata_influxdb-client-apis.LabelResponse.html @@ -1,3 +1,3 @@ -LabelResponse | Documentation
    interface LabelResponse {
        label?: Label;
        links?: Links;
    }

    Properties

    label? +LabelResponse | Documentation
    interface LabelResponse {
        label?: Label;
        links?: Links;
    }

    Properties

    Properties

    label?: Label
    links?: Links
    +

    Properties

    label?: Label
    links?: Links
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LabelUpdate.html b/interfaces/_influxdata_influxdb-client-apis.LabelUpdate.html index cbf6c058..087a26c3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LabelUpdate.html +++ b/interfaces/_influxdata_influxdb-client-apis.LabelUpdate.html @@ -1,3 +1,3 @@ -LabelUpdate | Documentation
    interface LabelUpdate {
        name?: string;
        properties?: any;
    }

    Properties

    name? +LabelUpdate | Documentation
    interface LabelUpdate {
        name?: string;
        properties?: any;
    }

    Properties

    Properties

    name?: string
    properties?: any
    +

    Properties

    name?: string
    properties?: any
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LabelsResponse.html b/interfaces/_influxdata_influxdb-client-apis.LabelsResponse.html index f17c4560..bec6dba3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LabelsResponse.html +++ b/interfaces/_influxdata_influxdb-client-apis.LabelsResponse.html @@ -1,3 +1,3 @@ -LabelsResponse | Documentation
    interface LabelsResponse {
        labels?: Labels;
        links?: Links;
    }

    Properties

    labels? +LabelsResponse | Documentation
    interface LabelsResponse {
        labels?: Labels;
        links?: Links;
    }

    Properties

    Properties

    labels?: Labels
    links?: Links
    +

    Properties

    labels?: Labels
    links?: Links
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LanguageRequest.html b/interfaces/_influxdata_influxdb-client-apis.LanguageRequest.html index 3bdc258c..b1a9d074 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LanguageRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.LanguageRequest.html @@ -1,4 +1,4 @@ LanguageRequest | Documentation

    Flux query to be analyzed.

    -
    interface LanguageRequest {
        query: string;
    }

    Properties

    interface LanguageRequest {
        query: string;
    }

    Properties

    Properties

    query: string

    The Flux query script to be analyzed.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LatLonColumn.html b/interfaces/_influxdata_influxdb-client-apis.LatLonColumn.html index 6369fcb0..2fae9445 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LatLonColumn.html +++ b/interfaces/_influxdata_influxdb-client-apis.LatLonColumn.html @@ -1,6 +1,6 @@ LatLonColumn | Documentation

    Object type for key and column definitions

    -
    interface LatLonColumn {
        column: string;
        key: string;
    }

    Properties

    interface LatLonColumn {
        column: string;
        key: string;
    }

    Properties

    Properties

    column: string

    Column to look up Lat/Lon

    -
    key: string

    Key to determine whether the column is tag/field

    -
    +
    key: string

    Key to determine whether the column is tag/field

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LatLonColumns.html b/interfaces/_influxdata_influxdb-client-apis.LatLonColumns.html index c8b782cc..545e56b3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LatLonColumns.html +++ b/interfaces/_influxdata_influxdb-client-apis.LatLonColumns.html @@ -1,4 +1,4 @@ LatLonColumns | Documentation

    Object type to define lat/lon columns

    -
    interface LatLonColumns {
        lat: LatLonColumn;
        lon: LatLonColumn;
    }

    Properties

    lat +
    interface LatLonColumns {
        lat: LatLonColumn;
        lon: LatLonColumn;
    }

    Properties

    Properties

    +

    Properties

    diff --git a/interfaces/_influxdata_influxdb-client-apis.LinePlusSingleStatProperties.html b/interfaces/_influxdata_influxdb-client-apis.LinePlusSingleStatProperties.html index 8a6fbee8..1e274eeb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LinePlusSingleStatProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.LinePlusSingleStatProperties.html @@ -1,4 +1,4 @@ -LinePlusSingleStatProperties | Documentation
    interface LinePlusSingleStatProperties {
        adaptiveZoomHide?: boolean;
        axes: Axes;
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        position: "overlaid" | "stacked";
        prefix: string;
        queries: DashboardQuery[];
        shadeBelow?: boolean;
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        suffix: string;
        timeFormat?: string;
        type: "line-plus-single-stat";
        xColumn?: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yColumn?: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide? +LinePlusSingleStatProperties | Documentation
    interface LinePlusSingleStatProperties {
        adaptiveZoomHide?: boolean;
        axes: Axes;
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        position: "overlaid" | "stacked";
        prefix: string;
        queries: DashboardQuery[];
        shadeBelow?: boolean;
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        suffix: string;
        timeFormat?: string;
        type: "line-plus-single-stat";
        xColumn?: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yColumn?: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide?: boolean
    axes: Axes
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    decimalPlaces: DecimalPlaces
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    position: "overlaid" | "stacked"
    prefix: string
    queries: DashboardQuery[]
    shadeBelow?: boolean
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    staticLegend?: StaticLegend
    suffix: string
    timeFormat?: string
    type: "line-plus-single-stat"
    xColumn?: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yColumn?: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    +

    Properties

    adaptiveZoomHide?: boolean
    axes: Axes
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    +
    decimalPlaces: DecimalPlaces
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    position: "overlaid" | "stacked"
    prefix: string
    queries: DashboardQuery[]
    shadeBelow?: boolean
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    staticLegend?: StaticLegend
    suffix: string
    timeFormat?: string
    type: "line-plus-single-stat"
    xColumn?: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yColumn?: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LineProtocolError.html b/interfaces/_influxdata_influxdb-client-apis.LineProtocolError.html index ab40f758..9c3ee658 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LineProtocolError.html +++ b/interfaces/_influxdata_influxdb-client-apis.LineProtocolError.html @@ -1,11 +1,11 @@ -LineProtocolError | Documentation
    interface LineProtocolError {
        code:
            | "internal error"
            | "not found"
            | "conflict"
            | "invalid"
            | "empty value"
            | "unavailable";
        err?: string;
        line?: number;
        message?: string;
        op?: string;
    }

    Properties

    code +LineProtocolError | Documentation
    interface LineProtocolError {
        code:
            | "internal error"
            | "not found"
            | "conflict"
            | "invalid"
            | "empty value"
            | "unavailable";
        err?: string;
        line?: number;
        message?: string;
        op?: string;
    }

    Properties

    code:
        | "internal error"
        | "not found"
        | "conflict"
        | "invalid"
        | "empty value"
        | "unavailable"

    Code is the machine-readable error code.

    -
    err?: string

    Stack of errors that occurred during processing of the request. Useful for debugging.

    -
    line?: number

    First line in the request body that contains malformed data.

    -
    message?: string

    Human-readable message.

    -
    op?: string

    Describes the logical code operation when the error occurred. Useful for debugging.

    -
    +
    err?: string

    Stack of errors that occurred during processing of the request. Useful for debugging.

    +
    line?: number

    First line in the request body that contains malformed data.

    +
    message?: string

    Human-readable message.

    +
    op?: string

    Describes the logical code operation when the error occurred. Useful for debugging.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LineProtocolLengthError.html b/interfaces/_influxdata_influxdb-client-apis.LineProtocolLengthError.html index 0d3ae575..a00a9f77 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LineProtocolLengthError.html +++ b/interfaces/_influxdata_influxdb-client-apis.LineProtocolLengthError.html @@ -1,5 +1,5 @@ -LineProtocolLengthError | Documentation
    interface LineProtocolLengthError {
        code: "invalid";
        message: string;
    }

    Properties

    code +LineProtocolLengthError | Documentation
    interface LineProtocolLengthError {
        code: "invalid";
        message: string;
    }

    Properties

    Properties

    code: "invalid"

    Code is the machine-readable error code.

    -
    message: string

    Human-readable message.

    -
    +
    message: string

    Human-readable message.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Links.html b/interfaces/_influxdata_influxdb-client-apis.Links.html index aa5c1764..aadf76a9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Links.html +++ b/interfaces/_influxdata_influxdb-client-apis.Links.html @@ -1,5 +1,5 @@ Links | Documentation

    URI pointers for additional paged results.

    -
    interface Links {
        next?: string;
        prev?: string;
        self: string;
    }

    Properties

    interface Links {
        next?: string;
        prev?: string;
        self: string;
    }

    Properties

    Properties

    next?: string
    prev?: string
    self: string
    +

    Properties

    next?: string
    prev?: string
    self: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ListStacksRequest.html b/interfaces/_influxdata_influxdb-client-apis.ListStacksRequest.html index a77455be..0b7ebba2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ListStacksRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ListStacksRequest.html @@ -1,4 +1,4 @@ -ListStacksRequest | Documentation
    interface ListStacksRequest {
        name?: string;
        orgID: string;
        stackID?: string;
    }

    Properties

    name? +ListStacksRequest | Documentation
    interface ListStacksRequest {
        name?: string;
        orgID: string;
        stackID?: string;
    }

    Properties

    Properties

    name?: string

    The stack name. @@ -9,13 +9,13 @@

    • http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1
    -
    orgID: string

    The ID of the organization that owns the stacks. +

    orgID: string

    The ID of the organization that owns the stacks. Only returns stacks owned by this organization.

    • Doesn't require this parameter; InfluxDB only returns resources allowed by the API token.
    -
    stackID?: string

    The stack ID. +

    stackID?: string

    The stack ID. Only returns stacks with this ID.

    Repeatable. To filter for more than one stack ID, @@ -23,4 +23,4 @@

    • http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000
    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LogEvent.html b/interfaces/_influxdata_influxdb-client-apis.LogEvent.html index 55297ae1..92faf8b7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LogEvent.html +++ b/interfaces/_influxdata_influxdb-client-apis.LogEvent.html @@ -1,7 +1,7 @@ -LogEvent | Documentation
    interface LogEvent {
        message?: string;
        runID?: string;
        time?: string;
    }

    Properties

    message? +LogEvent | Documentation
    interface LogEvent {
        message?: string;
        runID?: string;
        time?: string;
    }

    Properties

    Properties

    message?: string

    A description of the event that occurred.

    -
    runID?: string

    The ID of the task run that generated the event.

    -
    time?: string

    The time (RFC3339Nano date/time format) that the event occurred.

    -
    +
    runID?: string

    The ID of the task run that generated the event.

    +
    time?: string

    The time (RFC3339Nano date/time format) that the event occurred.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.LogicalExpression.html b/interfaces/_influxdata_influxdb-client-apis.LogicalExpression.html index 71f7d4d3..f806528b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.LogicalExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.LogicalExpression.html @@ -1,6 +1,6 @@ LogicalExpression | Documentation

    Represents the rule conditions that collectively evaluate to either true or false

    -
    interface LogicalExpression {
        left?: Expression;
        operator?: string;
        right?: Expression;
        type?: string;
    }

    Properties

    interface LogicalExpression {
        left?: Expression;
        operator?: string;
        right?: Expression;
        type?: string;
    }

    Properties

    left?: Expression
    operator?: string
    right?: Expression
    type?: string
    +

    Properties

    left?: Expression
    operator?: string
    right?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Logs.html b/interfaces/_influxdata_influxdb-client-apis.Logs.html index f4b16875..3596699f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Logs.html +++ b/interfaces/_influxdata_influxdb-client-apis.Logs.html @@ -1,2 +1,2 @@ -Logs | Documentation
    interface Logs {
        events?: LogEvent[];
    }

    Properties

    Properties

    events?: LogEvent[]
    +Logs | Documentation
    interface Logs {
        events?: LogEvent[];
    }

    Properties

    Properties

    events?: LogEvent[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.MapVariableProperties.html b/interfaces/_influxdata_influxdb-client-apis.MapVariableProperties.html index e39ab7a8..f1081240 100644 --- a/interfaces/_influxdata_influxdb-client-apis.MapVariableProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.MapVariableProperties.html @@ -1,3 +1,3 @@ -MapVariableProperties | Documentation
    interface MapVariableProperties {
        type?: "map";
        values?: any;
    }

    Properties

    type? +MapVariableProperties | Documentation
    interface MapVariableProperties {
        type?: "map";
        values?: any;
    }

    Properties

    Properties

    type?: "map"
    values?: any
    +

    Properties

    type?: "map"
    values?: any
    diff --git a/interfaces/_influxdata_influxdb-client-apis.MarkdownViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.MarkdownViewProperties.html index 889fe638..7b47e933 100644 --- a/interfaces/_influxdata_influxdb-client-apis.MarkdownViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.MarkdownViewProperties.html @@ -1,4 +1,4 @@ -MarkdownViewProperties | Documentation
    interface MarkdownViewProperties {
        note: string;
        shape: "chronograf-v2";
        type: "markdown";
    }

    Properties

    note +MarkdownViewProperties | Documentation
    interface MarkdownViewProperties {
        note: string;
        shape: "chronograf-v2";
        type: "markdown";
    }

    Properties

    Properties

    note: string
    shape: "chronograf-v2"
    type: "markdown"
    +

    Properties

    note: string
    shape: "chronograf-v2"
    type: "markdown"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.MemberAssignment.html b/interfaces/_influxdata_influxdb-client-apis.MemberAssignment.html index b80138eb..21290777 100644 --- a/interfaces/_influxdata_influxdb-client-apis.MemberAssignment.html +++ b/interfaces/_influxdata_influxdb-client-apis.MemberAssignment.html @@ -1,5 +1,5 @@ MemberAssignment | Documentation

    Object property assignment

    -
    interface MemberAssignment {
        init?: Expression;
        member?: MemberExpression;
        type?: string;
    }

    Properties

    interface MemberAssignment {
        init?: Expression;
        member?: MemberExpression;
        type?: string;
    }

    Properties

    Properties

    init?: Expression
    type?: string
    +

    Properties

    init?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.MemberExpression.html b/interfaces/_influxdata_influxdb-client-apis.MemberExpression.html index 19ba17a9..a869c1fc 100644 --- a/interfaces/_influxdata_influxdb-client-apis.MemberExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.MemberExpression.html @@ -1,5 +1,5 @@ MemberExpression | Documentation

    Represents accessing a property of an object

    -
    interface MemberExpression {
        object?: Expression;
        property?: PropertyKey;
        type?: string;
    }

    Properties

    interface MemberExpression {
        object?: Expression;
        property?: PropertyKey;
        type?: string;
    }

    Properties

    Properties

    object?: Expression
    property?: PropertyKey
    type?: string
    +

    Properties

    object?: Expression
    property?: PropertyKey
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.MetadataBackup.html b/interfaces/_influxdata_influxdb-client-apis.MetadataBackup.html index 593c3dd2..d5197df3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.MetadataBackup.html +++ b/interfaces/_influxdata_influxdb-client-apis.MetadataBackup.html @@ -1,4 +1,4 @@ -MetadataBackup | Documentation
    interface MetadataBackup {
        buckets: BucketMetadataManifests;
        kv: string;
        sql: string;
    }

    Properties

    buckets +MetadataBackup | Documentation
    interface MetadataBackup {
        buckets: BucketMetadataManifests;
        kv: string;
        sql: string;
    }

    Properties

    Properties

    kv: string
    sql: string
    +

    Properties

    kv: string
    sql: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.MosaicViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.MosaicViewProperties.html index 4048542e..95501c48 100644 --- a/interfaces/_influxdata_influxdb-client-apis.MosaicViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.MosaicViewProperties.html @@ -1,4 +1,4 @@ -MosaicViewProperties | Documentation
    interface MosaicViewProperties {
        colors: string[];
        fillColumns: string[];
        generateXAxisTicks?: string[];
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        timeFormat?: string;
        type: "mosaic";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
        xPrefix: string;
        xSuffix: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yAxisLabel: string;
        yDomain: number[];
        yLabelColumns?: string[];
        yLabelColumnSeparator?: string;
        yPrefix: string;
        ySeriesColumns: string[];
        ySuffix: string;
    }

    Properties

    colors +MosaicViewProperties | Documentation
    interface MosaicViewProperties {
        colors: string[];
        fillColumns: string[];
        generateXAxisTicks?: string[];
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        timeFormat?: string;
        type: "mosaic";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
        xPrefix: string;
        xSuffix: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yAxisLabel: string;
        yDomain: number[];
        yLabelColumns?: string[];
        yLabelColumnSeparator?: string;
        yPrefix: string;
        ySeriesColumns: string[];
        ySuffix: string;
    }

    Properties

    colors: string[]

    Colors define color encoding of data into a visualization

    -
    fillColumns: string[]
    generateXAxisTicks?: string[]
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    timeFormat?: string
    type: "mosaic"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    xPrefix: string
    xSuffix: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yAxisLabel: string
    yDomain: number[]
    yLabelColumns?: string[]
    yLabelColumnSeparator?: string
    yPrefix: string
    ySeriesColumns: string[]
    ySuffix: string
    +
    fillColumns: string[]
    generateXAxisTicks?: string[]
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    timeFormat?: string
    type: "mosaic"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    xPrefix: string
    xSuffix: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yAxisLabel: string
    yDomain: number[]
    yLabelColumns?: string[]
    yLabelColumnSeparator?: string
    yPrefix: string
    ySeriesColumns: string[]
    ySuffix: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointBase.html b/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointBase.html index c97c9319..ca502c0f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointBase.html @@ -1,4 +1,4 @@ -NotificationEndpointBase | Documentation
    interface NotificationEndpointBase {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        links?: {
            labels?: string;
            members?: string;
            owners?: string;
            self?: string;
        };
        name: string;
        orgID?: string;
        status?: "active"
        | "inactive";
        type: NotificationEndpointType;
        updatedAt?: string;
        userID?: string;
    }

    Properties

    createdAt? +NotificationEndpointBase | Documentation
    interface NotificationEndpointBase {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        links?: {
            labels?: string;
            members?: string;
            owners?: string;
            self?: string;
        };
        name: string;
        orgID?: string;
        status?: "active"
        | "inactive";
        type: NotificationEndpointType;
        updatedAt?: string;
        userID?: string;
    }

    Properties

    Properties

    createdAt?: string
    description?: string

    An optional description of the notification endpoint.

    -
    id?: string
    labels?: Labels
    links?: { labels?: string; members?: string; owners?: string; self?: string }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this endpoint.

      +

    Properties

    createdAt?: string
    description?: string

    An optional description of the notification endpoint.

    +
    id?: string
    labels?: Labels
    links?: { labels?: string; members?: string; owners?: string; self?: string }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this endpoint.

    • Optionalmembers?: string

      URL to retrieve members for this endpoint.

    • Optionalowners?: string

      URL to retrieve owners for this endpoint.

    • Optionalself?: string

      URL for this endpoint.

      -
    name: string
    orgID?: string
    status?: "active" | "inactive"

    The status of the endpoint.

    -
    updatedAt?: string
    userID?: string
    +
    name: string
    orgID?: string
    status?: "active" | "inactive"

    The status of the endpoint.

    +
    updatedAt?: string
    userID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointUpdate.html b/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointUpdate.html index 990021fb..50ad081a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointUpdate.html +++ b/interfaces/_influxdata_influxdb-client-apis.NotificationEndpointUpdate.html @@ -1,4 +1,4 @@ -NotificationEndpointUpdate | Documentation
    interface NotificationEndpointUpdate {
        description?: string;
        name?: string;
        status?: "active" | "inactive";
    }

    Properties

    description? +NotificationEndpointUpdate | Documentation
    interface NotificationEndpointUpdate {
        description?: string;
        name?: string;
        status?: "active" | "inactive";
    }

    Properties

    description?: string
    name?: string
    status?: "active" | "inactive"
    +

    Properties

    description?: string
    name?: string
    status?: "active" | "inactive"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.NotificationEndpoints.html b/interfaces/_influxdata_influxdb-client-apis.NotificationEndpoints.html index 4aded208..74e3b830 100644 --- a/interfaces/_influxdata_influxdb-client-apis.NotificationEndpoints.html +++ b/interfaces/_influxdata_influxdb-client-apis.NotificationEndpoints.html @@ -1,3 +1,3 @@ -NotificationEndpoints | Documentation
    interface NotificationEndpoints {
        links?: Links;
        notificationEndpoints?: NotificationEndpointDiscriminator[];
    }

    Properties

    links? +NotificationEndpoints | Documentation
    interface NotificationEndpoints {
        links?: Links;
        notificationEndpoints?: NotificationEndpointDiscriminator[];
    }

    Properties

    links?: Links
    notificationEndpoints?: NotificationEndpointDiscriminator[]
    +

    Properties

    links?: Links
    notificationEndpoints?: NotificationEndpointDiscriminator[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.NotificationRuleBase.html b/interfaces/_influxdata_influxdb-client-apis.NotificationRuleBase.html index 39edd9aa..2b964464 100644 --- a/interfaces/_influxdata_influxdb-client-apis.NotificationRuleBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.NotificationRuleBase.html @@ -1,4 +1,4 @@ -NotificationRuleBase | Documentation
    interface NotificationRuleBase {
        createdAt?: string;
        description?: string;
        endpointID: string;
        every?: string;
        id?: string;
        labels?: Labels;
        lastRunError?: string;
        lastRunStatus?: "failed" | "success" | "canceled";
        latestCompleted?: string;
        limit?: number;
        limitEvery?: number;
        links?: {
            labels?: string;
            members?: string;
            owners?: string;
            query?: string;
            self?: string;
        };
        name: string;
        offset?: string;
        orgID: string;
        ownerID?: string;
        runbookLink?: string;
        sleepUntil?: string;
        status: TaskStatusType;
        statusRules: StatusRule[];
        tagRules?: TagRule[];
        taskID?: string;
        updatedAt?: string;
    }

    Properties

    createdAt? +NotificationRuleBase | Documentation
    interface NotificationRuleBase {
        createdAt?: string;
        description?: string;
        endpointID: string;
        every?: string;
        id?: string;
        labels?: Labels;
        lastRunError?: string;
        lastRunStatus?: "failed" | "success" | "canceled";
        latestCompleted?: string;
        limit?: number;
        limitEvery?: number;
        links?: {
            labels?: string;
            members?: string;
            owners?: string;
            query?: string;
            self?: string;
        };
        name: string;
        offset?: string;
        orgID: string;
        ownerID?: string;
        runbookLink?: string;
        sleepUntil?: string;
        status: TaskStatusType;
        statusRules: StatusRule[];
        tagRules?: TagRule[];
        taskID?: string;
        updatedAt?: string;
    }

    Properties

    createdAt?: string
    description?: string

    An optional description of the notification rule.

    -
    endpointID: string
    every?: string

    The notification repetition interval.

    -
    id?: string
    labels?: Labels
    lastRunError?: string
    lastRunStatus?: "failed" | "success" | "canceled"
    latestCompleted?: string

    A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

    -
    limit?: number

    Don't notify me more than times every seconds. If set, limitEvery cannot be empty.

    -
    limitEvery?: number

    Don't notify me more than times every seconds. If set, limit cannot be empty.

    -
    links?: {
        labels?: string;
        members?: string;
        owners?: string;
        query?: string;
        self?: string;
    }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this notification rule.

      +

    Properties

    createdAt?: string
    description?: string

    An optional description of the notification rule.

    +
    endpointID: string
    every?: string

    The notification repetition interval.

    +
    id?: string
    labels?: Labels
    lastRunError?: string
    lastRunStatus?: "failed" | "success" | "canceled"
    latestCompleted?: string

    A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

    +
    limit?: number

    Don't notify me more than times every seconds. If set, limitEvery cannot be empty.

    +
    limitEvery?: number

    Don't notify me more than times every seconds. If set, limit cannot be empty.

    +
    links?: {
        labels?: string;
        members?: string;
        owners?: string;
        query?: string;
        self?: string;
    }

    Type declaration

    • Optionallabels?: string

      URL to retrieve labels for this notification rule.

    • Optionalmembers?: string

      URL to retrieve members for this notification rule.

    • Optionalowners?: string

      URL to retrieve owners for this notification rule.

    • Optionalquery?: string

      URL to retrieve flux script for this notification rule.

    • Optionalself?: string

      URL for this endpoint.

      -
    name: string

    Human-readable name describing the notification rule.

    -
    offset?: string

    Duration to delay after the schedule, before executing check.

    -
    orgID: string

    The ID of the organization that owns this notification rule.

    -
    ownerID?: string

    The ID of creator used to create this notification rule.

    -
    runbookLink?: string
    sleepUntil?: string
    statusRules: StatusRule[]

    List of status rules the notification rule attempts to match.

    -
    tagRules?: TagRule[]

    List of tag rules the notification rule attempts to match.

    -
    taskID?: string

    The ID of the task associated with this notification rule.

    -
    updatedAt?: string
    +
    name: string

    Human-readable name describing the notification rule.

    +
    offset?: string

    Duration to delay after the schedule, before executing check.

    +
    orgID: string

    The ID of the organization that owns this notification rule.

    +
    ownerID?: string

    The ID of creator used to create this notification rule.

    +
    runbookLink?: string
    sleepUntil?: string
    statusRules: StatusRule[]

    List of status rules the notification rule attempts to match.

    +
    tagRules?: TagRule[]

    List of tag rules the notification rule attempts to match.

    +
    taskID?: string

    The ID of the task associated with this notification rule.

    +
    updatedAt?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.NotificationRuleUpdate.html b/interfaces/_influxdata_influxdb-client-apis.NotificationRuleUpdate.html index adb5f276..cbd58c5c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.NotificationRuleUpdate.html +++ b/interfaces/_influxdata_influxdb-client-apis.NotificationRuleUpdate.html @@ -1,4 +1,4 @@ -NotificationRuleUpdate | Documentation
    interface NotificationRuleUpdate {
        description?: string;
        name?: string;
        status?: "active" | "inactive";
    }

    Properties

    description? +NotificationRuleUpdate | Documentation
    interface NotificationRuleUpdate {
        description?: string;
        name?: string;
        status?: "active" | "inactive";
    }

    Properties

    description?: string
    name?: string
    status?: "active" | "inactive"
    +

    Properties

    description?: string
    name?: string
    status?: "active" | "inactive"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.NotificationRules.html b/interfaces/_influxdata_influxdb-client-apis.NotificationRules.html index 0cdc7693..6ee9fc0a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.NotificationRules.html +++ b/interfaces/_influxdata_influxdb-client-apis.NotificationRules.html @@ -1,3 +1,3 @@ -NotificationRules | Documentation
    interface NotificationRules {
        links?: Links;
        notificationRules?: NotificationRuleDiscriminator[];
    }

    Properties

    links? +NotificationRules | Documentation
    interface NotificationRules {
        links?: Links;
        notificationRules?: NotificationRuleDiscriminator[];
    }

    Properties

    links?: Links
    notificationRules?: NotificationRuleDiscriminator[]
    +

    Properties

    links?: Links
    notificationRules?: NotificationRuleDiscriminator[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ObjectExpression.html b/interfaces/_influxdata_influxdb-client-apis.ObjectExpression.html index 30212884..f71fea3c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ObjectExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.ObjectExpression.html @@ -1,5 +1,5 @@ ObjectExpression | Documentation

    Allows the declaration of an anonymous object within a declaration

    -
    interface ObjectExpression {
        properties?: Property[];
        type?: string;
    }

    Properties

    interface ObjectExpression {
        properties?: Property[];
        type?: string;
    }

    Properties

    Properties

    properties?: Property[]

    Object properties

    -
    type?: string
    +
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.OnboardingRequest.html b/interfaces/_influxdata_influxdb-client-apis.OnboardingRequest.html index 0e0d1ae4..82752324 100644 --- a/interfaces/_influxdata_influxdb-client-apis.OnboardingRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.OnboardingRequest.html @@ -1,10 +1,10 @@ -OnboardingRequest | Documentation
    interface OnboardingRequest {
        bucket: string;
        org: string;
        password?: string;
        retentionPeriodHrs?: number;
        retentionPeriodSeconds?: number;
        token?: string;
        username: string;
    }

    Properties

    bucket +OnboardingRequest | Documentation
    interface OnboardingRequest {
        bucket: string;
        org: string;
        password?: string;
        retentionPeriodHrs?: number;
        retentionPeriodSeconds?: number;
        token?: string;
        username: string;
    }

    Properties

    bucket: string
    org: string
    password?: string
    retentionPeriodHrs?: number

    Retention period in nanoseconds for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use retentionPeriodSeconds

    -
    retentionPeriodSeconds?: number
    token?: string

    Authentication token to set on the initial user. If not specified, the server will generate a token.

    -
    username: string
    +

    Properties

    bucket: string
    org: string
    password?: string
    retentionPeriodHrs?: number

    Retention period in nanoseconds for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use retentionPeriodSeconds

    +
    retentionPeriodSeconds?: number
    token?: string

    Authentication token to set on the initial user. If not specified, the server will generate a token.

    +
    username: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.OnboardingResponse.html b/interfaces/_influxdata_influxdb-client-apis.OnboardingResponse.html index d55357d8..5f354db7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.OnboardingResponse.html +++ b/interfaces/_influxdata_influxdb-client-apis.OnboardingResponse.html @@ -1,5 +1,5 @@ -OnboardingResponse | Documentation
    interface OnboardingResponse {
        auth?: Authorization;
        bucket?: Bucket;
        org?: Organization;
        user?: UserResponse;
    }

    Properties

    auth? +OnboardingResponse | Documentation
    interface OnboardingResponse {
        auth?: Authorization;
        bucket?: Bucket;
        org?: Organization;
        user?: UserResponse;
    }

    Properties

    Properties

    bucket?: Bucket
    +

    Properties

    bucket?: Bucket
    diff --git a/interfaces/_influxdata_influxdb-client-apis.OptionStatement.html b/interfaces/_influxdata_influxdb-client-apis.OptionStatement.html index 3eb526c8..7fd6088e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.OptionStatement.html +++ b/interfaces/_influxdata_influxdb-client-apis.OptionStatement.html @@ -1,4 +1,4 @@ OptionStatement | Documentation

    A single variable declaration

    -
    interface OptionStatement {
        assignment?: VariableAssignment | MemberAssignment;
        type?: string;
    }

    Properties

    interface OptionStatement {
        assignment?: VariableAssignment | MemberAssignment;
        type?: string;
    }

    Properties

    Properties

    type?: string
    +

    Properties

    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Organization.html b/interfaces/_influxdata_influxdb-client-apis.Organization.html index 9cd63001..295bc5dd 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Organization.html +++ b/interfaces/_influxdata_influxdb-client-apis.Organization.html @@ -1,9 +1,9 @@ -Organization | Documentation
    interface Organization {
        createdAt?: string;
        description?: string;
        id?: string;
        links?: {
            buckets?: string;
            dashboards?: string;
            labels?: string;
            members?: string;
            owners?: string;
            secrets?: string;
            self?: string;
            tasks?: string;
        };
        name: string;
        status?: "active"
        | "inactive";
        updatedAt?: string;
    }

    Properties

    createdAt? +Organization | Documentation
    interface Organization {
        createdAt?: string;
        description?: string;
        id?: string;
        links?: {
            buckets?: string;
            dashboards?: string;
            labels?: string;
            members?: string;
            owners?: string;
            secrets?: string;
            self?: string;
            tasks?: string;
        };
        name: string;
        status?: "active"
        | "inactive";
        updatedAt?: string;
    }

    Properties

    createdAt?: string
    description?: string
    id?: string
    links?: {
        buckets?: string;
        dashboards?: string;
        labels?: string;
        members?: string;
        owners?: string;
        secrets?: string;
        self?: string;
        tasks?: string;
    }
    name: string
    status?: "active" | "inactive"

    If inactive the organization is inactive.

    -
    updatedAt?: string
    +

    Properties

    createdAt?: string
    description?: string
    id?: string
    links?: {
        buckets?: string;
        dashboards?: string;
        labels?: string;
        members?: string;
        owners?: string;
        secrets?: string;
        self?: string;
        tasks?: string;
    }
    name: string
    status?: "active" | "inactive"

    If inactive the organization is inactive.

    +
    updatedAt?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Organizations.html b/interfaces/_influxdata_influxdb-client-apis.Organizations.html index b2dd011d..514719b8 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Organizations.html +++ b/interfaces/_influxdata_influxdb-client-apis.Organizations.html @@ -1,3 +1,3 @@ -Organizations | Documentation
    interface Organizations {
        links?: Links;
        orgs?: Organization[];
    }

    Properties

    links? +Organizations | Documentation
    interface Organizations {
        links?: Links;
        orgs?: Organization[];
    }

    Properties

    Properties

    links?: Links
    orgs?: Organization[]
    +

    Properties

    links?: Links
    orgs?: Organization[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Package.html b/interfaces/_influxdata_influxdb-client-apis.Package.html index a20b87b2..f2ae524e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Package.html +++ b/interfaces/_influxdata_influxdb-client-apis.Package.html @@ -1,9 +1,9 @@ Package | Documentation

    Represents a complete package source tree.

    -
    interface Package {
        files?: File[];
        package?: string;
        path?: string;
        type?: string;
    }

    Properties

    interface Package {
        files?: File[];
        package?: string;
        path?: string;
        type?: string;
    }

    Properties

    files?: File[]

    Package files

    -
    package?: string

    Package name

    -
    path?: string

    Package import path

    -
    type?: string
    +
    package?: string

    Package name

    +
    path?: string

    Package import path

    +
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PackageClause.html b/interfaces/_influxdata_influxdb-client-apis.PackageClause.html index 660ea597..c2a99889 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PackageClause.html +++ b/interfaces/_influxdata_influxdb-client-apis.PackageClause.html @@ -1,4 +1,4 @@ PackageClause | Documentation

    Defines a package identifier

    -
    interface PackageClause {
        name?: Identifier;
        type?: string;
    }

    Properties

    interface PackageClause {
        name?: Identifier;
        type?: string;
    }

    Properties

    Properties

    name?: Identifier
    type?: string
    +

    Properties

    name?: Identifier
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PagerDutyNotificationRuleBase.html b/interfaces/_influxdata_influxdb-client-apis.PagerDutyNotificationRuleBase.html index 42d1793f..1f0f0494 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PagerDutyNotificationRuleBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.PagerDutyNotificationRuleBase.html @@ -1,3 +1,3 @@ -PagerDutyNotificationRuleBase | Documentation
    interface PagerDutyNotificationRuleBase {
        messageTemplate: string;
        type: "pagerduty";
    }

    Properties

    messageTemplate +PagerDutyNotificationRuleBase | Documentation
    interface PagerDutyNotificationRuleBase {
        messageTemplate: string;
        type: "pagerduty";
    }

    Properties

    Properties

    messageTemplate: string
    type: "pagerduty"
    +

    Properties

    messageTemplate: string
    type: "pagerduty"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ParenExpression.html b/interfaces/_influxdata_influxdb-client-apis.ParenExpression.html index 3370926e..240f8c09 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ParenExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.ParenExpression.html @@ -1,4 +1,4 @@ ParenExpression | Documentation

    Represents an expression wrapped in parenthesis

    -
    interface ParenExpression {
        expression?: Expression;
        type?: string;
    }

    Properties

    interface ParenExpression {
        expression?: Expression;
        type?: string;
    }

    Properties

    Properties

    expression?: Expression
    type?: string
    +

    Properties

    expression?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PasswordResetBody.html b/interfaces/_influxdata_influxdb-client-apis.PasswordResetBody.html index c5518f7f..33db126c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PasswordResetBody.html +++ b/interfaces/_influxdata_influxdb-client-apis.PasswordResetBody.html @@ -1,2 +1,2 @@ -PasswordResetBody | Documentation
    interface PasswordResetBody {
        password: string;
    }

    Properties

    Properties

    password: string
    +PasswordResetBody | Documentation
    interface PasswordResetBody {
        password: string;
    }

    Properties

    Properties

    password: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchAuthorizationsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchAuthorizationsIDRequest.html index ad5e34da..c97dc01f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchAuthorizationsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchAuthorizationsIDRequest.html @@ -1,5 +1,5 @@ -PatchAuthorizationsIDRequest | Documentation
    interface PatchAuthorizationsIDRequest {
        authID: string;
        body: AuthorizationUpdateRequest;
    }

    Properties

    authID +PatchAuthorizationsIDRequest | Documentation
    interface PatchAuthorizationsIDRequest {
        authID: string;
        body: AuthorizationUpdateRequest;
    }

    Properties

    Properties

    authID: string

    The ID of the authorization to update.

    -

    Authorization to update

    -
    +

    Authorization to update

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchBucketRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchBucketRequest.html index b0af6b2d..9f5cb26f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchBucketRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchBucketRequest.html @@ -1,7 +1,7 @@ PatchBucketRequest | Documentation

    An object that contains updated bucket properties to apply.

    -
    interface PatchBucketRequest {
        description?: string;
        name?: string;
        retentionRules?: PatchRetentionRules;
    }

    Properties

    interface PatchBucketRequest {
        description?: string;
        name?: string;
        retentionRules?: PatchRetentionRules;
    }

    Properties

    description?: string

    A description of the bucket.

    -
    name?: string

    The name of the bucket.

    -
    retentionRules?: PatchRetentionRules
    +
    name?: string

    The name of the bucket.

    +
    retentionRules?: PatchRetentionRules
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchBucketsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchBucketsIDRequest.html index b8d5cf47..64dca198 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchBucketsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchBucketsIDRequest.html @@ -1,5 +1,5 @@ -PatchBucketsIDRequest | Documentation
    interface PatchBucketsIDRequest {
        body: PatchBucketRequest;
        bucketID: string;
    }

    Properties

    body +PatchBucketsIDRequest | Documentation
    interface PatchBucketsIDRequest {
        body: PatchBucketRequest;
        bucketID: string;
    }

    Properties

    Properties

    The bucket update to apply.

    -
    bucketID: string

    The bucket ID.

    -
    +
    bucketID: string

    The bucket ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchChecksIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchChecksIDRequest.html index 3409aed2..7e824212 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchChecksIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchChecksIDRequest.html @@ -1,5 +1,5 @@ -PatchChecksIDRequest | Documentation
    interface PatchChecksIDRequest {
        body: CheckPatch;
        checkID: string;
    }

    Properties

    body +PatchChecksIDRequest | Documentation
    interface PatchChecksIDRequest {
        body: CheckPatch;
        checkID: string;
    }

    Properties

    Properties

    Check update to apply

    -
    checkID: string

    The check ID.

    -
    +
    checkID: string

    The check ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchDBRPIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchDBRPIDRequest.html index e71dff3f..d903d7e7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchDBRPIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchDBRPIDRequest.html @@ -1,9 +1,9 @@ -PatchDBRPIDRequest | Documentation
    interface PatchDBRPIDRequest {
        body: DBRPUpdate;
        dbrpID: string;
        org?: string;
        orgID?: string;
    }

    Properties

    body +PatchDBRPIDRequest | Documentation
    interface PatchDBRPIDRequest {
        body: DBRPUpdate;
        dbrpID: string;
        org?: string;
        orgID?: string;
    }

    Properties

    Properties

    Database retention policy update to apply

    -
    dbrpID: string

    The database retention policy mapping.

    -
    org?: string

    Specifies the organization name of the mapping

    -
    orgID?: string

    Specifies the organization ID of the mapping

    -
    +
    dbrpID: string

    The database retention policy mapping.

    +
    org?: string

    Specifies the organization name of the mapping

    +
    orgID?: string

    Specifies the organization ID of the mapping

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDRequest.html index 4b193fe6..9c79816b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDRequest.html @@ -1,7 +1,7 @@ -PatchDashboardsIDCellsIDRequest | Documentation
    interface PatchDashboardsIDCellsIDRequest {
        body: CellUpdate;
        cellID: string;
        dashboardID: string;
    }

    Properties

    body +PatchDashboardsIDCellsIDRequest | Documentation
    interface PatchDashboardsIDCellsIDRequest {
        body: CellUpdate;
        cellID: string;
        dashboardID: string;
    }

    Properties

    entity body

    -
    cellID: string

    The ID of the cell to update.

    -
    dashboardID: string

    The ID of the dashboard to update.

    -
    +
    cellID: string

    The ID of the cell to update.

    +
    dashboardID: string

    The ID of the dashboard to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDViewRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDViewRequest.html index 235f4898..90c8843d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDViewRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDCellsIDViewRequest.html @@ -1,7 +1,7 @@ -PatchDashboardsIDCellsIDViewRequest | Documentation
    interface PatchDashboardsIDCellsIDViewRequest {
        body: View;
        cellID: string;
        dashboardID: string;
    }

    Properties

    body +PatchDashboardsIDCellsIDViewRequest | Documentation
    interface PatchDashboardsIDCellsIDViewRequest {
        body: View;
        cellID: string;
        dashboardID: string;
    }

    Properties

    body: View

    entity body

    -
    cellID: string

    The ID of the cell to update.

    -
    dashboardID: string

    The ID of the dashboard to update.

    -
    +
    cellID: string

    The ID of the cell to update.

    +
    dashboardID: string

    The ID of the dashboard to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDRequest.html index 05fb3a3a..870e958c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchDashboardsIDRequest.html @@ -1,8 +1,8 @@ -PatchDashboardsIDRequest | Documentation
    interface PatchDashboardsIDRequest {
        body: {
            cells?: CellWithViewProperties;
            description?: string;
            name?: string;
        };
        dashboardID: string;
    }

    Properties

    body +PatchDashboardsIDRequest | Documentation
    interface PatchDashboardsIDRequest {
        body: {
            cells?: CellWithViewProperties;
            description?: string;
            name?: string;
        };
        dashboardID: string;
    }

    Properties

    Properties

    body: { cells?: CellWithViewProperties; description?: string; name?: string }

    Patching of a dashboard

    Type declaration

    • Optionalcells?: CellWithViewProperties

      optional, when provided will replace all existing cells with the cells provided

    • Optionaldescription?: string

      optional, when provided will replace the description

    • Optionalname?: string

      optional, when provided will replace the name

      -
    dashboardID: string

    The ID of the dashboard to update.

    -
    +
    dashboardID: string

    The ID of the dashboard to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchLabelsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchLabelsIDRequest.html index ff8f1a77..5504f44a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchLabelsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchLabelsIDRequest.html @@ -1,5 +1,5 @@ -PatchLabelsIDRequest | Documentation
    interface PatchLabelsIDRequest {
        body: LabelUpdate;
        labelID: string;
    }

    Properties

    body +PatchLabelsIDRequest | Documentation
    interface PatchLabelsIDRequest {
        body: LabelUpdate;
        labelID: string;
    }

    Properties

    Properties

    A label update.

    -
    labelID: string

    The ID of the label to update.

    -
    +
    labelID: string

    The ID of the label to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchNotificationEndpointsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchNotificationEndpointsIDRequest.html index 61adb490..731d0907 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchNotificationEndpointsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchNotificationEndpointsIDRequest.html @@ -1,5 +1,5 @@ -PatchNotificationEndpointsIDRequest | Documentation
    interface PatchNotificationEndpointsIDRequest {
        body: NotificationEndpointUpdate;
        endpointID: string;
    }

    Properties

    body +PatchNotificationEndpointsIDRequest | Documentation
    interface PatchNotificationEndpointsIDRequest {
        body: NotificationEndpointUpdate;
        endpointID: string;
    }

    Properties

    Properties

    Check update to apply

    -
    endpointID: string

    The notification endpoint ID.

    -
    +
    endpointID: string

    The notification endpoint ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchNotificationRulesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchNotificationRulesIDRequest.html index 55151097..474ce037 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchNotificationRulesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchNotificationRulesIDRequest.html @@ -1,5 +1,5 @@ -PatchNotificationRulesIDRequest | Documentation
    interface PatchNotificationRulesIDRequest {
        body: NotificationRuleUpdate;
        ruleID: string;
    }

    Properties

    body +PatchNotificationRulesIDRequest | Documentation
    interface PatchNotificationRulesIDRequest {
        body: NotificationRuleUpdate;
        ruleID: string;
    }

    Properties

    Properties

    Notification rule update to apply

    -
    ruleID: string

    The notification rule ID.

    -
    +
    ruleID: string

    The notification rule ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchOrganizationRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchOrganizationRequest.html index 612c49ab..848dc7fe 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchOrganizationRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchOrganizationRequest.html @@ -1,6 +1,6 @@ PatchOrganizationRequest | Documentation

    An object that contains updated organization properties to apply.

    -
    interface PatchOrganizationRequest {
        description?: string;
        name?: string;
    }

    Properties

    interface PatchOrganizationRequest {
        description?: string;
        name?: string;
    }

    Properties

    Properties

    description?: string

    The description of the organization.

    -
    name?: string

    The name of the organization.

    -
    +
    name?: string

    The name of the organization.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDRequest.html index a8b3e476..1d1ac8da 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDRequest.html @@ -1,5 +1,5 @@ -PatchOrgsIDRequest | Documentation
    interface PatchOrgsIDRequest {
        body: PatchOrganizationRequest;
        orgID: string;
    }

    Properties

    body +PatchOrgsIDRequest | Documentation
    interface PatchOrgsIDRequest {
        body: PatchOrganizationRequest;
        orgID: string;
    }

    Properties

    Properties

    The organization update to apply.

    -
    orgID: string

    The ID of the organization to update.

    -
    +
    orgID: string

    The ID of the organization to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDSecretsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDSecretsRequest.html index b17489db..087684c9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDSecretsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchOrgsIDSecretsRequest.html @@ -1,5 +1,5 @@ -PatchOrgsIDSecretsRequest | Documentation
    interface PatchOrgsIDSecretsRequest {
        body: any;
        orgID: string;
    }

    Properties

    body +PatchOrgsIDSecretsRequest | Documentation
    interface PatchOrgsIDSecretsRequest {
        body: any;
        orgID: string;
    }

    Properties

    Properties

    body: any

    Secret key value pairs to update/add

    -
    orgID: string

    The organization ID.

    -
    +
    orgID: string

    The organization ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchRemoteConnectionByIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchRemoteConnectionByIDRequest.html index 4e28bfa1..068bfe35 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchRemoteConnectionByIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchRemoteConnectionByIDRequest.html @@ -1,4 +1,4 @@ -PatchRemoteConnectionByIDRequest | Documentation
    interface PatchRemoteConnectionByIDRequest {
        body: RemoteConnectionUpdateRequest;
        remoteID: string;
    }

    Properties

    body +PatchRemoteConnectionByIDRequest | Documentation
    interface PatchRemoteConnectionByIDRequest {
        body: RemoteConnectionUpdateRequest;
        remoteID: string;
    }

    Properties

    Properties

    entity body

    -
    remoteID: string
    +
    remoteID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchReplicationByIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchReplicationByIDRequest.html index e1857198..322632d7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchReplicationByIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchReplicationByIDRequest.html @@ -1,6 +1,6 @@ -PatchReplicationByIDRequest | Documentation
    interface PatchReplicationByIDRequest {
        body: ReplicationUpdateRequest;
        replicationID: string;
        validate?: any;
    }

    Properties

    body +PatchReplicationByIDRequest | Documentation
    interface PatchReplicationByIDRequest {
        body: ReplicationUpdateRequest;
        replicationID: string;
        validate?: any;
    }

    Properties

    entity body

    -
    replicationID: string
    validate?: any

    If true, validate the updated information, but don't save it.

    -
    +
    replicationID: string
    validate?: any

    If true, validate the updated information, but don't save it.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchRetentionRule.html b/interfaces/_influxdata_influxdb-client-apis.PatchRetentionRule.html index 2811faab..c9f2ab08 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchRetentionRule.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchRetentionRule.html @@ -1,10 +1,10 @@ -PatchRetentionRule | Documentation
    interface PatchRetentionRule {
        everySeconds: number;
        shardGroupDurationSeconds?: number;
        type?: "expire";
    }

    Properties

    everySeconds +PatchRetentionRule | Documentation
    interface PatchRetentionRule {
        everySeconds: number;
        shardGroupDurationSeconds?: number;
        type?: "expire";
    }

    Properties

    everySeconds: number

    The number of seconds to keep data. Default duration is 2592000 (30 days). 0 represents infinite retention.

    -
    shardGroupDurationSeconds?: number
    shardGroupDurationSeconds?: number

    The shard group duration. The number of seconds that each shard group covers.

    type?: "expire"
    +
    type?: "expire"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchScrapersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchScrapersIDRequest.html index 7416b725..44f75b0a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchScrapersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchScrapersIDRequest.html @@ -1,5 +1,5 @@ -PatchScrapersIDRequest | Documentation
    interface PatchScrapersIDRequest {
        body: ScraperTargetRequest;
        scraperTargetID: string;
    }

    Properties

    body +PatchScrapersIDRequest | Documentation
    interface PatchScrapersIDRequest {
        body: ScraperTargetRequest;
        scraperTargetID: string;
    }

    Properties

    Scraper target update to apply

    -
    scraperTargetID: string

    The identifier of the scraper target.

    -
    +
    scraperTargetID: string

    The identifier of the scraper target.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDAddLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDAddLabelsRequest.html index 65803e60..c1343f01 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDAddLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDAddLabelsRequest.html @@ -1,7 +1,7 @@ -PatchScriptsIDAddLabelsRequest | Documentation
    interface PatchScriptsIDAddLabelsRequest {
        body: { labels?: string[] };
        scriptID: string;
    }

    Properties

    body +PatchScriptsIDAddLabelsRequest | Documentation
    interface PatchScriptsIDAddLabelsRequest {
        body: { labels?: string[] };
        scriptID: string;
    }

    Properties

    Properties

    body: { labels?: string[] }

    The labels to add to the script.

    Type declaration

    • Optionallabels?: string[]

      A list of label names to add.

      -
    scriptID: string

    The script ID. +

    scriptID: string

    The script ID. Specifies the script to add labels to.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRemoveLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRemoveLabelsRequest.html index 2a2a6c71..1d8df2e5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRemoveLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRemoveLabelsRequest.html @@ -1,6 +1,6 @@ -PatchScriptsIDRemoveLabelsRequest | Documentation
    interface PatchScriptsIDRemoveLabelsRequest {
        body: { labels?: string[] };
        scriptID: string;
    }

    Properties

    body +PatchScriptsIDRemoveLabelsRequest | Documentation
    interface PatchScriptsIDRemoveLabelsRequest {
        body: { labels?: string[] };
        scriptID: string;
    }

    Properties

    Properties

    body: { labels?: string[] }

    The labels to remove from the script.

    Type declaration

    • Optionallabels?: string[]

      A list of label names to remove.

      -
    scriptID: string

    A script ID. Specifies the script to remove labels from.

    -
    +
    scriptID: string

    A script ID. Specifies the script to remove labels from.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRequest.html index 2d814958..0b6f9ca2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchScriptsIDRequest.html @@ -1,6 +1,6 @@ -PatchScriptsIDRequest | Documentation
    interface PatchScriptsIDRequest {
        body: ScriptUpdateRequest;
        scriptID: string;
    }

    Properties

    body +PatchScriptsIDRequest | Documentation
    interface PatchScriptsIDRequest {
        body: ScriptUpdateRequest;
        scriptID: string;
    }

    Properties

    Properties

    The script update to apply.

    -
    scriptID: string

    A script ID. +

    scriptID: string

    A script ID. Specifies the script to update.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchSourcesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchSourcesIDRequest.html index 883bae28..2a6df250 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchSourcesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchSourcesIDRequest.html @@ -1,5 +1,5 @@ -PatchSourcesIDRequest | Documentation
    interface PatchSourcesIDRequest {
        body: Source;
        sourceID: string;
    }

    Properties

    body +PatchSourcesIDRequest | Documentation
    interface PatchSourcesIDRequest {
        body: Source;
        sourceID: string;
    }

    Properties

    Properties

    body: Source

    Source update

    -
    sourceID: string

    The source ID.

    -
    +
    sourceID: string

    The source ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchTasksIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchTasksIDRequest.html index d158a890..5acb7abc 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchTasksIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchTasksIDRequest.html @@ -1,5 +1,5 @@ -PatchTasksIDRequest | Documentation
    interface PatchTasksIDRequest {
        body: TaskUpdateRequest;
        taskID: string;
    }

    Properties

    body +PatchTasksIDRequest | Documentation
    interface PatchTasksIDRequest {
        body: TaskUpdateRequest;
        taskID: string;
    }

    Properties

    Properties

    An object that contains updated task properties to apply.

    -
    taskID: string

    The ID of the task to update.

    -
    +
    taskID: string

    The ID of the task to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchUsersIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchUsersIDRequest.html index c762ad7d..5ea5bb7f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchUsersIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchUsersIDRequest.html @@ -1,5 +1,5 @@ -PatchUsersIDRequest | Documentation
    interface PatchUsersIDRequest {
        body: User;
        userID: string;
    }

    Properties

    body +PatchUsersIDRequest | Documentation
    interface PatchUsersIDRequest {
        body: User;
        userID: string;
    }

    Properties

    Properties

    body: User

    User update to apply

    -
    userID: string

    The ID of the user to update.

    -
    +
    userID: string

    The ID of the user to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PatchVariablesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PatchVariablesIDRequest.html index fd7ae979..fd949412 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PatchVariablesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PatchVariablesIDRequest.html @@ -1,5 +1,5 @@ -PatchVariablesIDRequest | Documentation
    interface PatchVariablesIDRequest {
        body: Variable;
        variableID: string;
    }

    Properties

    body +PatchVariablesIDRequest | Documentation
    interface PatchVariablesIDRequest {
        body: Variable;
        variableID: string;
    }

    Properties

    Properties

    body: Variable

    Variable update to apply

    -
    variableID: string

    The variable ID.

    -
    +
    variableID: string

    The variable ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Permission.html b/interfaces/_influxdata_influxdb-client-apis.Permission.html index 2bc1bbaf..ec6c1315 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Permission.html +++ b/interfaces/_influxdata_influxdb-client-apis.Permission.html @@ -1,3 +1,3 @@ -Permission | Documentation
    interface Permission {
        action: "write" | "read";
        resource: Resource;
    }

    Properties

    action +Permission | Documentation
    interface Permission {
        action: "write" | "read";
        resource: Resource;
    }

    Properties

    Properties

    action: "write" | "read"
    resource: Resource
    +

    Properties

    action: "write" | "read"
    resource: Resource
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PipeExpression.html b/interfaces/_influxdata_influxdb-client-apis.PipeExpression.html index 8b95650d..ec8ce727 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PipeExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.PipeExpression.html @@ -1,5 +1,5 @@ PipeExpression | Documentation

    Call expression with pipe argument

    -
    interface PipeExpression {
        argument?: Expression;
        call?: CallExpression;
        type?: string;
    }

    Properties

    interface PipeExpression {
        argument?: Expression;
        call?: CallExpression;
        type?: string;
    }

    Properties

    Properties

    argument?: Expression
    type?: string
    +

    Properties

    argument?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PipeLiteral.html b/interfaces/_influxdata_influxdb-client-apis.PipeLiteral.html index 6671f355..b9b2031a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PipeLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.PipeLiteral.html @@ -1,3 +1,3 @@ PipeLiteral | Documentation

    Represents a specialized literal value, indicating the left hand value of a pipe expression

    -
    interface PipeLiteral {
        type?: string;
    }

    Properties

    Properties

    type?: string
    +
    interface PipeLiteral {
        type?: string;
    }

    Properties

    Properties

    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostAuthorizationsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostAuthorizationsRequest.html index b2632350..668e80e8 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostAuthorizationsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostAuthorizationsRequest.html @@ -1,3 +1,3 @@ -PostAuthorizationsRequest | Documentation
    interface PostAuthorizationsRequest {
        body: AuthorizationPostRequest;
    }

    Properties

    body +PostAuthorizationsRequest | Documentation
    interface PostAuthorizationsRequest {
        body: AuthorizationPostRequest;
    }

    Properties

    Properties

    The authorization to create.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostBucketRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostBucketRequest.html index 96bd094c..ab6dbb5d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostBucketRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostBucketRequest.html @@ -1,19 +1,19 @@ -PostBucketRequest | Documentation
    interface PostBucketRequest {
        description?: string;
        name: string;
        orgID: string;
        retentionRules?: RetentionRules;
        rp?: string;
        schemaType?: SchemaType;
    }

    Properties

    description? +PostBucketRequest | Documentation
    interface PostBucketRequest {
        description?: string;
        name: string;
        orgID: string;
        retentionRules?: RetentionRules;
        rp?: string;
        schemaType?: SchemaType;
    }

    Properties

    description?: string

    A description of the bucket.

    -
    name: string

    The name of the bucket.

    -
    orgID: string

    Organization ID. +

    name: string

    The name of the bucket.

    +
    orgID: string

    Organization ID. The ID of the organization.

    -
    retentionRules?: RetentionRules
    rp?: string

    Retention policy is an InfluxDB 1.x concept that represents the duration +

    retentionRules?: RetentionRules
    rp?: string

    Retention policy is an InfluxDB 1.x concept that represents the duration of time that each data point in the retention policy persists. Use rp for compatibility with InfluxDB 1.x. The InfluxDB 2.x and Cloud equivalent is retention period.

    -
    schemaType?: SchemaType

    Schema Type. +

    schemaType?: SchemaType

    Schema Type. Use explicit to enforce column names, tags, fields, and data types for your data.

      @@ -22,4 +22,4 @@
      • Doesn't support schemaType.
      -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDLabelsRequest.html index 1b131ef6..ee35205c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDLabelsRequest.html @@ -1,6 +1,6 @@ -PostBucketsIDLabelsRequest | Documentation
    interface PostBucketsIDLabelsRequest {
        body: LabelMapping;
        bucketID: string;
    }

    Properties

    body +PostBucketsIDLabelsRequest | Documentation
    interface PostBucketsIDLabelsRequest {
        body: LabelMapping;
        bucketID: string;
    }

    Properties

    Properties

    An object that contains a labelID to add to the bucket.

    -
    bucketID: string

    Bucket ID. +

    bucketID: string

    Bucket ID. The ID of the bucket to label.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDMembersRequest.html index c848eae3..4e9ecc4d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDMembersRequest.html @@ -1,5 +1,5 @@ -PostBucketsIDMembersRequest | Documentation
    interface PostBucketsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        bucketID: string;
    }

    Properties

    body +PostBucketsIDMembersRequest | Documentation
    interface PostBucketsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        bucketID: string;
    }

    Properties

    Properties

    A user to add as a member to the bucket.

    -
    bucketID: string

    The ID of the bucket to retrieve users for.

    -
    +
    bucketID: string

    The ID of the bucket to retrieve users for.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDOwnersRequest.html index 0678e2f8..75f1da3f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostBucketsIDOwnersRequest.html @@ -1,5 +1,5 @@ -PostBucketsIDOwnersRequest | Documentation
    interface PostBucketsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        bucketID: string;
    }

    Properties

    body +PostBucketsIDOwnersRequest | Documentation
    interface PostBucketsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        bucketID: string;
    }

    Properties

    Properties

    User to add as owner

    -
    bucketID: string

    The bucket ID.

    -
    +
    bucketID: string

    The bucket ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostBucketsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostBucketsRequest.html index addf88f8..4ee4e670 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostBucketsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostBucketsRequest.html @@ -1,3 +1,3 @@ -PostBucketsRequest | Documentation
    interface PostBucketsRequest {
        body: PostBucketRequest;
    }

    Properties

    body +PostBucketsRequest | Documentation
    interface PostBucketsRequest {
        body: PostBucketRequest;
    }

    Properties

    Properties

    Bucket to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostChecksIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostChecksIDLabelsRequest.html index 9aee488a..3ceee702 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostChecksIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostChecksIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostChecksIDLabelsRequest | Documentation
    interface PostChecksIDLabelsRequest {
        body: LabelMapping;
        checkID: string;
    }

    Properties

    body +PostChecksIDLabelsRequest | Documentation
    interface PostChecksIDLabelsRequest {
        body: LabelMapping;
        checkID: string;
    }

    Properties

    Properties

    Label to add

    -
    checkID: string

    The check ID.

    -
    +
    checkID: string

    The check ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostDBRPRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostDBRPRequest.html index d90ec3ee..c38ecb8c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostDBRPRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostDBRPRequest.html @@ -1,3 +1,3 @@ -PostDBRPRequest | Documentation
    interface PostDBRPRequest {
        body: DBRPCreate;
    }

    Properties

    body +PostDBRPRequest | Documentation
    interface PostDBRPRequest {
        body: DBRPCreate;
    }

    Properties

    Properties

    The database retention policy mapping to add

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDCellsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDCellsRequest.html index f368603e..833fb324 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDCellsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDCellsRequest.html @@ -1,5 +1,5 @@ -PostDashboardsIDCellsRequest | Documentation
    interface PostDashboardsIDCellsRequest {
        body: CreateCell;
        dashboardID: string;
    }

    Properties

    body +PostDashboardsIDCellsRequest | Documentation
    interface PostDashboardsIDCellsRequest {
        body: CreateCell;
        dashboardID: string;
    }

    Properties

    Properties

    Cell that will be added

    -
    dashboardID: string

    The ID of the dashboard to update.

    -
    +
    dashboardID: string

    The ID of the dashboard to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDLabelsRequest.html index 4430b01d..bc4a23cd 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostDashboardsIDLabelsRequest | Documentation
    interface PostDashboardsIDLabelsRequest {
        body: LabelMapping;
        dashboardID: string;
    }

    Properties

    body +PostDashboardsIDLabelsRequest | Documentation
    interface PostDashboardsIDLabelsRequest {
        body: LabelMapping;
        dashboardID: string;
    }

    Properties

    Properties

    Label to add

    -
    dashboardID: string

    The dashboard ID.

    -
    +
    dashboardID: string

    The dashboard ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDMembersRequest.html index 32d1f65a..d33b3539 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDMembersRequest.html @@ -1,5 +1,5 @@ -PostDashboardsIDMembersRequest | Documentation
    interface PostDashboardsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        dashboardID: string;
    }

    Properties

    body +PostDashboardsIDMembersRequest | Documentation
    interface PostDashboardsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        dashboardID: string;
    }

    Properties

    Properties

    User to add as member

    -
    dashboardID: string

    The dashboard ID.

    -
    +
    dashboardID: string

    The dashboard ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDOwnersRequest.html index d8a7d508..b762cbf0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsIDOwnersRequest.html @@ -1,5 +1,5 @@ -PostDashboardsIDOwnersRequest | Documentation
    interface PostDashboardsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        dashboardID: string;
    }

    Properties

    body +PostDashboardsIDOwnersRequest | Documentation
    interface PostDashboardsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        dashboardID: string;
    }

    Properties

    Properties

    User to add as owner

    -
    dashboardID: string

    The dashboard ID.

    -
    +
    dashboardID: string

    The dashboard ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsRequest.html index c84ad8ef..bca4786e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostDashboardsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostDashboardsRequest.html @@ -1,3 +1,3 @@ -PostDashboardsRequest | Documentation
    interface PostDashboardsRequest {
        body: CreateDashboardRequest;
    }

    Properties

    body +PostDashboardsRequest | Documentation
    interface PostDashboardsRequest {
        body: CreateDashboardRequest;
    }

    Properties

    Properties

    Dashboard to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostDeleteRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostDeleteRequest.html index 79cb7134..46c981b4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostDeleteRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostDeleteRequest.html @@ -1,4 +1,4 @@ -PostDeleteRequest | Documentation
    interface PostDeleteRequest {
        body: DeletePredicateRequest;
        bucket?: string;
        bucketID?: string;
        org?: string;
        orgID?: string;
    }

    Properties

    body +PostDeleteRequest | Documentation
    interface PostDeleteRequest {
        body: DeletePredicateRequest;
        bucket?: string;
        bucketID?: string;
        org?: string;
        orgID?: string;
    }

    Properties

    body bucket? bucketID? org? @@ -12,11 +12,11 @@
  • Delete data.
  • Learn how to use delete predicate syntax.
  • -
    bucket?: string

    The name or ID of the bucket to delete data from. +

    bucket?: string

    The name or ID of the bucket to delete data from. If you pass both bucket and bucketID, bucketID takes precedence.

    -
    bucketID?: string

    The ID of the bucket to delete data from. +

    bucketID?: string

    The ID of the bucket to delete data from. If you pass both bucket and bucketID, bucketID takes precedence.

    -
    org?: string

    The organization to delete data from. +

    org?: string

    The organization to delete data from. If you pass both orgID and org, they must both be valid.

    • Doesn't require org or orgID.
    • @@ -25,7 +25,7 @@
      • Requires either org or orgID.
      -
    orgID?: string

    The ID of the organization to delete data from. +

    orgID?: string

    The ID of the organization to delete data from. If you pass both orgID and org, they must both be valid.

    • Doesn't require org or orgID.
    • @@ -34,4 +34,4 @@
      • Requires either org or orgID.
      -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostLabelsRequest.html index 92390201..7bff1487 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostLabelsRequest.html @@ -1,3 +1,3 @@ -PostLabelsRequest | Documentation
    interface PostLabelsRequest {
        body: LabelCreateRequest;
    }

    Properties

    body +PostLabelsRequest | Documentation
    interface PostLabelsRequest {
        body: LabelCreateRequest;
    }

    Properties

    Properties

    The label to create.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostNotificationEndpointIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostNotificationEndpointIDLabelsRequest.html index 5522e19b..47042d31 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostNotificationEndpointIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostNotificationEndpointIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostNotificationEndpointIDLabelsRequest | Documentation
    interface PostNotificationEndpointIDLabelsRequest {
        body: LabelMapping;
        endpointID: string;
    }

    Properties

    body +PostNotificationEndpointIDLabelsRequest | Documentation
    interface PostNotificationEndpointIDLabelsRequest {
        body: LabelMapping;
        endpointID: string;
    }

    Properties

    Properties

    Label to add

    -
    endpointID: string

    The notification endpoint ID.

    -
    +
    endpointID: string

    The notification endpoint ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostNotificationRuleIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostNotificationRuleIDLabelsRequest.html index 75e0ff76..d77c453c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostNotificationRuleIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostNotificationRuleIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostNotificationRuleIDLabelsRequest | Documentation
    interface PostNotificationRuleIDLabelsRequest {
        body: LabelMapping;
        ruleID: string;
    }

    Properties

    body +PostNotificationRuleIDLabelsRequest | Documentation
    interface PostNotificationRuleIDLabelsRequest {
        body: LabelMapping;
        ruleID: string;
    }

    Properties

    Properties

    Label to add

    -
    ruleID: string

    The notification rule ID.

    -
    +
    ruleID: string

    The notification rule ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostOrganizationRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostOrganizationRequest.html index a2808a34..1fbff0eb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostOrganizationRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostOrganizationRequest.html @@ -1,5 +1,5 @@ -PostOrganizationRequest | Documentation
    interface PostOrganizationRequest {
        description?: string;
        name: string;
    }

    Properties

    description? +PostOrganizationRequest | Documentation
    interface PostOrganizationRequest {
        description?: string;
        name: string;
    }

    Properties

    Properties

    description?: string

    The description of the organization.

    -
    name: string

    The name of the organization.

    -
    +
    name: string

    The name of the organization.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDMembersRequest.html index c4cc09b6..17d7849d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDMembersRequest.html @@ -1,5 +1,5 @@ -PostOrgsIDMembersRequest | Documentation
    interface PostOrgsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        orgID: string;
    }

    Properties

    body +PostOrgsIDMembersRequest | Documentation
    interface PostOrgsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        orgID: string;
    }

    Properties

    Properties

    The user to add to the organization.

    -
    orgID: string

    The ID of the organization.

    -
    +
    orgID: string

    The ID of the organization.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDOwnersRequest.html index 1cb61337..e901ba37 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDOwnersRequest.html @@ -1,5 +1,5 @@ -PostOrgsIDOwnersRequest | Documentation
    interface PostOrgsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        orgID: string;
    }

    Properties

    body +PostOrgsIDOwnersRequest | Documentation
    interface PostOrgsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        orgID: string;
    }

    Properties

    Properties

    The user to add as an owner of the organization.

    -
    orgID: string

    The ID of the organization that you want to add an owner for.

    -
    +
    orgID: string

    The ID of the organization that you want to add an owner for.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDSecretsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDSecretsRequest.html index 90942530..f25f97a3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDSecretsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostOrgsIDSecretsRequest.html @@ -1,5 +1,5 @@ -PostOrgsIDSecretsRequest | Documentation
    interface PostOrgsIDSecretsRequest {
        body: SecretKeys;
        orgID: string;
    }

    Properties

    body +PostOrgsIDSecretsRequest | Documentation
    interface PostOrgsIDSecretsRequest {
        body: SecretKeys;
        orgID: string;
    }

    Properties

    Properties

    Secret key to delete

    -
    orgID: string

    The organization ID.

    -
    +
    orgID: string

    The organization ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostOrgsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostOrgsRequest.html index fa26cb22..96e0d139 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostOrgsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostOrgsRequest.html @@ -1,3 +1,3 @@ -PostOrgsRequest | Documentation
    interface PostOrgsRequest {
        body: PostOrganizationRequest;
    }

    Properties

    body +PostOrgsRequest | Documentation
    interface PostOrgsRequest {
        body: PostOrganizationRequest;
    }

    Properties

    Properties

    The organization to create.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostQueryAnalyzeRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostQueryAnalyzeRequest.html index 016ac072..2abbac6f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostQueryAnalyzeRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostQueryAnalyzeRequest.html @@ -1,3 +1,3 @@ -PostQueryAnalyzeRequest | Documentation
    interface PostQueryAnalyzeRequest {
        body: Query;
    }

    Properties

    body +PostQueryAnalyzeRequest | Documentation
    interface PostQueryAnalyzeRequest {
        body: Query;
    }

    Properties

    Properties

    body: Query

    Flux query to analyze

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostQueryAstRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostQueryAstRequest.html index 06364f1e..24a592c9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostQueryAstRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostQueryAstRequest.html @@ -1,3 +1,3 @@ -PostQueryAstRequest | Documentation
    interface PostQueryAstRequest {
        body: LanguageRequest;
    }

    Properties

    body +PostQueryAstRequest | Documentation
    interface PostQueryAstRequest {
        body: LanguageRequest;
    }

    Properties

    Properties

    The Flux query to analyze.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostQueryRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostQueryRequest.html index 840dfdf0..28f1dcc5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostQueryRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostQueryRequest.html @@ -1,8 +1,8 @@ -PostQueryRequest | Documentation
    interface PostQueryRequest {
        body: Query;
        org?: string;
        orgID?: string;
    }

    Properties

    body +PostQueryRequest | Documentation
    interface PostQueryRequest {
        body: Query;
        org?: string;
        orgID?: string;
    }

    Properties

    Properties

    body: Query

    Flux query or specification to execute

    -
    org?: string

    The name or ID of the organization executing the query.

    +
    org?: string

    The name or ID of the organization executing the query.

    • Doesn't use org or orgID.
    • Queries the bucket in the organization associated with the authorization (API token).
    • @@ -10,7 +10,7 @@
      • Requires either org or orgID.
      -
    orgID?: string

    The ID of the organization executing the query.

    +
    orgID?: string

    The ID of the organization executing the query.

    • Doesn't use org or orgID.
    • Queries the bucket in the organization associated with the authorization (API token).
    • @@ -18,4 +18,4 @@
      • Requires either org or orgID.
      -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostRemoteConnectionRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostRemoteConnectionRequest.html index 7e70d6e6..195a6d76 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostRemoteConnectionRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostRemoteConnectionRequest.html @@ -1,3 +1,3 @@ -PostRemoteConnectionRequest | Documentation
    interface PostRemoteConnectionRequest {
        body: RemoteConnectionCreationRequest;
    }

    Properties

    body +PostRemoteConnectionRequest | Documentation
    interface PostRemoteConnectionRequest {
        body: RemoteConnectionCreationRequest;
    }

    Properties

    Properties

    entity body

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostReplicationRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostReplicationRequest.html index ef31b36a..f9245d6b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostReplicationRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostReplicationRequest.html @@ -1,5 +1,5 @@ -PostReplicationRequest | Documentation
    interface PostReplicationRequest {
        body: ReplicationCreationRequest;
        validate?: any;
    }

    Properties

    body +PostReplicationRequest | Documentation
    interface PostReplicationRequest {
        body: ReplicationCreationRequest;
        validate?: any;
    }

    Properties

    Properties

    entity body

    -
    validate?: any

    If true, validate the replication, but don't save it.

    -
    +
    validate?: any

    If true, validate the replication, but don't save it.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketIDRequest.html index aaedb7ed..cc0cb363 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketIDRequest.html @@ -1,5 +1,5 @@ -PostRestoreBucketIDRequest | Documentation
    interface PostRestoreBucketIDRequest {
        body: string;
        bucketID: string;
    }

    Properties

    body +PostRestoreBucketIDRequest | Documentation
    interface PostRestoreBucketIDRequest {
        body: string;
        bucketID: string;
    }

    Properties

    Properties

    body: string

    Database info serialized as protobuf.

    -
    bucketID: string

    The bucket ID.

    -
    +
    bucketID: string

    The bucket ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketMetadataRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketMetadataRequest.html index 305c895c..2f5136d7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketMetadataRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostRestoreBucketMetadataRequest.html @@ -1,3 +1,3 @@ -PostRestoreBucketMetadataRequest | Documentation
    interface PostRestoreBucketMetadataRequest {
        body: BucketMetadataManifest;
    }

    Properties

    body +PostRestoreBucketMetadataRequest | Documentation
    interface PostRestoreBucketMetadataRequest {
        body: BucketMetadataManifest;
    }

    Properties

    Properties

    Metadata manifest for a bucket.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostRestoreKVRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostRestoreKVRequest.html index 42b1e016..bd145a30 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostRestoreKVRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostRestoreKVRequest.html @@ -1,3 +1,3 @@ -PostRestoreKVRequest | Documentation
    interface PostRestoreKVRequest {
        body: string;
    }

    Properties

    body +PostRestoreKVRequest | Documentation
    interface PostRestoreKVRequest {
        body: string;
    }

    Properties

    Properties

    body: string

    Full KV snapshot.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostRestoreSQLRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostRestoreSQLRequest.html index 885bd021..9a908eed 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostRestoreSQLRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostRestoreSQLRequest.html @@ -1,3 +1,3 @@ -PostRestoreSQLRequest | Documentation
    interface PostRestoreSQLRequest {
        body: string;
    }

    Properties

    body +PostRestoreSQLRequest | Documentation
    interface PostRestoreSQLRequest {
        body: string;
    }

    Properties

    Properties

    body: string

    Full SQL snapshot.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostRestoreShardIdRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostRestoreShardIdRequest.html index 87a116b6..c097b2d4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostRestoreShardIdRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostRestoreShardIdRequest.html @@ -1,5 +1,5 @@ -PostRestoreShardIdRequest | Documentation
    interface PostRestoreShardIdRequest {
        body: string;
        shardID: string;
    }

    Properties

    body +PostRestoreShardIdRequest | Documentation
    interface PostRestoreShardIdRequest {
        body: string;
        shardID: string;
    }

    Properties

    Properties

    body: string

    TSM snapshot.

    -
    shardID: string

    The shard ID.

    -
    +
    shardID: string

    The shard ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDLabelsRequest.html index cdd28752..5d181ecb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostScrapersIDLabelsRequest | Documentation
    interface PostScrapersIDLabelsRequest {
        body: LabelMapping;
        scraperTargetID: string;
    }

    Properties

    body +PostScrapersIDLabelsRequest | Documentation
    interface PostScrapersIDLabelsRequest {
        body: LabelMapping;
        scraperTargetID: string;
    }

    Properties

    Label to add

    -
    scraperTargetID: string

    The scraper target ID.

    -
    +
    scraperTargetID: string

    The scraper target ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDMembersRequest.html index 81486d83..cb6b1145 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDMembersRequest.html @@ -1,5 +1,5 @@ -PostScrapersIDMembersRequest | Documentation
    interface PostScrapersIDMembersRequest {
        body: AddResourceMemberRequestBody;
        scraperTargetID: string;
    }

    Properties

    body +PostScrapersIDMembersRequest | Documentation
    interface PostScrapersIDMembersRequest {
        body: AddResourceMemberRequestBody;
        scraperTargetID: string;
    }

    Properties

    User to add as member

    -
    scraperTargetID: string

    The scraper target ID.

    -
    +
    scraperTargetID: string

    The scraper target ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDOwnersRequest.html index 24fd9894..e3e5ef20 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostScrapersIDOwnersRequest.html @@ -1,5 +1,5 @@ -PostScrapersIDOwnersRequest | Documentation
    interface PostScrapersIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        scraperTargetID: string;
    }

    Properties

    body +PostScrapersIDOwnersRequest | Documentation
    interface PostScrapersIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        scraperTargetID: string;
    }

    Properties

    User to add as owner

    -
    scraperTargetID: string

    The scraper target ID.

    -
    +
    scraperTargetID: string

    The scraper target ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostScrapersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostScrapersRequest.html index 3f6e06bd..23bc86ef 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostScrapersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostScrapersRequest.html @@ -1,3 +1,3 @@ -PostScrapersRequest | Documentation
    interface PostScrapersRequest {
        body: ScraperTargetRequest;
    }

    Properties

    body +PostScrapersRequest | Documentation
    interface PostScrapersRequest {
        body: ScraperTargetRequest;
    }

    Properties

    Properties

    Scraper target to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostScriptsIDInvokeRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostScriptsIDInvokeRequest.html index 712237aa..e4d88690 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostScriptsIDInvokeRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostScriptsIDInvokeRequest.html @@ -1,6 +1,6 @@ -PostScriptsIDInvokeRequest | Documentation
    interface PostScriptsIDInvokeRequest {
        body: ScriptInvocationParams;
        scriptID: string;
    }

    Properties

    body +PostScriptsIDInvokeRequest | Documentation
    interface PostScriptsIDInvokeRequest {
        body: ScriptInvocationParams;
        scriptID: string;
    }

    Properties

    Properties

    entity body

    -
    scriptID: string

    A script ID. +

    scriptID: string

    A script ID. Specifies the script to execute.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostScriptsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostScriptsRequest.html index 7b89ec2a..72de93fc 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostScriptsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostScriptsRequest.html @@ -1,3 +1,3 @@ -PostScriptsRequest | Documentation
    interface PostScriptsRequest {
        body: ScriptCreateRequest;
    }

    Properties

    body +PostScriptsRequest | Documentation
    interface PostScriptsRequest {
        body: ScriptCreateRequest;
    }

    Properties

    Properties

    The script to create.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostSetupRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostSetupRequest.html index 7d04bad7..ff6a3247 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostSetupRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostSetupRequest.html @@ -1,3 +1,3 @@ -PostSetupRequest | Documentation
    interface PostSetupRequest {
        body: OnboardingRequest;
    }

    Properties

    body +PostSetupRequest | Documentation
    interface PostSetupRequest {
        body: OnboardingRequest;
    }

    Properties

    Properties

    Source to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostSigninRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostSigninRequest.html index 08678b70..f55a530a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostSigninRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostSigninRequest.html @@ -1,2 +1,2 @@ -PostSigninRequest | Documentation
    interface PostSigninRequest {
        auth?: { password: string; user: string };
    }

    Properties

    Properties

    auth?: { password: string; user: string }
    +PostSigninRequest | Documentation
    interface PostSigninRequest {
        auth?: { password: string; user: string };
    }

    Properties

    Properties

    auth?: { password: string; user: string }
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostSignoutRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostSignoutRequest.html index 08203219..7985bd4d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostSignoutRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostSignoutRequest.html @@ -1 +1 @@ -PostSignoutRequest | Documentation
    +PostSignoutRequest | Documentation
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostSourcesRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostSourcesRequest.html index cfbc7376..5c34a66d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostSourcesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostSourcesRequest.html @@ -1,3 +1,3 @@ -PostSourcesRequest | Documentation
    interface PostSourcesRequest {
        body: Source;
    }

    Properties

    body +PostSourcesRequest | Documentation
    interface PostSourcesRequest {
        body: Source;
    }

    Properties

    Properties

    body: Source

    Source to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDLabelsRequest.html index a2badc68..714f136d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostTasksIDLabelsRequest | Documentation
    interface PostTasksIDLabelsRequest {
        body: LabelMapping;
        taskID: string;
    }

    Properties

    body +PostTasksIDLabelsRequest | Documentation
    interface PostTasksIDLabelsRequest {
        body: LabelMapping;
        taskID: string;
    }

    Properties

    Properties

    An object that contains a labelID to add to the task.

    -
    taskID: string

    The ID of the task to label.

    -
    +
    taskID: string

    The ID of the task to label.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDMembersRequest.html index fac71d9d..ac996c4b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDMembersRequest.html @@ -1,5 +1,5 @@ -PostTasksIDMembersRequest | Documentation
    interface PostTasksIDMembersRequest {
        body: AddResourceMemberRequestBody;
        taskID: string;
    }

    Properties

    body +PostTasksIDMembersRequest | Documentation
    interface PostTasksIDMembersRequest {
        body: AddResourceMemberRequestBody;
        taskID: string;
    }

    Properties

    Properties

    A user to add as a member of the task.

    -
    taskID: string

    The task ID.

    -
    +
    taskID: string

    The task ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDOwnersRequest.html index 88302dc6..16525dc0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDOwnersRequest.html @@ -1,5 +1,5 @@ -PostTasksIDOwnersRequest | Documentation
    interface PostTasksIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        taskID: string;
    }

    Properties

    body +PostTasksIDOwnersRequest | Documentation
    interface PostTasksIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        taskID: string;
    }

    Properties

    Properties

    A user to add as an owner of the task.

    -
    taskID: string

    The task ID.

    -
    +
    taskID: string

    The task ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsIDRetryRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsIDRetryRequest.html index 9a741741..c2bfe423 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsIDRetryRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsIDRetryRequest.html @@ -1,12 +1,12 @@ -PostTasksIDRunsIDRetryRequest | Documentation
    interface PostTasksIDRunsIDRetryRequest {
        body: any;
        runID: string;
        taskID: string;
    }

    Properties

    body +PostTasksIDRunsIDRetryRequest | Documentation
    interface PostTasksIDRunsIDRetryRequest {
        body: any;
        runID: string;
        taskID: string;
    }

    Properties

    Properties

    body: any

    entity body

    -
    runID: string

    A task run ID. +

    runID: string

    A task run ID. Specifies the task run to retry.

    To find a task run ID, use the GET /api/v2/tasks/{taskID}/runs endpoint to list task runs.

    -
    taskID: string

    A task ID. +

    taskID: string

    A task ID. Specifies the task to retry.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsRequest.html index 3c8386df..2259203c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTasksIDRunsRequest.html @@ -1,4 +1,4 @@ -PostTasksIDRunsRequest | Documentation
    interface PostTasksIDRunsRequest {
        body: RunManually;
        taskID: string;
    }

    Properties

    body +PostTasksIDRunsRequest | Documentation
    interface PostTasksIDRunsRequest {
        body: RunManually;
        taskID: string;
    }

    Properties

    Properties

    entity body

    -
    taskID: string
    +
    taskID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTasksRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTasksRequest.html index e0f50a97..87bccae0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTasksRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTasksRequest.html @@ -1,3 +1,3 @@ -PostTasksRequest | Documentation
    interface PostTasksRequest {
        body: TaskCreateRequest;
    }

    Properties

    body +PostTasksRequest | Documentation
    interface PostTasksRequest {
        body: TaskCreateRequest;
    }

    Properties

    Properties

    The task to create.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDLabelsRequest.html index 7200a780..26317329 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostTelegrafsIDLabelsRequest | Documentation
    interface PostTelegrafsIDLabelsRequest {
        body: LabelMapping;
        telegrafID: string;
    }

    Properties

    body +PostTelegrafsIDLabelsRequest | Documentation
    interface PostTelegrafsIDLabelsRequest {
        body: LabelMapping;
        telegrafID: string;
    }

    Properties

    Properties

    Label to add

    -
    telegrafID: string

    The Telegraf config ID.

    -
    +
    telegrafID: string

    The Telegraf config ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDMembersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDMembersRequest.html index d7d4d64e..323d18fe 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDMembersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDMembersRequest.html @@ -1,5 +1,5 @@ -PostTelegrafsIDMembersRequest | Documentation
    interface PostTelegrafsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        telegrafID: string;
    }

    Properties

    body +PostTelegrafsIDMembersRequest | Documentation
    interface PostTelegrafsIDMembersRequest {
        body: AddResourceMemberRequestBody;
        telegrafID: string;
    }

    Properties

    Properties

    User to add as member

    -
    telegrafID: string

    The Telegraf config ID.

    -
    +
    telegrafID: string

    The Telegraf config ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDOwnersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDOwnersRequest.html index 2eff6b78..d417af16 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDOwnersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsIDOwnersRequest.html @@ -1,5 +1,5 @@ -PostTelegrafsIDOwnersRequest | Documentation
    interface PostTelegrafsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        telegrafID: string;
    }

    Properties

    body +PostTelegrafsIDOwnersRequest | Documentation
    interface PostTelegrafsIDOwnersRequest {
        body: AddResourceMemberRequestBody;
        telegrafID: string;
    }

    Properties

    Properties

    User to add as owner

    -
    telegrafID: string

    The Telegraf configuration ID.

    -
    +
    telegrafID: string

    The Telegraf configuration ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsRequest.html index 903852d0..72a46ee2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostTelegrafsRequest.html @@ -1,3 +1,3 @@ -PostTelegrafsRequest | Documentation
    interface PostTelegrafsRequest {
        body: TelegrafPluginRequest;
    }

    Properties

    body +PostTelegrafsRequest | Documentation
    interface PostTelegrafsRequest {
        body: TelegrafPluginRequest;
    }

    Properties

    Properties

    Telegraf configuration to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostUsersIDPasswordRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostUsersIDPasswordRequest.html index 443231a7..93aa49ec 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostUsersIDPasswordRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostUsersIDPasswordRequest.html @@ -1,6 +1,6 @@ -PostUsersIDPasswordRequest | Documentation
    interface PostUsersIDPasswordRequest {
        auth?: { password: string; user: string };
        body: PasswordResetBody;
        userID: string;
    }

    Properties

    auth? +PostUsersIDPasswordRequest | Documentation
    interface PostUsersIDPasswordRequest {
        auth?: { password: string; user: string };
        body: PasswordResetBody;
        userID: string;
    }

    Properties

    Properties

    auth?: { password: string; user: string }

    New password

    -
    userID: string

    The user ID.

    -
    +

    Properties

    auth?: { password: string; user: string }

    New password

    +
    userID: string

    The user ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostUsersRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostUsersRequest.html index 68d94515..7eda1d5d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostUsersRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostUsersRequest.html @@ -1,3 +1,3 @@ -PostUsersRequest | Documentation
    interface PostUsersRequest {
        body: User;
    }

    Properties

    body +PostUsersRequest | Documentation
    interface PostUsersRequest {
        body: User;
    }

    Properties

    Properties

    body: User

    The user to create.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostValidateReplicationByIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostValidateReplicationByIDRequest.html index f7b421c7..a94328b6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostValidateReplicationByIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostValidateReplicationByIDRequest.html @@ -1,2 +1,2 @@ -PostValidateReplicationByIDRequest | Documentation
    interface PostValidateReplicationByIDRequest {
        replicationID: string;
    }

    Properties

    Properties

    replicationID: string
    +PostValidateReplicationByIDRequest | Documentation
    interface PostValidateReplicationByIDRequest {
        replicationID: string;
    }

    Properties

    Properties

    replicationID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostVariablesIDLabelsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostVariablesIDLabelsRequest.html index 210e986a..18ae74ca 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostVariablesIDLabelsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostVariablesIDLabelsRequest.html @@ -1,5 +1,5 @@ -PostVariablesIDLabelsRequest | Documentation
    interface PostVariablesIDLabelsRequest {
        body: LabelMapping;
        variableID: string;
    }

    Properties

    body +PostVariablesIDLabelsRequest | Documentation
    interface PostVariablesIDLabelsRequest {
        body: LabelMapping;
        variableID: string;
    }

    Properties

    Properties

    Label to add

    -
    variableID: string

    The variable ID.

    -
    +
    variableID: string

    The variable ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostVariablesRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostVariablesRequest.html index 822c3812..e2effcf2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostVariablesRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostVariablesRequest.html @@ -1,3 +1,3 @@ -PostVariablesRequest | Documentation
    interface PostVariablesRequest {
        body: Variable;
    }

    Properties

    body +PostVariablesRequest | Documentation
    interface PostVariablesRequest {
        body: Variable;
    }

    Properties

    Properties

    body: Variable

    Variable to create

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PostWriteRequest.html b/interfaces/_influxdata_influxdb-client-apis.PostWriteRequest.html index 7b6002b0..f5204b82 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PostWriteRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PostWriteRequest.html @@ -1,4 +1,4 @@ -PostWriteRequest | Documentation
    interface PostWriteRequest {
        body: string;
        bucket: string;
        org: string;
        orgID?: string;
        precision?: any;
    }

    Properties

    body +PostWriteRequest | Documentation
    interface PostWriteRequest {
        body: string;
        bucket: string;
        org: string;
        orgID?: string;
        precision?: any;
    }

    Properties

    body bucket org orgID? @@ -13,9 +13,9 @@ -
    bucket: string

    The destination bucket for writes. +

    bucket: string

    The destination bucket for writes. InfluxDB writes all points in the batch to this bucket.

    -
    org: string

    The destination organization for writes. +

    org: string

    The destination organization for writes. InfluxDB writes all points in the batch to this organization. If you pass both orgID and org, they must both be valid.

      @@ -26,7 +26,7 @@
    • Requires either org or orgID.
    • InfluxDB writes all points in the batch to this organization.
    -
    orgID?: string

    The ID of the destination organization for writes. +

    orgID?: string

    The ID of the destination organization for writes. If you pass both orgID and org, they must both be valid.

    • Doesn't require org or orgID.
    • @@ -36,5 +36,5 @@
    • Requires either org or orgID.
    • InfluxDB writes all points in the batch to this organization.
    -
    precision?: any

    The precision for unix timestamps in the line protocol batch.

    -
    +
    precision?: any

    The precision for unix timestamps in the line protocol batch.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Property.html b/interfaces/_influxdata_influxdb-client-apis.Property.html index b4145551..5bfd270e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Property.html +++ b/interfaces/_influxdata_influxdb-client-apis.Property.html @@ -1,5 +1,5 @@ Property | Documentation

    The value associated with a key

    -
    interface Property {
        key?: PropertyKey;
        type?: string;
        value?: Expression;
    }

    Properties

    interface Property {
        key?: PropertyKey;
        type?: string;
        value?: Expression;
    }

    Properties

    Properties

    type?: string
    value?: Expression
    +

    Properties

    type?: string
    value?: Expression
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PutChecksIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PutChecksIDRequest.html index aa07775c..596cb9d6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PutChecksIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PutChecksIDRequest.html @@ -1,5 +1,5 @@ -PutChecksIDRequest | Documentation
    interface PutChecksIDRequest {
        body: CheckDiscriminator;
        checkID: string;
    }

    Properties

    body +PutChecksIDRequest | Documentation
    interface PutChecksIDRequest {
        body: CheckDiscriminator;
        checkID: string;
    }

    Properties

    Properties

    Check update to apply

    -
    checkID: string

    The check ID.

    -
    +
    checkID: string

    The check ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PutDashboardsIDCellsRequest.html b/interfaces/_influxdata_influxdb-client-apis.PutDashboardsIDCellsRequest.html index 1a35f9aa..d8fadab6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PutDashboardsIDCellsRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PutDashboardsIDCellsRequest.html @@ -1,5 +1,5 @@ -PutDashboardsIDCellsRequest | Documentation
    interface PutDashboardsIDCellsRequest {
        body: Cells;
        dashboardID: string;
    }

    Properties

    body +PutDashboardsIDCellsRequest | Documentation
    interface PutDashboardsIDCellsRequest {
        body: Cells;
        dashboardID: string;
    }

    Properties

    Properties

    body: Cells

    entity body

    -
    dashboardID: string

    The ID of the dashboard to update.

    -
    +
    dashboardID: string

    The ID of the dashboard to update.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PutMePasswordRequest.html b/interfaces/_influxdata_influxdb-client-apis.PutMePasswordRequest.html index 05c17143..a664df6e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PutMePasswordRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PutMePasswordRequest.html @@ -1,4 +1,4 @@ -PutMePasswordRequest | Documentation
    interface PutMePasswordRequest {
        auth?: { password: string; user: string };
        body: PasswordResetBody;
    }

    Properties

    auth? +PutMePasswordRequest | Documentation
    interface PutMePasswordRequest {
        auth?: { password: string; user: string };
        body: PasswordResetBody;
    }

    Properties

    Properties

    auth?: { password: string; user: string }

    The new password.

    -
    +

    Properties

    auth?: { password: string; user: string }

    The new password.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PutNotificationEndpointsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PutNotificationEndpointsIDRequest.html index d34e919b..392b8112 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PutNotificationEndpointsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PutNotificationEndpointsIDRequest.html @@ -1,5 +1,5 @@ -PutNotificationEndpointsIDRequest | Documentation
    interface PutNotificationEndpointsIDRequest {
        body: NotificationEndpointDiscriminator;
        endpointID: string;
    }

    Properties

    body +PutNotificationEndpointsIDRequest | Documentation
    interface PutNotificationEndpointsIDRequest {
        body: NotificationEndpointDiscriminator;
        endpointID: string;
    }

    Properties

    Properties

    A new notification endpoint to replace the existing endpoint with

    -
    endpointID: string

    The notification endpoint ID.

    -
    +
    endpointID: string

    The notification endpoint ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PutNotificationRulesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PutNotificationRulesIDRequest.html index 8b205742..ba4ee094 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PutNotificationRulesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PutNotificationRulesIDRequest.html @@ -1,5 +1,5 @@ -PutNotificationRulesIDRequest | Documentation
    interface PutNotificationRulesIDRequest {
        body: NotificationRuleDiscriminator;
        ruleID: string;
    }

    Properties

    body +PutNotificationRulesIDRequest | Documentation
    interface PutNotificationRulesIDRequest {
        body: NotificationRuleDiscriminator;
        ruleID: string;
    }

    Properties

    Properties

    Notification rule update to apply

    -
    ruleID: string

    The notification rule ID.

    -
    +
    ruleID: string

    The notification rule ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PutTelegrafsIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PutTelegrafsIDRequest.html index 5aeacd69..b1a4e891 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PutTelegrafsIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PutTelegrafsIDRequest.html @@ -1,5 +1,5 @@ -PutTelegrafsIDRequest | Documentation
    interface PutTelegrafsIDRequest {
        body: TelegrafPluginRequest;
        telegrafID: string;
    }

    Properties

    body +PutTelegrafsIDRequest | Documentation
    interface PutTelegrafsIDRequest {
        body: TelegrafPluginRequest;
        telegrafID: string;
    }

    Properties

    Properties

    Telegraf configuration update to apply

    -
    telegrafID: string

    The Telegraf config ID.

    -
    +
    telegrafID: string

    The Telegraf config ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.PutVariablesIDRequest.html b/interfaces/_influxdata_influxdb-client-apis.PutVariablesIDRequest.html index e4314b0d..a281f171 100644 --- a/interfaces/_influxdata_influxdb-client-apis.PutVariablesIDRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.PutVariablesIDRequest.html @@ -1,5 +1,5 @@ -PutVariablesIDRequest | Documentation
    interface PutVariablesIDRequest {
        body: Variable;
        variableID: string;
    }

    Properties

    body +PutVariablesIDRequest | Documentation
    interface PutVariablesIDRequest {
        body: Variable;
        variableID: string;
    }

    Properties

    Properties

    body: Variable

    Variable to replace

    -
    variableID: string

    The variable ID.

    -
    +
    variableID: string

    The variable ID.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Query.html b/interfaces/_influxdata_influxdb-client-apis.Query.html index 3c04d21c..d8f2e46f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Query.html +++ b/interfaces/_influxdata_influxdb-client-apis.Query.html @@ -1,13 +1,13 @@ Query | Documentation

    Query InfluxDB with the Flux language

    -
    interface Query {
        dialect?: Dialect;
        extern?: File;
        now?: string;
        params?: any;
        query: string;
        type?: "flux";
    }

    Properties

    interface Query {
        dialect?: Dialect;
        extern?: File;
        now?: string;
        params?: any;
        query: string;
        type?: "flux";
    }

    Properties

    dialect?: Dialect
    extern?: File
    now?: string

    Specifies the time that should be reported as now in the query. +

    Properties

    dialect?: Dialect
    extern?: File
    now?: string

    Specifies the time that should be reported as now in the query. Default is the server now time.

    -
    params?: any

    Key-value pairs passed as parameters during query execution.

    +
    params?: any

    Key-value pairs passed as parameters during query execution.

    To use parameters in your query, pass a query with params references (in dot notation)--for example:

      query: "from(bucket: params.mybucket) |> range(start: params.rangeStart) |> limit(n:1)"
     
    @@ -20,6 +20,6 @@
    • If you use params, you can't use extern.
    -
    query: string

    The query script to execute.

    -
    type?: "flux"

    The type of query. Must be "flux".

    -
    +
    query: string

    The query script to execute.

    +
    type?: "flux"

    The type of query. Must be "flux".

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.QueryVariableProperties.html b/interfaces/_influxdata_influxdb-client-apis.QueryVariableProperties.html index 41b00b5c..ab7fc254 100644 --- a/interfaces/_influxdata_influxdb-client-apis.QueryVariableProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.QueryVariableProperties.html @@ -1,3 +1,3 @@ -QueryVariableProperties | Documentation
    interface QueryVariableProperties {
        type?: "query";
        values?: { language?: string; query?: string };
    }

    Properties

    type? +QueryVariableProperties | Documentation
    interface QueryVariableProperties {
        type?: "query";
        values?: { language?: string; query?: string };
    }

    Properties

    Properties

    type?: "query"
    values?: { language?: string; query?: string }
    +

    Properties

    type?: "query"
    values?: { language?: string; query?: string }
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ReadStackRequest.html b/interfaces/_influxdata_influxdb-client-apis.ReadStackRequest.html index 41150735..7a421c71 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ReadStackRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ReadStackRequest.html @@ -1,3 +1,3 @@ -ReadStackRequest | Documentation
    interface ReadStackRequest {
        stack_id: string;
    }

    Properties

    stack_id +ReadStackRequest | Documentation
    interface ReadStackRequest {
        stack_id: string;
    }

    Properties

    Properties

    stack_id: string

    The identifier of the stack.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Ready.html b/interfaces/_influxdata_influxdb-client-apis.Ready.html index f184448b..5f1a319c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Ready.html +++ b/interfaces/_influxdata_influxdb-client-apis.Ready.html @@ -1,4 +1,4 @@ -Ready | Documentation
    interface Ready {
        started?: string;
        status?: "ready";
        up?: string;
    }

    Properties

    started? +Ready | Documentation
    interface Ready {
        started?: string;
        status?: "ready";
        up?: string;
    }

    Properties

    Properties

    started?: string
    status?: "ready"
    up?: string
    +

    Properties

    started?: string
    status?: "ready"
    up?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RegexpLiteral.html b/interfaces/_influxdata_influxdb-client-apis.RegexpLiteral.html index f14b9de3..e56fb1c3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RegexpLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.RegexpLiteral.html @@ -1,4 +1,4 @@ RegexpLiteral | Documentation

    Expressions begin and end with / and are regular expressions with syntax accepted by RE2

    -
    interface RegexpLiteral {
        type?: string;
        value?: string;
    }

    Properties

    interface RegexpLiteral {
        type?: string;
        value?: string;
    }

    Properties

    Properties

    type?: string
    value?: string
    +

    Properties

    type?: string
    value?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RemoteConnection.html b/interfaces/_influxdata_influxdb-client-apis.RemoteConnection.html index 62b6829f..cff1b747 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RemoteConnection.html +++ b/interfaces/_influxdata_influxdb-client-apis.RemoteConnection.html @@ -1,8 +1,8 @@ -RemoteConnection | Documentation
    interface RemoteConnection {
        allowInsecureTLS: boolean;
        description?: string;
        id: string;
        name: string;
        orgID: string;
        remoteOrgID: string;
        remoteURL: string;
    }

    Properties

    allowInsecureTLS +RemoteConnection | Documentation
    interface RemoteConnection {
        allowInsecureTLS: boolean;
        description?: string;
        id: string;
        name: string;
        orgID: string;
        remoteOrgID: string;
        remoteURL: string;
    }

    Properties

    allowInsecureTLS: boolean
    description?: string
    id: string
    name: string
    orgID: string
    remoteOrgID: string
    remoteURL: string
    +

    Properties

    allowInsecureTLS: boolean
    description?: string
    id: string
    name: string
    orgID: string
    remoteOrgID: string
    remoteURL: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionCreationRequest.html b/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionCreationRequest.html index 2ff44af1..b1c07bd5 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionCreationRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionCreationRequest.html @@ -1,8 +1,8 @@ -RemoteConnectionCreationRequest | Documentation
    interface RemoteConnectionCreationRequest {
        allowInsecureTLS: boolean;
        description?: string;
        name: string;
        orgID: string;
        remoteAPIToken: string;
        remoteOrgID: string;
        remoteURL: string;
    }

    Properties

    allowInsecureTLS +RemoteConnectionCreationRequest | Documentation
    interface RemoteConnectionCreationRequest {
        allowInsecureTLS: boolean;
        description?: string;
        name: string;
        orgID: string;
        remoteAPIToken: string;
        remoteOrgID: string;
        remoteURL: string;
    }

    Properties

    allowInsecureTLS: boolean
    description?: string
    name: string
    orgID: string
    remoteAPIToken: string
    remoteOrgID: string
    remoteURL: string
    +

    Properties

    allowInsecureTLS: boolean
    description?: string
    name: string
    orgID: string
    remoteAPIToken: string
    remoteOrgID: string
    remoteURL: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionUpdateRequest.html b/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionUpdateRequest.html index 11f6b0e6..9bf16658 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionUpdateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.RemoteConnectionUpdateRequest.html @@ -1,7 +1,7 @@ -RemoteConnectionUpdateRequest | Documentation
    interface RemoteConnectionUpdateRequest {
        allowInsecureTLS?: boolean;
        description?: string;
        name?: string;
        remoteAPIToken?: string;
        remoteOrgID?: string;
        remoteURL?: string;
    }

    Properties

    allowInsecureTLS? +RemoteConnectionUpdateRequest | Documentation
    interface RemoteConnectionUpdateRequest {
        allowInsecureTLS?: boolean;
        description?: string;
        name?: string;
        remoteAPIToken?: string;
        remoteOrgID?: string;
        remoteURL?: string;
    }

    Properties

    allowInsecureTLS?: boolean
    description?: string
    name?: string
    remoteAPIToken?: string
    remoteOrgID?: string
    remoteURL?: string
    +

    Properties

    allowInsecureTLS?: boolean
    description?: string
    name?: string
    remoteAPIToken?: string
    remoteOrgID?: string
    remoteURL?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RemoteConnections.html b/interfaces/_influxdata_influxdb-client-apis.RemoteConnections.html index 49a7be92..ea247435 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RemoteConnections.html +++ b/interfaces/_influxdata_influxdb-client-apis.RemoteConnections.html @@ -1,2 +1,2 @@ -RemoteConnections | Documentation
    interface RemoteConnections {
        remotes?: RemoteConnection[];
    }

    Properties

    Properties

    remotes?: RemoteConnection[]
    +RemoteConnections | Documentation
    interface RemoteConnections {
        remotes?: RemoteConnection[];
    }

    Properties

    Properties

    remotes?: RemoteConnection[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RenamableField.html b/interfaces/_influxdata_influxdb-client-apis.RenamableField.html index 6db5fdb0..de5d6fe7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RenamableField.html +++ b/interfaces/_influxdata_influxdb-client-apis.RenamableField.html @@ -1,8 +1,8 @@ RenamableField | Documentation

    Describes a field that can be renamed and made visible or invisible.

    -
    interface RenamableField {
        displayName?: string;
        internalName?: string;
        visible?: boolean;
    }

    Properties

    interface RenamableField {
        displayName?: string;
        internalName?: string;
        visible?: boolean;
    }

    Properties

    displayName?: string

    The name that a field is renamed to by the user.

    -
    internalName?: string

    The calculated name of a field.

    -
    visible?: boolean

    Indicates whether this field should be visible on the table.

    -
    +
    internalName?: string

    The calculated name of a field.

    +
    visible?: boolean

    Indicates whether this field should be visible on the table.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Replication.html b/interfaces/_influxdata_influxdb-client-apis.Replication.html index a636cf6d..9833c0cf 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Replication.html +++ b/interfaces/_influxdata_influxdb-client-apis.Replication.html @@ -1,4 +1,4 @@ -Replication | Documentation
    interface Replication {
        currentQueueSizeBytes: number;
        description?: string;
        dropNonRetryableData?: boolean;
        id: string;
        latestErrorMessage?: string;
        latestResponseCode?: number;
        localBucketID: string;
        maxQueueSizeBytes: number;
        name: string;
        orgID: string;
        remoteBucketID?: string;
        remoteBucketName?: string;
        remoteID: string;
    }

    Properties

    currentQueueSizeBytes +Replication | Documentation
    interface Replication {
        currentQueueSizeBytes: number;
        description?: string;
        dropNonRetryableData?: boolean;
        id: string;
        latestErrorMessage?: string;
        latestResponseCode?: number;
        localBucketID: string;
        maxQueueSizeBytes: number;
        name: string;
        orgID: string;
        remoteBucketID?: string;
        remoteBucketName?: string;
        remoteID: string;
    }

    Properties

    currentQueueSizeBytes: number
    description?: string
    dropNonRetryableData?: boolean
    id: string
    latestErrorMessage?: string
    latestResponseCode?: number
    localBucketID: string
    maxQueueSizeBytes: number
    name: string
    orgID: string
    remoteBucketID?: string
    remoteBucketName?: string
    remoteID: string
    +

    Properties

    currentQueueSizeBytes: number
    description?: string
    dropNonRetryableData?: boolean
    id: string
    latestErrorMessage?: string
    latestResponseCode?: number
    localBucketID: string
    maxQueueSizeBytes: number
    name: string
    orgID: string
    remoteBucketID?: string
    remoteBucketName?: string
    remoteID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ReplicationCreationRequest.html b/interfaces/_influxdata_influxdb-client-apis.ReplicationCreationRequest.html index 264cf521..81621f73 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ReplicationCreationRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ReplicationCreationRequest.html @@ -1,4 +1,4 @@ -ReplicationCreationRequest | Documentation
    interface ReplicationCreationRequest {
        description?: string;
        dropNonRetryableData?: boolean;
        localBucketID: string;
        maxAgeSeconds: number;
        maxQueueSizeBytes: number;
        name: string;
        orgID: string;
        remoteBucketID?: string;
        remoteBucketName?: string;
        remoteID: string;
    }

    Properties

    description? +ReplicationCreationRequest | Documentation
    interface ReplicationCreationRequest {
        description?: string;
        dropNonRetryableData?: boolean;
        localBucketID: string;
        maxAgeSeconds: number;
        maxQueueSizeBytes: number;
        name: string;
        orgID: string;
        remoteBucketID?: string;
        remoteBucketName?: string;
        remoteID: string;
    }

    Properties

    description?: string
    dropNonRetryableData?: boolean
    localBucketID: string
    maxAgeSeconds: number
    maxQueueSizeBytes: number
    name: string
    orgID: string
    remoteBucketID?: string
    remoteBucketName?: string
    remoteID: string
    +

    Properties

    description?: string
    dropNonRetryableData?: boolean
    localBucketID: string
    maxAgeSeconds: number
    maxQueueSizeBytes: number
    name: string
    orgID: string
    remoteBucketID?: string
    remoteBucketName?: string
    remoteID: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ReplicationUpdateRequest.html b/interfaces/_influxdata_influxdb-client-apis.ReplicationUpdateRequest.html index 9ba97688..117bfad4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ReplicationUpdateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ReplicationUpdateRequest.html @@ -1,4 +1,4 @@ -ReplicationUpdateRequest | Documentation
    interface ReplicationUpdateRequest {
        description?: string;
        dropNonRetryableData?: boolean;
        maxAgeSeconds?: number;
        maxQueueSizeBytes?: number;
        name?: string;
        remoteBucketID?: string;
        remoteBucketName?: string;
        remoteID?: string;
    }

    Properties

    description? +ReplicationUpdateRequest | Documentation
    interface ReplicationUpdateRequest {
        description?: string;
        dropNonRetryableData?: boolean;
        maxAgeSeconds?: number;
        maxQueueSizeBytes?: number;
        name?: string;
        remoteBucketID?: string;
        remoteBucketName?: string;
        remoteID?: string;
    }

    Properties

    description?: string
    dropNonRetryableData?: boolean
    maxAgeSeconds?: number
    maxQueueSizeBytes?: number
    name?: string
    remoteBucketID?: string
    remoteBucketName?: string
    remoteID?: string
    +

    Properties

    description?: string
    dropNonRetryableData?: boolean
    maxAgeSeconds?: number
    maxQueueSizeBytes?: number
    name?: string
    remoteBucketID?: string
    remoteBucketName?: string
    remoteID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Replications.html b/interfaces/_influxdata_influxdb-client-apis.Replications.html index cf47ffab..e358712d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Replications.html +++ b/interfaces/_influxdata_influxdb-client-apis.Replications.html @@ -1,2 +1,2 @@ -Replications | Documentation
    interface Replications {
        replications?: Replication[];
    }

    Properties

    Properties

    replications?: Replication[]
    +Replications | Documentation
    interface Replications {
        replications?: Replication[];
    }

    Properties

    Properties

    replications?: Replication[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RequestOptions.html b/interfaces/_influxdata_influxdb-client-apis.RequestOptions.html index 6d514352..94114569 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RequestOptions.html +++ b/interfaces/_influxdata_influxdb-client-apis.RequestOptions.html @@ -1,7 +1,7 @@ -RequestOptions | Documentation
    interface RequestOptions {
        headers?: { [key: string]: string };
        responseStarted?: (headers: HttpHeaders, statusCode?: number) => void;
    }

    Properties

    headers? +RequestOptions | Documentation
    interface RequestOptions {
        headers?: { [key: string]: string };
        responseStarted?: (headers: HttpHeaders, statusCode?: number) => void;
    }

    Properties

    headers?: { [key: string]: string }

    HTTP request headers

    -
    responseStarted?: (headers: HttpHeaders, statusCode?: number) => void

    Informs about a start of response processing.

    +
    responseStarted?: (headers: HttpHeaders, statusCode?: number) => void

    Informs about a start of response processing.

    Type declaration

      • (headers: HttpHeaders, statusCode?: number): void
      • Parameters

        • headers: HttpHeaders

          response HTTP headers

        • OptionalstatusCode: number

          response status code

          -

        Returns void

    +

    Returns void

    diff --git a/interfaces/_influxdata_influxdb-client-apis.Resource.html b/interfaces/_influxdata_influxdb-client-apis.Resource.html index 0f029ee7..5cbd6eee 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Resource.html +++ b/interfaces/_influxdata_influxdb-client-apis.Resource.html @@ -1,15 +1,15 @@ -Resource | Documentation
    interface Resource {
        id?: string;
        name?: string;
        org?: string;
        orgID?: string;
        type:
            | "authorizations"
            | "buckets"
            | "dashboards"
            | "orgs"
            | "sources"
            | "tasks"
            | "telegrafs"
            | "users"
            | "variables"
            | "scrapers"
            | "secrets"
            | "labels"
            | "views"
            | "documents"
            | "notificationRules"
            | "notificationEndpoints"
            | "checks"
            | "dbrp"
            | "notebooks"
            | "annotations"
            | "remotes"
            | "replications"
            | "instance"
            | "flows"
            | "functions";
    }

    Properties

    id? +Resource | Documentation
    interface Resource {
        id?: string;
        name?: string;
        org?: string;
        orgID?: string;
        type:
            | "authorizations"
            | "buckets"
            | "dashboards"
            | "orgs"
            | "sources"
            | "tasks"
            | "telegrafs"
            | "users"
            | "variables"
            | "scrapers"
            | "secrets"
            | "labels"
            | "views"
            | "documents"
            | "notificationRules"
            | "notificationEndpoints"
            | "checks"
            | "dbrp"
            | "notebooks"
            | "annotations"
            | "remotes"
            | "replications"
            | "instance"
            | "flows"
            | "functions";
    }

    Properties

    Properties

    id?: string

    The ID of a specific resource. In a permission, applies the permission to only the resource with this ID.

    -
    name?: string

    Optional: A name for the resource. +

    name?: string

    Optional: A name for the resource. Not all resource types have a name field.

    -
    org?: string

    Optional: The name of the organization with orgID.

    -
    orgID?: string

    The ID of the organization that owns the resource. +

    org?: string

    Optional: The name of the organization with orgID.

    +
    orgID?: string

    The ID of the organization that owns the resource. In a permission, applies the permission to all resources of type owned by this organization.

    -
    type:
        | "authorizations"
        | "buckets"
        | "dashboards"
        | "orgs"
        | "sources"
        | "tasks"
        | "telegrafs"
        | "users"
        | "variables"
        | "scrapers"
        | "secrets"
        | "labels"
        | "views"
        | "documents"
        | "notificationRules"
        | "notificationEndpoints"
        | "checks"
        | "dbrp"
        | "notebooks"
        | "annotations"
        | "remotes"
        | "replications"
        | "instance"
        | "flows"
        | "functions"

    The type of resource. +

    type:
        | "authorizations"
        | "buckets"
        | "dashboards"
        | "orgs"
        | "sources"
        | "tasks"
        | "telegrafs"
        | "users"
        | "variables"
        | "scrapers"
        | "secrets"
        | "labels"
        | "views"
        | "documents"
        | "notificationRules"
        | "notificationEndpoints"
        | "checks"
        | "dbrp"
        | "notebooks"
        | "annotations"
        | "remotes"
        | "replications"
        | "instance"
        | "flows"
        | "functions"

    The type of resource. In a permission, applies the permission to all resources of this type.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ResourceMembers.html b/interfaces/_influxdata_influxdb-client-apis.ResourceMembers.html index 5cad593e..6844bde6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ResourceMembers.html +++ b/interfaces/_influxdata_influxdb-client-apis.ResourceMembers.html @@ -1,3 +1,3 @@ -ResourceMembers | Documentation
    interface ResourceMembers {
        links?: { self?: string };
        users?: ResourceMember[];
    }

    Properties

    links? +ResourceMembers | Documentation
    interface ResourceMembers {
        links?: { self?: string };
        users?: ResourceMember[];
    }

    Properties

    Properties

    links?: { self?: string }
    users?: ResourceMember[]
    +

    Properties

    links?: { self?: string }
    users?: ResourceMember[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ResourceOwners.html b/interfaces/_influxdata_influxdb-client-apis.ResourceOwners.html index c05002d7..37a9f7eb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ResourceOwners.html +++ b/interfaces/_influxdata_influxdb-client-apis.ResourceOwners.html @@ -1,3 +1,3 @@ -ResourceOwners | Documentation
    interface ResourceOwners {
        links?: { self?: string };
        users?: ResourceOwner[];
    }

    Properties

    links? +ResourceOwners | Documentation
    interface ResourceOwners {
        links?: { self?: string };
        users?: ResourceOwner[];
    }

    Properties

    Properties

    links?: { self?: string }
    users?: ResourceOwner[]
    +

    Properties

    links?: { self?: string }
    users?: ResourceOwner[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RestoredBucketMappings.html b/interfaces/_influxdata_influxdb-client-apis.RestoredBucketMappings.html index 16411efc..3a31e5c7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RestoredBucketMappings.html +++ b/interfaces/_influxdata_influxdb-client-apis.RestoredBucketMappings.html @@ -1,5 +1,5 @@ -RestoredBucketMappings | Documentation
    interface RestoredBucketMappings {
        id: string;
        name: string;
        shardMappings: BucketShardMappings;
    }

    Properties

    id +RestoredBucketMappings | Documentation
    interface RestoredBucketMappings {
        id: string;
        name: string;
        shardMappings: BucketShardMappings;
    }

    Properties

    Properties

    id: string

    New ID of the restored bucket

    -
    name: string
    shardMappings: BucketShardMappings
    +
    name: string
    shardMappings: BucketShardMappings
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RetentionPolicyManifest.html b/interfaces/_influxdata_influxdb-client-apis.RetentionPolicyManifest.html index b09da919..8046fad8 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RetentionPolicyManifest.html +++ b/interfaces/_influxdata_influxdb-client-apis.RetentionPolicyManifest.html @@ -1,7 +1,7 @@ -RetentionPolicyManifest | Documentation
    interface RetentionPolicyManifest {
        duration: number;
        name: string;
        replicaN: number;
        shardGroupDuration: number;
        shardGroups: ShardGroupManifests;
        subscriptions: SubscriptionManifests;
    }

    Properties

    duration +RetentionPolicyManifest | Documentation
    interface RetentionPolicyManifest {
        duration: number;
        name: string;
        replicaN: number;
        shardGroupDuration: number;
        shardGroups: ShardGroupManifests;
        subscriptions: SubscriptionManifests;
    }

    Properties

    duration: number
    name: string
    replicaN: number
    shardGroupDuration: number
    shardGroups: ShardGroupManifests
    subscriptions: SubscriptionManifests
    +

    Properties

    duration: number
    name: string
    replicaN: number
    shardGroupDuration: number
    shardGroups: ShardGroupManifests
    subscriptions: SubscriptionManifests
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RetentionRule.html b/interfaces/_influxdata_influxdb-client-apis.RetentionRule.html index debc5006..656b7c66 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RetentionRule.html +++ b/interfaces/_influxdata_influxdb-client-apis.RetentionRule.html @@ -1,10 +1,10 @@ -RetentionRule | Documentation
    interface RetentionRule {
        everySeconds: number;
        shardGroupDurationSeconds?: number;
        type?: "expire";
    }

    Properties

    everySeconds +RetentionRule | Documentation
    interface RetentionRule {
        everySeconds: number;
        shardGroupDurationSeconds?: number;
        type?: "expire";
    }

    Properties

    everySeconds: number

    The duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention.

    -
    shardGroupDurationSeconds?: number

    The shard group duration. +

    shardGroupDurationSeconds?: number

    The shard group duration. The duration or interval (in seconds) that each shard group covers.

    -
    type?: "expire"
    +
    type?: "expire"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ReturnStatement.html b/interfaces/_influxdata_influxdb-client-apis.ReturnStatement.html index 1814eecb..6921678e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ReturnStatement.html +++ b/interfaces/_influxdata_influxdb-client-apis.ReturnStatement.html @@ -1,4 +1,4 @@ ReturnStatement | Documentation

    Defines an expression to return

    -
    interface ReturnStatement {
        argument?: Expression;
        type?: string;
    }

    Properties

    interface ReturnStatement {
        argument?: Expression;
        type?: string;
    }

    Properties

    Properties

    argument?: Expression
    type?: string
    +

    Properties

    argument?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Routes.html b/interfaces/_influxdata_influxdb-client-apis.Routes.html index 7acca587..a8fd414a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Routes.html +++ b/interfaces/_influxdata_influxdb-client-apis.Routes.html @@ -1,4 +1,4 @@ -Routes | Documentation
    interface Routes {
        authorizations?: string;
        buckets?: string;
        dashboards?: string;
        external?: { statusFeed?: string };
        flags?: string;
        me?: string;
        orgs?: string;
        query?: {
            analyze?: string;
            ast?: string;
            self?: string;
            suggestions?: string;
        };
        setup?: string;
        signin?: string;
        signout?: string;
        sources?: string;
        system?: { debug?: string; health?: string; metrics?: string };
        tasks?: string;
        telegrafs?: string;
        users?: string;
        variables?: string;
        write?: string;
    }

    Properties

    authorizations? +Routes | Documentation
    interface Routes {
        authorizations?: string;
        buckets?: string;
        dashboards?: string;
        external?: { statusFeed?: string };
        flags?: string;
        me?: string;
        orgs?: string;
        query?: {
            analyze?: string;
            ast?: string;
            self?: string;
            suggestions?: string;
        };
        setup?: string;
        signin?: string;
        signout?: string;
        sources?: string;
        system?: { debug?: string; health?: string; metrics?: string };
        tasks?: string;
        telegrafs?: string;
        users?: string;
        variables?: string;
        write?: string;
    }

    Properties

    authorizations?: string
    buckets?: string
    dashboards?: string
    external?: { statusFeed?: string }
    flags?: string
    me?: string
    orgs?: string
    query?: { analyze?: string; ast?: string; self?: string; suggestions?: string }
    setup?: string
    signin?: string
    signout?: string
    sources?: string
    system?: { debug?: string; health?: string; metrics?: string }
    tasks?: string
    telegrafs?: string
    users?: string
    variables?: string
    write?: string
    +

    Properties

    authorizations?: string
    buckets?: string
    dashboards?: string
    external?: { statusFeed?: string }
    flags?: string
    me?: string
    orgs?: string
    query?: { analyze?: string; ast?: string; self?: string; suggestions?: string }
    setup?: string
    signin?: string
    signout?: string
    sources?: string
    system?: { debug?: string; health?: string; metrics?: string }
    tasks?: string
    telegrafs?: string
    users?: string
    variables?: string
    write?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Run.html b/interfaces/_influxdata_influxdb-client-apis.Run.html index ab618b6f..9b80faaa 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Run.html +++ b/interfaces/_influxdata_influxdb-client-apis.Run.html @@ -1,4 +1,4 @@ -Run | Documentation
    interface Run {
        finishedAt?: string;
        flux?: string;
        id?: string;
        links?: { retry?: string; self?: string; task?: string };
        log?: LogEvent[];
        requestedAt?: string;
        scheduledFor?: string;
        startedAt?: string;
        status?: "failed" | "success" | "canceled" | "scheduled" | "started";
        taskID?: string;
    }

    Properties

    finishedAt? +Run | Documentation
    interface Run {
        finishedAt?: string;
        flux?: string;
        id?: string;
        links?: { retry?: string; self?: string; task?: string };
        log?: LogEvent[];
        requestedAt?: string;
        scheduledFor?: string;
        startedAt?: string;
        status?: "failed" | "success" | "canceled" | "scheduled" | "started";
        taskID?: string;
    }

    Properties

    Properties

    finishedAt?: string

    The time (RFC3339Nano date/time format) the run finished executing.

    -
    flux?: string

    Flux used for the task

    -
    id?: string
    links?: { retry?: string; self?: string; task?: string }
    log?: LogEvent[]

    An array of logs associated with the run.

    -
    requestedAt?: string

    The time (RFC3339Nano date/time format) the run was manually requested.

    -
    scheduledFor?: string

    The time RFC3339 date/time format used for the run's now option.

    -
    startedAt?: string

    The time (RFC3339Nano date/time format) the run started executing.

    -
    status?: "failed" | "success" | "canceled" | "scheduled" | "started"
    taskID?: string
    +
    flux?: string

    Flux used for the task

    +
    id?: string
    links?: { retry?: string; self?: string; task?: string }
    log?: LogEvent[]

    An array of logs associated with the run.

    +
    requestedAt?: string

    The time (RFC3339Nano date/time format) the run was manually requested.

    +
    scheduledFor?: string

    The time RFC3339 date/time format used for the run's now option.

    +
    startedAt?: string

    The time (RFC3339Nano date/time format) the run started executing.

    +
    status?: "failed" | "success" | "canceled" | "scheduled" | "started"
    taskID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.RunManually.html b/interfaces/_influxdata_influxdb-client-apis.RunManually.html index 244d3836..27a28e0b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.RunManually.html +++ b/interfaces/_influxdata_influxdb-client-apis.RunManually.html @@ -1,5 +1,5 @@ -RunManually | Documentation
    interface RunManually {
        scheduledFor?: string;
    }

    Properties

    scheduledFor? +RunManually | Documentation
    interface RunManually {
        scheduledFor?: string;
    }

    Properties

    Properties

    scheduledFor?: string

    The time RFC3339 date/time format used for the run's now option. Default is the server now time.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Runs.html b/interfaces/_influxdata_influxdb-client-apis.Runs.html index 9edc419a..35cedf9c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Runs.html +++ b/interfaces/_influxdata_influxdb-client-apis.Runs.html @@ -1,3 +1,3 @@ -Runs | Documentation
    interface Runs {
        links?: Links;
        runs?: Run[];
    }

    Properties

    links? +Runs | Documentation
    interface Runs {
        links?: Links;
        runs?: Run[];
    }

    Properties

    Properties

    links?: Links
    runs?: Run[]
    +

    Properties

    links?: Links
    runs?: Run[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.SMTPNotificationRuleBase.html b/interfaces/_influxdata_influxdb-client-apis.SMTPNotificationRuleBase.html index 8d86df70..7a827191 100644 --- a/interfaces/_influxdata_influxdb-client-apis.SMTPNotificationRuleBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.SMTPNotificationRuleBase.html @@ -1,5 +1,5 @@ -SMTPNotificationRuleBase | Documentation
    interface SMTPNotificationRuleBase {
        bodyTemplate?: string;
        subjectTemplate: string;
        to: string;
        type: "smtp";
    }

    Properties

    bodyTemplate? +SMTPNotificationRuleBase | Documentation
    interface SMTPNotificationRuleBase {
        bodyTemplate?: string;
        subjectTemplate: string;
        to: string;
        type: "smtp";
    }

    Properties

    bodyTemplate?: string
    subjectTemplate: string
    to: string
    type: "smtp"
    +

    Properties

    bodyTemplate?: string
    subjectTemplate: string
    to: string
    type: "smtp"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ScatterViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.ScatterViewProperties.html index 9cfc1031..f849b90f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ScatterViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.ScatterViewProperties.html @@ -1,4 +1,4 @@ -ScatterViewProperties | Documentation
    interface ScatterViewProperties {
        adaptiveZoomHide?: boolean;
        colors: string[];
        fillColumns: string[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        symbolColumns: string[];
        timeFormat?: string;
        type: "scatter";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
        xPrefix: string;
        xSuffix: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yAxisLabel: string;
        yColumn: string;
        yDomain: number[];
        yPrefix: string;
        ySuffix: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide? +ScatterViewProperties | Documentation
    interface ScatterViewProperties {
        adaptiveZoomHide?: boolean;
        colors: string[];
        fillColumns: string[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        symbolColumns: string[];
        timeFormat?: string;
        type: "scatter";
        xAxisLabel: string;
        xColumn: string;
        xDomain: number[];
        xPrefix: string;
        xSuffix: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yAxisLabel: string;
        yColumn: string;
        yDomain: number[];
        yPrefix: string;
        ySuffix: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide?: boolean
    colors: string[]

    Colors define color encoding of data into a visualization

    -
    fillColumns: string[]
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    symbolColumns: string[]
    timeFormat?: string
    type: "scatter"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    xPrefix: string
    xSuffix: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yAxisLabel: string
    yColumn: string
    yDomain: number[]
    yPrefix: string
    ySuffix: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    +

    Properties

    adaptiveZoomHide?: boolean
    colors: string[]

    Colors define color encoding of data into a visualization

    +
    fillColumns: string[]
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    symbolColumns: string[]
    timeFormat?: string
    type: "scatter"
    xAxisLabel: string
    xColumn: string
    xDomain: number[]
    xPrefix: string
    xSuffix: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yAxisLabel: string
    yColumn: string
    yDomain: number[]
    yPrefix: string
    ySuffix: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ScraperTargetRequest.html b/interfaces/_influxdata_influxdb-client-apis.ScraperTargetRequest.html index 38f5a16e..3286ef65 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ScraperTargetRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ScraperTargetRequest.html @@ -1,13 +1,13 @@ -ScraperTargetRequest | Documentation
    interface ScraperTargetRequest {
        allowInsecure?: boolean;
        bucketID?: string;
        name?: string;
        orgID?: string;
        type?: "prometheus";
        url?: string;
    }

    Properties

    allowInsecure? +ScraperTargetRequest | Documentation
    interface ScraperTargetRequest {
        allowInsecure?: boolean;
        bucketID?: string;
        name?: string;
        orgID?: string;
        type?: "prometheus";
        url?: string;
    }

    Properties

    allowInsecure?: boolean

    Skip TLS verification on endpoint.

    -
    bucketID?: string

    The ID of the bucket to write to.

    -
    name?: string

    The name of the scraper target.

    -
    orgID?: string

    The organization ID.

    -
    type?: "prometheus"

    The type of the metrics to be parsed.

    -
    url?: string

    The URL of the metrics endpoint.

    -
    +
    bucketID?: string

    The ID of the bucket to write to.

    +
    name?: string

    The name of the scraper target.

    +
    orgID?: string

    The organization ID.

    +
    type?: "prometheus"

    The type of the metrics to be parsed.

    +
    url?: string

    The URL of the metrics endpoint.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ScraperTargetResponses.html b/interfaces/_influxdata_influxdb-client-apis.ScraperTargetResponses.html index 47ab7b55..5c4c069b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ScraperTargetResponses.html +++ b/interfaces/_influxdata_influxdb-client-apis.ScraperTargetResponses.html @@ -1,2 +1,2 @@ -ScraperTargetResponses | Documentation
    interface ScraperTargetResponses {
        configurations?: ScraperTargetResponse[];
    }

    Properties

    Properties

    configurations?: ScraperTargetResponse[]
    +ScraperTargetResponses | Documentation
    interface ScraperTargetResponses {
        configurations?: ScraperTargetResponse[];
    }

    Properties

    Properties

    configurations?: ScraperTargetResponse[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Script.html b/interfaces/_influxdata_influxdb-client-apis.Script.html index dc2260af..fd73ae9c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Script.html +++ b/interfaces/_influxdata_influxdb-client-apis.Script.html @@ -1,4 +1,4 @@ -Script | Documentation
    interface Script {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: string[];
        language?: "flux";
        name: string;
        orgID: string;
        script: string;
        updatedAt?: string;
        url?: string;
    }

    Properties

    createdAt? +Script | Documentation
    interface Script {
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: string[];
        language?: "flux";
        name: string;
        orgID: string;
        script: string;
        updatedAt?: string;
        url?: string;
    }

    Properties

    createdAt?: string
    description?: string
    id?: string
    labels?: string[]

    The list of label names associated with the script.

    -
    language?: "flux"
    name: string
    orgID: string
    script: string

    The script to execute.

    -
    updatedAt?: string
    url?: string

    The invocation endpoint address.

    -
    +

    Properties

    createdAt?: string
    description?: string
    id?: string
    labels?: string[]

    The list of label names associated with the script.

    +
    language?: "flux"
    name: string
    orgID: string
    script: string

    The script to execute.

    +
    updatedAt?: string
    url?: string

    The invocation endpoint address.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ScriptCreateRequest.html b/interfaces/_influxdata_influxdb-client-apis.ScriptCreateRequest.html index 4552c17e..d9146fce 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ScriptCreateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ScriptCreateRequest.html @@ -1,8 +1,8 @@ -ScriptCreateRequest | Documentation
    interface ScriptCreateRequest {
        description: string;
        language: "flux";
        name: string;
        script: string;
    }

    Properties

    description +ScriptCreateRequest | Documentation
    interface ScriptCreateRequest {
        description: string;
        language: "flux";
        name: string;
        script: string;
    }

    Properties

    description: string

    Script description. A description of the script.

    -
    language: "flux"
    name: string

    Script name. The name must be unique within the organization.

    -
    script: string

    The script to execute.

    -
    +
    language: "flux"
    name: string

    Script name. The name must be unique within the organization.

    +
    script: string

    The script to execute.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ScriptInvocationParams.html b/interfaces/_influxdata_influxdb-client-apis.ScriptInvocationParams.html index 0c15cdf7..b86edf1e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ScriptInvocationParams.html +++ b/interfaces/_influxdata_influxdb-client-apis.ScriptInvocationParams.html @@ -1,7 +1,7 @@ -ScriptInvocationParams | Documentation
    interface ScriptInvocationParams {
        params?: any;
    }

    Properties

    params? +ScriptInvocationParams | Documentation
    interface ScriptInvocationParams {
        params?: any;
    }

    Properties

    Properties

    params?: any

    The script parameters. params contains key-value pairs that map values to the params.keys in a script. When you invoke a script with params, InfluxDB passes the values as invocation parameters to the script.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ScriptUpdateRequest.html b/interfaces/_influxdata_influxdb-client-apis.ScriptUpdateRequest.html index f1dff822..3695173f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ScriptUpdateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ScriptUpdateRequest.html @@ -1,5 +1,5 @@ -ScriptUpdateRequest | Documentation
    interface ScriptUpdateRequest {
        description?: string;
        name?: string;
        script?: string;
    }

    Properties

    description? +ScriptUpdateRequest | Documentation
    interface ScriptUpdateRequest {
        description?: string;
        name?: string;
        script?: string;
    }

    Properties

    description?: string
    name?: string
    script?: string

    script is script to be executed

    -
    +

    Properties

    description?: string
    name?: string
    script?: string

    script is script to be executed

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Scripts.html b/interfaces/_influxdata_influxdb-client-apis.Scripts.html index 929d85c5..9b3b6c5f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Scripts.html +++ b/interfaces/_influxdata_influxdb-client-apis.Scripts.html @@ -1,2 +1,2 @@ -Scripts | Documentation
    interface Scripts {
        scripts?: Script[];
    }

    Properties

    Properties

    scripts?: Script[]
    +Scripts | Documentation
    interface Scripts {
        scripts?: Script[];
    }

    Properties

    Properties

    scripts?: Script[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.SecretKeys.html b/interfaces/_influxdata_influxdb-client-apis.SecretKeys.html index 3960ab90..a5b88465 100644 --- a/interfaces/_influxdata_influxdb-client-apis.SecretKeys.html +++ b/interfaces/_influxdata_influxdb-client-apis.SecretKeys.html @@ -1,2 +1,2 @@ -SecretKeys | Documentation
    interface SecretKeys {
        secrets?: string[];
    }

    Properties

    Properties

    secrets?: string[]
    +SecretKeys | Documentation
    interface SecretKeys {
        secrets?: string[];
    }

    Properties

    Properties

    secrets?: string[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ShardGroupManifest.html b/interfaces/_influxdata_influxdb-client-apis.ShardGroupManifest.html index 602fe6a3..47319948 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ShardGroupManifest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ShardGroupManifest.html @@ -1,7 +1,7 @@ -ShardGroupManifest | Documentation
    interface ShardGroupManifest {
        deletedAt?: string;
        endTime: string;
        id: number;
        shards: ShardManifests;
        startTime: string;
        truncatedAt?: string;
    }

    Properties

    deletedAt? +ShardGroupManifest | Documentation
    interface ShardGroupManifest {
        deletedAt?: string;
        endTime: string;
        id: number;
        shards: ShardManifests;
        startTime: string;
        truncatedAt?: string;
    }

    Properties

    deletedAt?: string
    endTime: string
    id: number
    startTime: string
    truncatedAt?: string
    +

    Properties

    deletedAt?: string
    endTime: string
    id: number
    startTime: string
    truncatedAt?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ShardManifest.html b/interfaces/_influxdata_influxdb-client-apis.ShardManifest.html index 2ae7f9d7..ebe10076 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ShardManifest.html +++ b/interfaces/_influxdata_influxdb-client-apis.ShardManifest.html @@ -1,3 +1,3 @@ -ShardManifest | Documentation
    interface ShardManifest {
        id: number;
        shardOwners: ShardOwners;
    }

    Properties

    id +ShardManifest | Documentation
    interface ShardManifest {
        id: number;
        shardOwners: ShardOwners;
    }

    Properties

    Properties

    id: number
    shardOwners: ShardOwners
    +

    Properties

    id: number
    shardOwners: ShardOwners
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ShardOwner.html b/interfaces/_influxdata_influxdb-client-apis.ShardOwner.html index bc632d45..0a5d2c0a 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ShardOwner.html +++ b/interfaces/_influxdata_influxdb-client-apis.ShardOwner.html @@ -1,3 +1,3 @@ -ShardOwner | Documentation
    interface ShardOwner {
        nodeID: number;
    }

    Properties

    nodeID +ShardOwner | Documentation
    interface ShardOwner {
        nodeID: number;
    }

    Properties

    Properties

    nodeID: number

    The ID of the node that owns the shard.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.SimpleTableViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.SimpleTableViewProperties.html index e6eea38f..62731a01 100644 --- a/interfaces/_influxdata_influxdb-client-apis.SimpleTableViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.SimpleTableViewProperties.html @@ -1,8 +1,8 @@ -SimpleTableViewProperties | Documentation
    interface SimpleTableViewProperties {
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showAll: boolean;
        showNoteWhenEmpty: boolean;
        type: "simple-table";
    }

    Properties

    note +SimpleTableViewProperties | Documentation
    interface SimpleTableViewProperties {
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showAll: boolean;
        showNoteWhenEmpty: boolean;
        type: "simple-table";
    }

    Properties

    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showAll: boolean
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    type: "simple-table"
    +

    Properties

    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showAll: boolean
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    type: "simple-table"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.SingleStatViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.SingleStatViewProperties.html index 89754528..f64597e0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.SingleStatViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.SingleStatViewProperties.html @@ -1,4 +1,4 @@ -SingleStatViewProperties | Documentation
    interface SingleStatViewProperties {
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        note: string;
        prefix: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        suffix: string;
        tickPrefix: string;
        tickSuffix: string;
        type: "single-stat";
    }

    Properties

    colors +SingleStatViewProperties | Documentation
    interface SingleStatViewProperties {
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        note: string;
        prefix: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        suffix: string;
        tickPrefix: string;
        tickSuffix: string;
        type: "single-stat";
    }

    Properties

    Properties

    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    decimalPlaces: DecimalPlaces
    note: string
    prefix: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    staticLegend?: StaticLegend
    suffix: string
    tickPrefix: string
    tickSuffix: string
    type: "single-stat"
    +
    decimalPlaces: DecimalPlaces
    note: string
    prefix: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    staticLegend?: StaticLegend
    suffix: string
    tickPrefix: string
    tickSuffix: string
    type: "single-stat"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.SlackNotificationRuleBase.html b/interfaces/_influxdata_influxdb-client-apis.SlackNotificationRuleBase.html index e92c75a5..8e0b1110 100644 --- a/interfaces/_influxdata_influxdb-client-apis.SlackNotificationRuleBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.SlackNotificationRuleBase.html @@ -1,4 +1,4 @@ -SlackNotificationRuleBase | Documentation
    interface SlackNotificationRuleBase {
        channel?: string;
        messageTemplate: string;
        type: "slack";
    }

    Properties

    channel? +SlackNotificationRuleBase | Documentation
    interface SlackNotificationRuleBase {
        channel?: string;
        messageTemplate: string;
        type: "slack";
    }

    Properties

    channel?: string
    messageTemplate: string
    type: "slack"
    +

    Properties

    channel?: string
    messageTemplate: string
    type: "slack"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Source.html b/interfaces/_influxdata_influxdb-client-apis.Source.html index 1ae27f66..d86e54eb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Source.html +++ b/interfaces/_influxdata_influxdb-client-apis.Source.html @@ -1,4 +1,4 @@ -Source | Documentation
    interface Source {
        default?: boolean;
        defaultRP?: string;
        id?: string;
        insecureSkipVerify?: boolean;
        languages?: ("flux" | "influxql")[];
        links?: {
            buckets?: string;
            health?: string;
            query?: string;
            self?: string;
        };
        metaUrl?: string;
        name?: string;
        orgID?: string;
        password?: string;
        sharedSecret?: string;
        telegraf?: string;
        token?: string;
        type?: "v1"
        | "v2"
        | "self";
        url?: string;
        username?: string;
    }

    Properties

    default? +Source | Documentation
    interface Source {
        default?: boolean;
        defaultRP?: string;
        id?: string;
        insecureSkipVerify?: boolean;
        languages?: ("flux" | "influxql")[];
        links?: {
            buckets?: string;
            health?: string;
            query?: string;
            self?: string;
        };
        metaUrl?: string;
        name?: string;
        orgID?: string;
        password?: string;
        sharedSecret?: string;
        telegraf?: string;
        token?: string;
        type?: "v1"
        | "v2"
        | "self";
        url?: string;
        username?: string;
    }

    Properties

    default?: boolean
    defaultRP?: string
    id?: string
    insecureSkipVerify?: boolean
    languages?: ("flux" | "influxql")[]
    links?: { buckets?: string; health?: string; query?: string; self?: string }
    metaUrl?: string
    name?: string
    orgID?: string
    password?: string
    sharedSecret?: string
    telegraf?: string
    token?: string
    type?: "v1" | "v2" | "self"
    url?: string
    username?: string
    +

    Properties

    default?: boolean
    defaultRP?: string
    id?: string
    insecureSkipVerify?: boolean
    languages?: ("flux" | "influxql")[]
    links?: { buckets?: string; health?: string; query?: string; self?: string }
    metaUrl?: string
    name?: string
    orgID?: string
    password?: string
    sharedSecret?: string
    telegraf?: string
    token?: string
    type?: "v1" | "v2" | "self"
    url?: string
    username?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Sources.html b/interfaces/_influxdata_influxdb-client-apis.Sources.html index a340b159..78506fe6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Sources.html +++ b/interfaces/_influxdata_influxdb-client-apis.Sources.html @@ -1,3 +1,3 @@ -Sources | Documentation
    interface Sources {
        links?: { self?: string };
        sources?: Source[];
    }

    Properties

    links? +Sources | Documentation
    interface Sources {
        links?: { self?: string };
        sources?: Source[];
    }

    Properties

    Properties

    links?: { self?: string }
    sources?: Source[]
    +

    Properties

    links?: { self?: string }
    sources?: Source[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Stack.html b/interfaces/_influxdata_influxdb-client-apis.Stack.html index aa84481c..dfaf7fce 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Stack.html +++ b/interfaces/_influxdata_influxdb-client-apis.Stack.html @@ -1,5 +1,5 @@ -Stack | Documentation
    interface Stack {
        createdAt?: string;
        events?: {
            description?: string;
            eventType?: string;
            name?: string;
            resources?: {
                apiVersion?: string;
                associations?: { kind?: TemplateKind; metaName?: string }[];
                kind?: TemplateKind;
                links?: { self?: string };
                resourceID?: string;
                templateMetaName?: string;
            }[];
            sources?: string[];
            updatedAt?: string;
            urls?: string[];
        }[];
        id?: string;
        orgID?: string;
    }

    Properties

    createdAt? +Stack | Documentation
    interface Stack {
        createdAt?: string;
        events?: {
            description?: string;
            eventType?: string;
            name?: string;
            resources?: {
                apiVersion?: string;
                associations?: { kind?: TemplateKind; metaName?: string }[];
                kind?: TemplateKind;
                links?: { self?: string };
                resourceID?: string;
                templateMetaName?: string;
            }[];
            sources?: string[];
            updatedAt?: string;
            urls?: string[];
        }[];
        id?: string;
        orgID?: string;
    }

    Properties

    createdAt?: string
    events?: {
        description?: string;
        eventType?: string;
        name?: string;
        resources?: {
            apiVersion?: string;
            associations?: { kind?: TemplateKind; metaName?: string }[];
            kind?: TemplateKind;
            links?: { self?: string };
            resourceID?: string;
            templateMetaName?: string;
        }[];
        sources?: string[];
        updatedAt?: string;
        urls?: string[];
    }[]
    id?: string
    orgID?: string
    +

    Properties

    createdAt?: string
    events?: {
        description?: string;
        eventType?: string;
        name?: string;
        resources?: {
            apiVersion?: string;
            associations?: { kind?: TemplateKind; metaName?: string }[];
            kind?: TemplateKind;
            links?: { self?: string };
            resourceID?: string;
            templateMetaName?: string;
        }[];
        sources?: string[];
        updatedAt?: string;
        urls?: string[];
    }[]
    id?: string
    orgID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.StaticLegend.html b/interfaces/_influxdata_influxdb-client-apis.StaticLegend.html index 3fd1fcd8..9eeb66d1 100644 --- a/interfaces/_influxdata_influxdb-client-apis.StaticLegend.html +++ b/interfaces/_influxdata_influxdb-client-apis.StaticLegend.html @@ -1,9 +1,9 @@ StaticLegend | Documentation

    StaticLegend represents the options specific to the static legend

    -
    interface StaticLegend {
        colorizeRows?: boolean;
        heightRatio?: number;
        opacity?: number;
        orientationThreshold?: number;
        show?: boolean;
        valueAxis?: string;
        widthRatio?: number;
    }

    Properties

    interface StaticLegend {
        colorizeRows?: boolean;
        heightRatio?: number;
        opacity?: number;
        orientationThreshold?: number;
        show?: boolean;
        valueAxis?: string;
        widthRatio?: number;
    }

    Properties

    colorizeRows?: boolean
    heightRatio?: number
    opacity?: number
    orientationThreshold?: number
    show?: boolean
    valueAxis?: string
    widthRatio?: number
    +

    Properties

    colorizeRows?: boolean
    heightRatio?: number
    opacity?: number
    orientationThreshold?: number
    show?: boolean
    valueAxis?: string
    widthRatio?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.StatusRule.html b/interfaces/_influxdata_influxdb-client-apis.StatusRule.html index db40dd8d..2fe235b9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.StatusRule.html +++ b/interfaces/_influxdata_influxdb-client-apis.StatusRule.html @@ -1,5 +1,5 @@ -StatusRule | Documentation
    interface StatusRule {
        count?: number;
        currentLevel?: RuleStatusLevel;
        period?: string;
        previousLevel?: RuleStatusLevel;
    }

    Properties

    count? +StatusRule | Documentation
    interface StatusRule {
        count?: number;
        currentLevel?: RuleStatusLevel;
        period?: string;
        previousLevel?: RuleStatusLevel;
    }

    Properties

    count?: number
    currentLevel?: RuleStatusLevel
    period?: string
    previousLevel?: RuleStatusLevel
    +

    Properties

    count?: number
    currentLevel?: RuleStatusLevel
    period?: string
    previousLevel?: RuleStatusLevel
    diff --git a/interfaces/_influxdata_influxdb-client-apis.StringLiteral.html b/interfaces/_influxdata_influxdb-client-apis.StringLiteral.html index 845441d7..d9269feb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.StringLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.StringLiteral.html @@ -1,4 +1,4 @@ StringLiteral | Documentation

    Expressions begin and end with double quote marks

    -
    interface StringLiteral {
        type?: string;
        value?: string;
    }

    Properties

    interface StringLiteral {
        type?: string;
        value?: string;
    }

    Properties

    Properties

    type?: string
    value?: string
    +

    Properties

    type?: string
    value?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.SubscriptionManifest.html b/interfaces/_influxdata_influxdb-client-apis.SubscriptionManifest.html index 7bb86aa4..01c7574b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.SubscriptionManifest.html +++ b/interfaces/_influxdata_influxdb-client-apis.SubscriptionManifest.html @@ -1,4 +1,4 @@ -SubscriptionManifest | Documentation
    interface SubscriptionManifest {
        destinations: string[];
        mode: string;
        name: string;
    }

    Properties

    destinations +SubscriptionManifest | Documentation
    interface SubscriptionManifest {
        destinations: string[];
        mode: string;
        name: string;
    }

    Properties

    Properties

    destinations: string[]
    mode: string
    name: string
    +

    Properties

    destinations: string[]
    mode: string
    name: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TableViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.TableViewProperties.html index 394c1fdd..3b44547b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TableViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.TableViewProperties.html @@ -1,4 +1,4 @@ -TableViewProperties | Documentation
    interface TableViewProperties {
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        fieldOptions: RenamableField[];
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        tableOptions: {
            fixFirstColumn?: boolean;
            sortBy?: RenamableField;
            verticalTimeAxis?: boolean;
            wrapping?: "truncate" | "wrap" | "single-line";
        };
        timeFormat: string;
        type: "table";
    }

    Properties

    colors +TableViewProperties | Documentation
    interface TableViewProperties {
        colors: DashboardColor[];
        decimalPlaces: DecimalPlaces;
        fieldOptions: RenamableField[];
        note: string;
        queries: DashboardQuery[];
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        tableOptions: {
            fixFirstColumn?: boolean;
            sortBy?: RenamableField;
            verticalTimeAxis?: boolean;
            wrapping?: "truncate" | "wrap" | "single-line";
        };
        timeFormat: string;
        type: "table";
    }

    Properties

    Properties

    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    decimalPlaces: DecimalPlaces
    fieldOptions: RenamableField[]

    fieldOptions represent the fields retrieved by the query with customization options

    -
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    tableOptions: {
        fixFirstColumn?: boolean;
        sortBy?: RenamableField;
        verticalTimeAxis?: boolean;
        wrapping?: "truncate" | "wrap" | "single-line";
    }

    Type declaration

    • OptionalfixFirstColumn?: boolean

      fixFirstColumn indicates whether the first column of the table should be locked

      +
    decimalPlaces: DecimalPlaces
    fieldOptions: RenamableField[]

    fieldOptions represent the fields retrieved by the query with customization options

    +
    note: string
    queries: DashboardQuery[]
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    tableOptions: {
        fixFirstColumn?: boolean;
        sortBy?: RenamableField;
        verticalTimeAxis?: boolean;
        wrapping?: "truncate" | "wrap" | "single-line";
    }

    Type declaration

    • OptionalfixFirstColumn?: boolean

      fixFirstColumn indicates whether the first column of the table should be locked

    • OptionalsortBy?: RenamableField
    • OptionalverticalTimeAxis?: boolean

      verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically

    • Optionalwrapping?: "truncate" | "wrap" | "single-line"

      Wrapping describes the text wrapping style to be used in table views

      -
    timeFormat: string

    timeFormat describes the display format for time values according to moment.js date formatting

    -
    type: "table"
    +
    timeFormat: string

    timeFormat describes the display format for time values according to moment.js date formatting

    +
    type: "table"
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TagRule.html b/interfaces/_influxdata_influxdb-client-apis.TagRule.html index 460f8ffe..0a9c8555 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TagRule.html +++ b/interfaces/_influxdata_influxdb-client-apis.TagRule.html @@ -1,4 +1,4 @@ -TagRule | Documentation
    interface TagRule {
        key?: string;
        operator?: "equal" | "notequal" | "equalregex" | "notequalregex";
        value?: string;
    }

    Properties

    key? +TagRule | Documentation
    interface TagRule {
        key?: string;
        operator?: "equal" | "notequal" | "equalregex" | "notequalregex";
        value?: string;
    }

    Properties

    Properties

    key?: string
    operator?: "equal" | "notequal" | "equalregex" | "notequalregex"
    value?: string
    +

    Properties

    key?: string
    operator?: "equal" | "notequal" | "equalregex" | "notequalregex"
    value?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Task.html b/interfaces/_influxdata_influxdb-client-apis.Task.html index 2a733a9f..a92e7f8d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Task.html +++ b/interfaces/_influxdata_influxdb-client-apis.Task.html @@ -1,4 +1,4 @@ -Task | Documentation
    interface Task {
        authorizationID?: string;
        createdAt?: string;
        cron?: string;
        description?: string;
        every?: string;
        flux: string;
        id: string;
        labels?: Labels;
        lastRunError?: string;
        lastRunStatus?: "failed" | "success" | "canceled";
        latestCompleted?: string;
        links?: {
            labels?: string;
            logs?: string;
            members?: string;
            owners?: string;
            runs?: string;
            self?: string;
        };
        name: string;
        offset?: string;
        org?: string;
        orgID: string;
        ownerID?: string;
        status?: TaskStatusType;
        updatedAt?: string;
    }

    Properties

    authorizationID? +Task | Documentation
    interface Task {
        authorizationID?: string;
        createdAt?: string;
        cron?: string;
        description?: string;
        every?: string;
        flux: string;
        id: string;
        labels?: Labels;
        lastRunError?: string;
        lastRunStatus?: "failed" | "success" | "canceled";
        latestCompleted?: string;
        links?: {
            labels?: string;
            logs?: string;
            members?: string;
            owners?: string;
            runs?: string;
            self?: string;
        };
        name: string;
        offset?: string;
        org?: string;
        orgID: string;
        ownerID?: string;
        status?: TaskStatusType;
        updatedAt?: string;
    }

    Properties

    authorizationID? createdAt? cron? description? @@ -22,20 +22,20 @@

    To find an authorization ID, you can use the GET /api/v2/authorizations endpoint to list authorizations.

    -
    createdAt?: string
    cron?: string

    A Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.

    -
    description?: string

    A description of the task.

    -
    every?: string

    The interval (duration literal) at which the task runs. every also determines when the task first runs, depending on the specified time.

    -
    flux: string

    The Flux script that the task executes.

    -
    id: string
    labels?: Labels
    lastRunError?: string
    lastRunStatus?: "failed" | "success" | "canceled"
    latestCompleted?: string

    A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

    -
    links?: {
        labels?: string;
        logs?: string;
        members?: string;
        owners?: string;
        runs?: string;
        self?: string;
    }
    name: string

    The name of the task.

    -
    offset?: string

    A duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.

    -
    org?: string

    An organization name. +

    createdAt?: string
    cron?: string

    A Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.

    +
    description?: string

    A description of the task.

    +
    every?: string

    The interval (duration literal) at which the task runs. every also determines when the task first runs, depending on the specified time.

    +
    flux: string

    The Flux script that the task executes.

    +
    id: string
    labels?: Labels
    lastRunError?: string
    lastRunStatus?: "failed" | "success" | "canceled"
    latestCompleted?: string

    A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

    +
    links?: {
        labels?: string;
        logs?: string;
        members?: string;
        owners?: string;
        runs?: string;
        self?: string;
    }
    name: string

    The name of the task.

    +
    offset?: string

    A duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.

    +
    org?: string

    An organization name. Specifies the organization that owns the task.

    -
    orgID: string

    An organization ID. +

    orgID: string

    An organization ID. Specifies the organization that owns the task.

    -
    ownerID?: string

    A user ID. +

    ownerID?: string

    A user ID. Specifies the owner of the task.

    To find a user ID, you can use the GET /api/v2/users endpoint to list users.

    -
    updatedAt?: string
    +
    updatedAt?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TaskCreateRequest.html b/interfaces/_influxdata_influxdb-client-apis.TaskCreateRequest.html index 3561ea01..a5cb0ef3 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TaskCreateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.TaskCreateRequest.html @@ -1,10 +1,10 @@ -TaskCreateRequest | Documentation
    interface TaskCreateRequest {
        description?: string;
        flux: string;
        org?: string;
        orgID?: string;
        status?: TaskStatusType;
    }

    Properties

    description? +TaskCreateRequest | Documentation
    interface TaskCreateRequest {
        description?: string;
        flux: string;
        org?: string;
        orgID?: string;
        status?: TaskStatusType;
    }

    Properties

    description?: string

    An optional description of the task.

    -
    flux: string

    The Flux script to run for this task.

    -
    org?: string

    The name of the organization that owns this Task.

    -
    orgID?: string

    The ID of the organization that owns this Task.

    -
    +
    flux: string

    The Flux script to run for this task.

    +
    org?: string

    The name of the organization that owns this Task.

    +
    orgID?: string

    The ID of the organization that owns this Task.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TaskUpdateRequest.html b/interfaces/_influxdata_influxdb-client-apis.TaskUpdateRequest.html index a3759c1a..a86acf52 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TaskUpdateRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.TaskUpdateRequest.html @@ -1,4 +1,4 @@ -TaskUpdateRequest | Documentation
    interface TaskUpdateRequest {
        cron?: string;
        description?: string;
        every?: string;
        flux?: string;
        name?: string;
        offset?: string;
        status?: TaskStatusType;
    }

    Properties

    cron? +TaskUpdateRequest | Documentation
    interface TaskUpdateRequest {
        cron?: string;
        description?: string;
        every?: string;
        flux?: string;
        name?: string;
        offset?: string;
        status?: TaskStatusType;
    }

    Properties

    Properties

    cron?: string

    Update the 'cron' option in the flux script.

    -
    description?: string

    Update the description of the task.

    -
    every?: string

    Update the 'every' option in the flux script.

    -
    flux?: string

    The Flux script that the task runs.

    -
    name?: string

    Update the 'name' option in the flux script.

    -
    offset?: string

    Update the 'offset' option in the flux script.

    -
    +
    description?: string

    Update the description of the task.

    +
    every?: string

    Update the 'every' option in the flux script.

    +
    flux?: string

    The Flux script that the task runs.

    +
    name?: string

    Update the 'name' option in the flux script.

    +
    offset?: string

    Update the 'offset' option in the flux script.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Tasks.html b/interfaces/_influxdata_influxdb-client-apis.Tasks.html index cde4aa71..175442a9 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Tasks.html +++ b/interfaces/_influxdata_influxdb-client-apis.Tasks.html @@ -1,3 +1,3 @@ -Tasks | Documentation
    interface Tasks {
        links?: Links;
        tasks?: Task[];
    }

    Properties

    links? +Tasks | Documentation
    interface Tasks {
        links?: Links;
        tasks?: Task[];
    }

    Properties

    Properties

    links?: Links
    tasks?: Task[]
    +

    Properties

    links?: Links
    tasks?: Task[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugin.html b/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugin.html index d3a11e51..bff09046 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugin.html +++ b/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugin.html @@ -1,5 +1,5 @@ -TelegrafPlugin | Documentation
    interface TelegrafPlugin {
        config?: string;
        description?: string;
        name?: string;
        type?: string;
    }

    Properties

    config? +TelegrafPlugin | Documentation
    interface TelegrafPlugin {
        config?: string;
        description?: string;
        name?: string;
        type?: string;
    }

    Properties

    config?: string
    description?: string
    name?: string
    type?: string
    +

    Properties

    config?: string
    description?: string
    name?: string
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TelegrafPluginRequest.html b/interfaces/_influxdata_influxdb-client-apis.TelegrafPluginRequest.html index edb29209..088420cf 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TelegrafPluginRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.TelegrafPluginRequest.html @@ -1,7 +1,7 @@ -TelegrafPluginRequest | Documentation
    interface TelegrafPluginRequest {
        config?: string;
        description?: string;
        metadata?: { buckets?: string[] };
        name?: string;
        orgID?: string;
        plugins?: {
            alias?: string;
            config?: string;
            description?: string;
            name?: string;
            type?: string;
        }[];
    }

    Properties

    config? +TelegrafPluginRequest | Documentation
    interface TelegrafPluginRequest {
        config?: string;
        description?: string;
        metadata?: { buckets?: string[] };
        name?: string;
        orgID?: string;
        plugins?: {
            alias?: string;
            config?: string;
            description?: string;
            name?: string;
            type?: string;
        }[];
    }

    Properties

    config?: string
    description?: string
    metadata?: { buckets?: string[] }
    name?: string
    orgID?: string
    plugins?: {
        alias?: string;
        config?: string;
        description?: string;
        name?: string;
        type?: string;
    }[]
    +

    Properties

    config?: string
    description?: string
    metadata?: { buckets?: string[] }
    name?: string
    orgID?: string
    plugins?: {
        alias?: string;
        config?: string;
        description?: string;
        name?: string;
        type?: string;
    }[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugins.html b/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugins.html index 80526ff2..0619c99f 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugins.html +++ b/interfaces/_influxdata_influxdb-client-apis.TelegrafPlugins.html @@ -1,4 +1,4 @@ -TelegrafPlugins | Documentation
    interface TelegrafPlugins {
        os?: string;
        plugins?: TelegrafPlugin[];
        version?: string;
    }

    Properties

    os? +TelegrafPlugins | Documentation
    interface TelegrafPlugins {
        os?: string;
        plugins?: TelegrafPlugin[];
        version?: string;
    }

    Properties

    Properties

    os?: string
    plugins?: TelegrafPlugin[]
    version?: string
    +

    Properties

    os?: string
    plugins?: TelegrafPlugin[]
    version?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TelegrafRequest.html b/interfaces/_influxdata_influxdb-client-apis.TelegrafRequest.html index 0aa6939c..313f767d 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TelegrafRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.TelegrafRequest.html @@ -1,6 +1,6 @@ -TelegrafRequest | Documentation
    interface TelegrafRequest {
        config?: string;
        description?: string;
        metadata?: { buckets?: string[] };
        name?: string;
        orgID?: string;
    }

    Properties

    config? +TelegrafRequest | Documentation
    interface TelegrafRequest {
        config?: string;
        description?: string;
        metadata?: { buckets?: string[] };
        name?: string;
        orgID?: string;
    }

    Properties

    config?: string
    description?: string
    metadata?: { buckets?: string[] }
    name?: string
    orgID?: string
    +

    Properties

    config?: string
    description?: string
    metadata?: { buckets?: string[] }
    name?: string
    orgID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Telegrafs.html b/interfaces/_influxdata_influxdb-client-apis.Telegrafs.html index 6c746cad..417c0bc0 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Telegrafs.html +++ b/interfaces/_influxdata_influxdb-client-apis.Telegrafs.html @@ -1,2 +1,2 @@ -Telegrafs | Documentation
    interface Telegrafs {
        configurations?: Telegraf[];
    }

    Properties

    Properties

    configurations?: Telegraf[]
    +Telegrafs | Documentation
    interface Telegrafs {
        configurations?: Telegraf[];
    }

    Properties

    Properties

    configurations?: Telegraf[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TelegramNotificationRuleBase.html b/interfaces/_influxdata_influxdb-client-apis.TelegramNotificationRuleBase.html index 06edb502..4ca299f6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TelegramNotificationRuleBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.TelegramNotificationRuleBase.html @@ -1,9 +1,9 @@ -TelegramNotificationRuleBase | Documentation
    interface TelegramNotificationRuleBase {
        disableWebPagePreview?: boolean;
        messageTemplate: string;
        parseMode?: "MarkdownV2" | "HTML" | "Markdown";
        type: "telegram";
    }

    Properties

    disableWebPagePreview? +TelegramNotificationRuleBase | Documentation
    interface TelegramNotificationRuleBase {
        disableWebPagePreview?: boolean;
        messageTemplate: string;
        parseMode?: "MarkdownV2" | "HTML" | "Markdown";
        type: "telegram";
    }

    Properties

    disableWebPagePreview?: boolean

    Disables preview of web links in the sent messages when "true". Defaults to "false".

    -
    messageTemplate: string

    The message template as a flux interpolated string.

    -
    parseMode?: "MarkdownV2" | "HTML" | "Markdown"

    Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2".

    -
    type: "telegram"

    The discriminator between other types of notification rules is "telegram".

    -
    +
    messageTemplate: string

    The message template as a flux interpolated string.

    +
    parseMode?: "MarkdownV2" | "HTML" | "Markdown"

    Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2".

    +
    type: "telegram"

    The discriminator between other types of notification rules is "telegram".

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TemplateApply.html b/interfaces/_influxdata_influxdb-client-apis.TemplateApply.html index 6377fecf..cc7fd296 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TemplateApply.html +++ b/interfaces/_influxdata_influxdb-client-apis.TemplateApply.html @@ -1,4 +1,4 @@ -TemplateApply | Documentation
    interface TemplateApply {
        actions?: (
            | { action?: "skipKind"; properties?: { kind: TemplateKind } }
            | {
                action?: "skipResource";
                properties?: { kind: TemplateKind; resourceTemplateName: string };
            }
        )[];
        dryRun?: boolean;
        envRefs?: any;
        orgID?: string;
        remotes?: { contentType?: string; url: string }[];
        secrets?: any;
        stackID?: string;
        template?: {
            contents?: Template;
            contentType?: string;
            sources?: string[];
        };
        templates?: {
            contents?: Template;
            contentType?: string;
            sources?: string[];
        }[];
    }

    Properties

    actions? +TemplateApply | Documentation
    interface TemplateApply {
        actions?: (
            | { action?: "skipKind"; properties?: { kind: TemplateKind } }
            | {
                action?: "skipResource";
                properties?: { kind: TemplateKind; resourceTemplateName: string };
            }
        )[];
        dryRun?: boolean;
        envRefs?: any;
        orgID?: string;
        remotes?: { contentType?: string; url: string }[];
        secrets?: any;
        stackID?: string;
        template?: {
            contents?: Template;
            contentType?: string;
            sources?: string[];
        };
        templates?: {
            contents?: Template;
            contentType?: string;
            sources?: string[];
        }[];
    }

    Properties

    actions? dryRun? envRefs? orgID? @@ -15,12 +15,12 @@
  • A skipResource action skips template resources with a specified metadata.name and kind.
  • -
    dryRun?: boolean

    Only applies a dry run of the templates passed in the request.

    +
    dryRun?: boolean

    Only applies a dry run of the templates passed in the request.

    • Validates the template and generates a resource diff and summary.
    • Doesn't install templates or make changes to the InfluxDB instance.
    -
    envRefs?: any

    An object with key-value pairs that map to environment references in templates.

    +
    envRefs?: any

    An object with key-value pairs that map to environment references in templates.

    Environment references in templates are envRef objects with an envRef.key property. To substitute a custom environment reference value when applying templates, @@ -36,15 +36,15 @@

    For more information about including environment references in template fields, see how to include user-definable resource names.

    -
    orgID?: string

    Organization ID. +

    orgID?: string

    Organization ID. InfluxDB applies templates to this organization. The organization owns all resources created by the template.

    To find your organization, see how to view organizations.

    -
    remotes?: { contentType?: string; url: string }[]

    A list of URLs for template files.

    +
    remotes?: { contentType?: string; url: string }[]

    A list of URLs for template files.

    To apply a template manifest file located at a URL, pass remotes with an array that contains the URL.

    -
    secrets?: any

    An object with key-value pairs that map to secrets in queries.

    +
    secrets?: any

    An object with key-value pairs that map to secrets in queries.

    Queries may reference secrets stored in InfluxDB--for example, the following Flux script retrieves POSTGRES_USERNAME and POSTGRES_PASSWORD secrets and then uses them to connect to a PostgreSQL database:

    @@ -61,7 +61,7 @@ -
    stackID?: string

    ID of the stack to update.

    +
    stackID?: string

    ID of the stack to update.

    To apply templates to an existing stack in the organization, use the stackID parameter. If you apply templates without providing a stack ID, InfluxDB initializes a new stack with all new resources.

    @@ -70,15 +70,15 @@
  • Stacks
  • View stacks
  • -
    template?: { contents?: Template; contentType?: string; sources?: string[] }

    A template object to apply. +

    template?: { contents?: Template; contentType?: string; sources?: string[] }

    A template object to apply. A template object has a contents property with an array of InfluxDB resource configurations.

    Pass template to apply only one template object. If you use template, you can't use the templates parameter. If you want to apply multiple template objects, use templates instead.

    -
    templates?: { contents?: Template; contentType?: string; sources?: string[] }[]

    A list of template objects to apply. +

    templates?: { contents?: Template; contentType?: string; sources?: string[] }[]

    A list of template objects to apply. A template object has a contents property with an array of InfluxDB resource configurations.

    Use the templates parameter to apply multiple template objects. If you use templates, you can't use the template parameter.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TemplateChart.html b/interfaces/_influxdata_influxdb-client-apis.TemplateChart.html index ca29bed1..a85d6595 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TemplateChart.html +++ b/interfaces/_influxdata_influxdb-client-apis.TemplateChart.html @@ -1,6 +1,6 @@ -TemplateChart | Documentation
    interface TemplateChart {
        height?: number;
        properties?: ViewProperties;
        width?: number;
        xPos?: number;
        yPos?: number;
    }

    Properties

    height? +TemplateChart | Documentation
    interface TemplateChart {
        height?: number;
        properties?: ViewProperties;
        width?: number;
        xPos?: number;
        yPos?: number;
    }

    Properties

    height?: number
    properties?: ViewProperties
    width?: number
    xPos?: number
    yPos?: number
    +

    Properties

    height?: number
    properties?: ViewProperties
    width?: number
    xPos?: number
    yPos?: number
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TemplateExportByID.html b/interfaces/_influxdata_influxdb-client-apis.TemplateExportByID.html index 390828cc..1fda7849 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TemplateExportByID.html +++ b/interfaces/_influxdata_influxdb-client-apis.TemplateExportByID.html @@ -1,5 +1,5 @@ -TemplateExportByID | Documentation
    interface TemplateExportByID {
        orgIDs?: {
            orgID?: string;
            resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
        }[];
        resources?: { id: string; kind: TemplateKind; name?: string }[];
        stackID?: string;
    }

    Properties

    orgIDs? +TemplateExportByID | Documentation
    interface TemplateExportByID {
        orgIDs?: {
            orgID?: string;
            resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
        }[];
        resources?: { id: string; kind: TemplateKind; name?: string }[];
        stackID?: string;
    }

    Properties

    orgIDs?: {
        orgID?: string;
        resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
    }[]
    resources?: { id: string; kind: TemplateKind; name?: string }[]

    Type declaration

    • id: string
    • kind: TemplateKind
    • Optionalname?: string

      if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported

      -
    stackID?: string
    +

    Properties

    orgIDs?: {
        orgID?: string;
        resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
    }[]
    resources?: { id: string; kind: TemplateKind; name?: string }[]

    Type declaration

    • id: string
    • kind: TemplateKind
    • Optionalname?: string

      if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported

      +
    stackID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TemplateExportByName.html b/interfaces/_influxdata_influxdb-client-apis.TemplateExportByName.html index 181a1a6a..4954180c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TemplateExportByName.html +++ b/interfaces/_influxdata_influxdb-client-apis.TemplateExportByName.html @@ -1,4 +1,4 @@ -TemplateExportByName | Documentation
    interface TemplateExportByName {
        orgIDs?: {
            orgID?: string;
            resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
        }[];
        resources?: { kind: TemplateKind; name: string }[];
        stackID?: string;
    }

    Properties

    orgIDs? +TemplateExportByName | Documentation
    interface TemplateExportByName {
        orgIDs?: {
            orgID?: string;
            resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
        }[];
        resources?: { kind: TemplateKind; name: string }[];
        stackID?: string;
    }

    Properties

    orgIDs?: {
        orgID?: string;
        resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
    }[]
    resources?: { kind: TemplateKind; name: string }[]
    stackID?: string
    +

    Properties

    orgIDs?: {
        orgID?: string;
        resourceFilters?: { byLabel?: string[]; byResourceKind?: TemplateKind[] };
    }[]
    resources?: { kind: TemplateKind; name: string }[]
    stackID?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TemplateSummary.html b/interfaces/_influxdata_influxdb-client-apis.TemplateSummary.html index f860b14d..5152609b 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TemplateSummary.html +++ b/interfaces/_influxdata_influxdb-client-apis.TemplateSummary.html @@ -1,6 +1,6 @@ -TemplateSummary | Documentation
    interface TemplateSummary {
        diff?: {
            buckets?: {
                id?: string;
                kind?: TemplateKind;
                new?: {
                    description?: string;
                    name?: string;
                    retentionRules?: RetentionRules;
                };
                old?: {
                    description?: string;
                    name?: string;
                    retentionRules?: RetentionRules;
                };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            checks?: {
                id?: string;
                kind?: TemplateKind;
                new?: CheckDiscriminator;
                old?: CheckDiscriminator;
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            dashboards?: {
                id?: string;
                kind?: TemplateKind;
                new?: { charts?: TemplateChart[]; description?: string; name?: string };
                old?: { charts?: TemplateChart[]; description?: string; name?: string };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            labelMappings?: {
                labelID?: string;
                labelName?: string;
                labelTemplateMetaName?: string;
                resourceID?: string;
                resourceName?: string;
                resourceTemplateMetaName?: string;
                resourceType?: string;
                status?: string;
            }[];
            labels?: {
                id?: string;
                kind?: TemplateKind;
                new?: { color?: string; description?: string; name?: string };
                old?: { color?: string; description?: string; name?: string };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            notificationEndpoints?: {
                id?: string;
                kind?: TemplateKind;
                new?: NotificationEndpointDiscriminator;
                old?: NotificationEndpointDiscriminator;
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            notificationRules?: {
                id?: string;
                kind?: TemplateKind;
                new?: {
                    description?: string;
                    endpointID?: string;
                    endpointName?: string;
                    endpointType?: string;
                    every?: string;
                    messageTemplate?: string;
                    name?: string;
                    offset?: string;
                    status?: string;
                    statusRules?: {
                        currentLevel?: (...)
                        | (...);
                        previousLevel?: (...) | (...);
                    }[];
                    tagRules?: {
                        key?: (...)
                        | (...);
                        operator?: (...) | (...);
                        value?: (...) | (...);
                    }[];
                };
                old?: {
                    description?: string;
                    endpointID?: string;
                    endpointName?: string;
                    endpointType?: string;
                    every?: string;
                    messageTemplate?: string;
                    name?: string;
                    offset?: string;
                    status?: string;
                    statusRules?: {
                        currentLevel?: (...)
                        | (...);
                        previousLevel?: (...) | (...);
                    }[];
                    tagRules?: {
                        key?: (...)
                        | (...);
                        operator?: (...) | (...);
                        value?: (...) | (...);
                    }[];
                };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            tasks?: {
                id?: string;
                kind?: TemplateKind;
                new?: {
                    cron?: string;
                    description?: string;
                    every?: string;
                    name?: string;
                    offset?: string;
                    query?: string;
                    status?: string;
                };
                old?: {
                    cron?: string;
                    description?: string;
                    every?: string;
                    name?: string;
                    offset?: string;
                    query?: string;
                    status?: string;
                };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            telegrafConfigs?: {
                id?: string;
                kind?: TemplateKind;
                new?: TelegrafRequest;
                old?: TelegrafRequest;
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            variables?: {
                id?: string;
                kind?: TemplateKind;
                new?: { args?: VariableProperties; description?: string; name?: string };
                old?: { args?: VariableProperties; description?: string; name?: string };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
        };
        errors?: {
            fields?: string[];
            indexes?: number[];
            kind?: TemplateKind;
            reason?: string;
        }[];
        sources?: string[];
        stackID?: string;
        summary?: {
            buckets?: {
                description?: string;
                envReferences?: TemplateEnvReferences;
                id?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                name?: string;
                orgID?: string;
                retentionPeriod?: number;
                templateMetaName?: string;
            }[];
            checks?: (
                CheckDiscriminator & {
                    envReferences?: TemplateEnvReferences;
                    kind?: TemplateKind | undefined;
                    labelAssociations?: TemplateSummaryLabel[];
                    templateMetaName?: string;
                }
            )[];
            dashboards?: {
                charts?: TemplateChart[];
                description?: string;
                envReferences?: TemplateEnvReferences;
                id?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                name?: string;
                orgID?: string;
                templateMetaName?: string;
            }[];
            labelMappings?: {
                labelID?: string;
                labelName?: string;
                labelTemplateMetaName?: string;
                resourceID?: string;
                resourceName?: string;
                resourceTemplateMetaName?: string;
                resourceType?: string;
                status?: string;
            }[];
            labels?: TemplateSummaryLabel[];
            missingEnvRefs?: string[];
            missingSecrets?: string[];
            notificationEndpoints?: (
                NotificationEndpointDiscriminator & {
                    envReferences?: TemplateEnvReferences;
                    kind?: TemplateKind | undefined;
                    labelAssociations?: TemplateSummaryLabel[];
                    templateMetaName?: string;
                }
            )[];
            notificationRules?: {
                description?: string;
                endpointID?: string;
                endpointTemplateMetaName?: string;
                endpointType?: string;
                envReferences?: TemplateEnvReferences;
                every?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                messageTemplate?: string;
                name?: string;
                offset?: string;
                status?: string;
                statusRules?: { currentLevel?: string; previousLevel?: string }[];
                tagRules?: { key?: string; operator?: string; value?: string }[];
                templateMetaName?: string;
            }[];
            tasks?: {
                cron?: string;
                description?: string;
                envReferences?: TemplateEnvReferences;
                every?: string;
                id?: string;
                kind?: TemplateKind;
                name?: string;
                offset?: string;
                query?: string;
                status?: string;
                templateMetaName?: string;
            }[];
            telegrafConfigs?: (
                TelegrafRequest & {
                    envReferences?: TemplateEnvReferences;
                    kind?: TemplateKind;
                    labelAssociations?: TemplateSummaryLabel[];
                    templateMetaName?: string;
                }
            )[];
            variables?: {
                arguments?: VariableProperties;
                description?: string;
                envReferences?: TemplateEnvReferences;
                id?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                name?: string;
                orgID?: string;
                templateMetaName?: string;
            }[];
        };
    }

    Properties

    diff? +TemplateSummary | Documentation
    interface TemplateSummary {
        diff?: {
            buckets?: {
                id?: string;
                kind?: TemplateKind;
                new?: {
                    description?: string;
                    name?: string;
                    retentionRules?: RetentionRules;
                };
                old?: {
                    description?: string;
                    name?: string;
                    retentionRules?: RetentionRules;
                };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            checks?: {
                id?: string;
                kind?: TemplateKind;
                new?: CheckDiscriminator;
                old?: CheckDiscriminator;
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            dashboards?: {
                id?: string;
                kind?: TemplateKind;
                new?: { charts?: TemplateChart[]; description?: string; name?: string };
                old?: { charts?: TemplateChart[]; description?: string; name?: string };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            labelMappings?: {
                labelID?: string;
                labelName?: string;
                labelTemplateMetaName?: string;
                resourceID?: string;
                resourceName?: string;
                resourceTemplateMetaName?: string;
                resourceType?: string;
                status?: string;
            }[];
            labels?: {
                id?: string;
                kind?: TemplateKind;
                new?: { color?: string; description?: string; name?: string };
                old?: { color?: string; description?: string; name?: string };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            notificationEndpoints?: {
                id?: string;
                kind?: TemplateKind;
                new?: NotificationEndpointDiscriminator;
                old?: NotificationEndpointDiscriminator;
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            notificationRules?: {
                id?: string;
                kind?: TemplateKind;
                new?: {
                    description?: string;
                    endpointID?: string;
                    endpointName?: string;
                    endpointType?: string;
                    every?: string;
                    messageTemplate?: string;
                    name?: string;
                    offset?: string;
                    status?: string;
                    statusRules?: {
                        currentLevel?: (...)
                        | (...);
                        previousLevel?: (...) | (...);
                    }[];
                    tagRules?: {
                        key?: (...)
                        | (...);
                        operator?: (...) | (...);
                        value?: (...) | (...);
                    }[];
                };
                old?: {
                    description?: string;
                    endpointID?: string;
                    endpointName?: string;
                    endpointType?: string;
                    every?: string;
                    messageTemplate?: string;
                    name?: string;
                    offset?: string;
                    status?: string;
                    statusRules?: {
                        currentLevel?: (...)
                        | (...);
                        previousLevel?: (...) | (...);
                    }[];
                    tagRules?: {
                        key?: (...)
                        | (...);
                        operator?: (...) | (...);
                        value?: (...) | (...);
                    }[];
                };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            tasks?: {
                id?: string;
                kind?: TemplateKind;
                new?: {
                    cron?: string;
                    description?: string;
                    every?: string;
                    name?: string;
                    offset?: string;
                    query?: string;
                    status?: string;
                };
                old?: {
                    cron?: string;
                    description?: string;
                    every?: string;
                    name?: string;
                    offset?: string;
                    query?: string;
                    status?: string;
                };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            telegrafConfigs?: {
                id?: string;
                kind?: TemplateKind;
                new?: TelegrafRequest;
                old?: TelegrafRequest;
                stateStatus?: string;
                templateMetaName?: string;
            }[];
            variables?: {
                id?: string;
                kind?: TemplateKind;
                new?: { args?: VariableProperties; description?: string; name?: string };
                old?: { args?: VariableProperties; description?: string; name?: string };
                stateStatus?: string;
                templateMetaName?: string;
            }[];
        };
        errors?: {
            fields?: string[];
            indexes?: number[];
            kind?: TemplateKind;
            reason?: string;
        }[];
        sources?: string[];
        stackID?: string;
        summary?: {
            buckets?: {
                description?: string;
                envReferences?: TemplateEnvReferences;
                id?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                name?: string;
                orgID?: string;
                retentionPeriod?: number;
                templateMetaName?: string;
            }[];
            checks?: (
                CheckDiscriminator & {
                    envReferences?: TemplateEnvReferences;
                    kind?: TemplateKind | undefined;
                    labelAssociations?: TemplateSummaryLabel[];
                    templateMetaName?: string;
                }
            )[];
            dashboards?: {
                charts?: TemplateChart[];
                description?: string;
                envReferences?: TemplateEnvReferences;
                id?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                name?: string;
                orgID?: string;
                templateMetaName?: string;
            }[];
            labelMappings?: {
                labelID?: string;
                labelName?: string;
                labelTemplateMetaName?: string;
                resourceID?: string;
                resourceName?: string;
                resourceTemplateMetaName?: string;
                resourceType?: string;
                status?: string;
            }[];
            labels?: TemplateSummaryLabel[];
            missingEnvRefs?: string[];
            missingSecrets?: string[];
            notificationEndpoints?: (
                NotificationEndpointDiscriminator & {
                    envReferences?: TemplateEnvReferences;
                    kind?: TemplateKind | undefined;
                    labelAssociations?: TemplateSummaryLabel[];
                    templateMetaName?: string;
                }
            )[];
            notificationRules?: {
                description?: string;
                endpointID?: string;
                endpointTemplateMetaName?: string;
                endpointType?: string;
                envReferences?: TemplateEnvReferences;
                every?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                messageTemplate?: string;
                name?: string;
                offset?: string;
                status?: string;
                statusRules?: { currentLevel?: string; previousLevel?: string }[];
                tagRules?: { key?: string; operator?: string; value?: string }[];
                templateMetaName?: string;
            }[];
            tasks?: {
                cron?: string;
                description?: string;
                envReferences?: TemplateEnvReferences;
                every?: string;
                id?: string;
                kind?: TemplateKind;
                name?: string;
                offset?: string;
                query?: string;
                status?: string;
                templateMetaName?: string;
            }[];
            telegrafConfigs?: (
                TelegrafRequest & {
                    envReferences?: TemplateEnvReferences;
                    kind?: TemplateKind;
                    labelAssociations?: TemplateSummaryLabel[];
                    templateMetaName?: string;
                }
            )[];
            variables?: {
                arguments?: VariableProperties;
                description?: string;
                envReferences?: TemplateEnvReferences;
                id?: string;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                name?: string;
                orgID?: string;
                templateMetaName?: string;
            }[];
        };
    }

    Properties

    diff?: {
        buckets?: {
            id?: string;
            kind?: TemplateKind;
            new?: {
                description?: string;
                name?: string;
                retentionRules?: RetentionRules;
            };
            old?: {
                description?: string;
                name?: string;
                retentionRules?: RetentionRules;
            };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        checks?: {
            id?: string;
            kind?: TemplateKind;
            new?: CheckDiscriminator;
            old?: CheckDiscriminator;
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        dashboards?: {
            id?: string;
            kind?: TemplateKind;
            new?: { charts?: TemplateChart[]; description?: string; name?: string };
            old?: { charts?: TemplateChart[]; description?: string; name?: string };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        labelMappings?: {
            labelID?: string;
            labelName?: string;
            labelTemplateMetaName?: string;
            resourceID?: string;
            resourceName?: string;
            resourceTemplateMetaName?: string;
            resourceType?: string;
            status?: string;
        }[];
        labels?: {
            id?: string;
            kind?: TemplateKind;
            new?: { color?: string; description?: string; name?: string };
            old?: { color?: string; description?: string; name?: string };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        notificationEndpoints?: {
            id?: string;
            kind?: TemplateKind;
            new?: NotificationEndpointDiscriminator;
            old?: NotificationEndpointDiscriminator;
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        notificationRules?: {
            id?: string;
            kind?: TemplateKind;
            new?: {
                description?: string;
                endpointID?: string;
                endpointName?: string;
                endpointType?: string;
                every?: string;
                messageTemplate?: string;
                name?: string;
                offset?: string;
                status?: string;
                statusRules?: {
                    currentLevel?: (...)
                    | (...);
                    previousLevel?: (...) | (...);
                }[];
                tagRules?: {
                    key?: (...)
                    | (...);
                    operator?: (...) | (...);
                    value?: (...) | (...);
                }[];
            };
            old?: {
                description?: string;
                endpointID?: string;
                endpointName?: string;
                endpointType?: string;
                every?: string;
                messageTemplate?: string;
                name?: string;
                offset?: string;
                status?: string;
                statusRules?: {
                    currentLevel?: (...)
                    | (...);
                    previousLevel?: (...) | (...);
                }[];
                tagRules?: {
                    key?: (...)
                    | (...);
                    operator?: (...) | (...);
                    value?: (...) | (...);
                }[];
            };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        tasks?: {
            id?: string;
            kind?: TemplateKind;
            new?: {
                cron?: string;
                description?: string;
                every?: string;
                name?: string;
                offset?: string;
                query?: string;
                status?: string;
            };
            old?: {
                cron?: string;
                description?: string;
                every?: string;
                name?: string;
                offset?: string;
                query?: string;
                status?: string;
            };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        telegrafConfigs?: {
            id?: string;
            kind?: TemplateKind;
            new?: TelegrafRequest;
            old?: TelegrafRequest;
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        variables?: {
            id?: string;
            kind?: TemplateKind;
            new?: { args?: VariableProperties; description?: string; name?: string };
            old?: { args?: VariableProperties; description?: string; name?: string };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
    }
    errors?: {
        fields?: string[];
        indexes?: number[];
        kind?: TemplateKind;
        reason?: string;
    }[]
    sources?: string[]
    stackID?: string
    summary?: {
        buckets?: {
            description?: string;
            envReferences?: TemplateEnvReferences;
            id?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            name?: string;
            orgID?: string;
            retentionPeriod?: number;
            templateMetaName?: string;
        }[];
        checks?: (
            CheckDiscriminator & {
                envReferences?: TemplateEnvReferences;
                kind?: TemplateKind | undefined;
                labelAssociations?: TemplateSummaryLabel[];
                templateMetaName?: string;
            }
        )[];
        dashboards?: {
            charts?: TemplateChart[];
            description?: string;
            envReferences?: TemplateEnvReferences;
            id?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            name?: string;
            orgID?: string;
            templateMetaName?: string;
        }[];
        labelMappings?: {
            labelID?: string;
            labelName?: string;
            labelTemplateMetaName?: string;
            resourceID?: string;
            resourceName?: string;
            resourceTemplateMetaName?: string;
            resourceType?: string;
            status?: string;
        }[];
        labels?: TemplateSummaryLabel[];
        missingEnvRefs?: string[];
        missingSecrets?: string[];
        notificationEndpoints?: (
            NotificationEndpointDiscriminator & {
                envReferences?: TemplateEnvReferences;
                kind?: TemplateKind | undefined;
                labelAssociations?: TemplateSummaryLabel[];
                templateMetaName?: string;
            }
        )[];
        notificationRules?: {
            description?: string;
            endpointID?: string;
            endpointTemplateMetaName?: string;
            endpointType?: string;
            envReferences?: TemplateEnvReferences;
            every?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            messageTemplate?: string;
            name?: string;
            offset?: string;
            status?: string;
            statusRules?: { currentLevel?: string; previousLevel?: string }[];
            tagRules?: { key?: string; operator?: string; value?: string }[];
            templateMetaName?: string;
        }[];
        tasks?: {
            cron?: string;
            description?: string;
            envReferences?: TemplateEnvReferences;
            every?: string;
            id?: string;
            kind?: TemplateKind;
            name?: string;
            offset?: string;
            query?: string;
            status?: string;
            templateMetaName?: string;
        }[];
        telegrafConfigs?: (
            TelegrafRequest & {
                envReferences?: TemplateEnvReferences;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                templateMetaName?: string;
            }
        )[];
        variables?: {
            arguments?: VariableProperties;
            description?: string;
            envReferences?: TemplateEnvReferences;
            id?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            name?: string;
            orgID?: string;
            templateMetaName?: string;
        }[];
    }
    +

    Properties

    diff?: {
        buckets?: {
            id?: string;
            kind?: TemplateKind;
            new?: {
                description?: string;
                name?: string;
                retentionRules?: RetentionRules;
            };
            old?: {
                description?: string;
                name?: string;
                retentionRules?: RetentionRules;
            };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        checks?: {
            id?: string;
            kind?: TemplateKind;
            new?: CheckDiscriminator;
            old?: CheckDiscriminator;
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        dashboards?: {
            id?: string;
            kind?: TemplateKind;
            new?: { charts?: TemplateChart[]; description?: string; name?: string };
            old?: { charts?: TemplateChart[]; description?: string; name?: string };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        labelMappings?: {
            labelID?: string;
            labelName?: string;
            labelTemplateMetaName?: string;
            resourceID?: string;
            resourceName?: string;
            resourceTemplateMetaName?: string;
            resourceType?: string;
            status?: string;
        }[];
        labels?: {
            id?: string;
            kind?: TemplateKind;
            new?: { color?: string; description?: string; name?: string };
            old?: { color?: string; description?: string; name?: string };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        notificationEndpoints?: {
            id?: string;
            kind?: TemplateKind;
            new?: NotificationEndpointDiscriminator;
            old?: NotificationEndpointDiscriminator;
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        notificationRules?: {
            id?: string;
            kind?: TemplateKind;
            new?: {
                description?: string;
                endpointID?: string;
                endpointName?: string;
                endpointType?: string;
                every?: string;
                messageTemplate?: string;
                name?: string;
                offset?: string;
                status?: string;
                statusRules?: {
                    currentLevel?: (...)
                    | (...);
                    previousLevel?: (...) | (...);
                }[];
                tagRules?: {
                    key?: (...)
                    | (...);
                    operator?: (...) | (...);
                    value?: (...) | (...);
                }[];
            };
            old?: {
                description?: string;
                endpointID?: string;
                endpointName?: string;
                endpointType?: string;
                every?: string;
                messageTemplate?: string;
                name?: string;
                offset?: string;
                status?: string;
                statusRules?: {
                    currentLevel?: (...)
                    | (...);
                    previousLevel?: (...) | (...);
                }[];
                tagRules?: {
                    key?: (...)
                    | (...);
                    operator?: (...) | (...);
                    value?: (...) | (...);
                }[];
            };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        tasks?: {
            id?: string;
            kind?: TemplateKind;
            new?: {
                cron?: string;
                description?: string;
                every?: string;
                name?: string;
                offset?: string;
                query?: string;
                status?: string;
            };
            old?: {
                cron?: string;
                description?: string;
                every?: string;
                name?: string;
                offset?: string;
                query?: string;
                status?: string;
            };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        telegrafConfigs?: {
            id?: string;
            kind?: TemplateKind;
            new?: TelegrafRequest;
            old?: TelegrafRequest;
            stateStatus?: string;
            templateMetaName?: string;
        }[];
        variables?: {
            id?: string;
            kind?: TemplateKind;
            new?: { args?: VariableProperties; description?: string; name?: string };
            old?: { args?: VariableProperties; description?: string; name?: string };
            stateStatus?: string;
            templateMetaName?: string;
        }[];
    }
    errors?: {
        fields?: string[];
        indexes?: number[];
        kind?: TemplateKind;
        reason?: string;
    }[]
    sources?: string[]
    stackID?: string
    summary?: {
        buckets?: {
            description?: string;
            envReferences?: TemplateEnvReferences;
            id?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            name?: string;
            orgID?: string;
            retentionPeriod?: number;
            templateMetaName?: string;
        }[];
        checks?: (
            CheckDiscriminator & {
                envReferences?: TemplateEnvReferences;
                kind?: TemplateKind | undefined;
                labelAssociations?: TemplateSummaryLabel[];
                templateMetaName?: string;
            }
        )[];
        dashboards?: {
            charts?: TemplateChart[];
            description?: string;
            envReferences?: TemplateEnvReferences;
            id?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            name?: string;
            orgID?: string;
            templateMetaName?: string;
        }[];
        labelMappings?: {
            labelID?: string;
            labelName?: string;
            labelTemplateMetaName?: string;
            resourceID?: string;
            resourceName?: string;
            resourceTemplateMetaName?: string;
            resourceType?: string;
            status?: string;
        }[];
        labels?: TemplateSummaryLabel[];
        missingEnvRefs?: string[];
        missingSecrets?: string[];
        notificationEndpoints?: (
            NotificationEndpointDiscriminator & {
                envReferences?: TemplateEnvReferences;
                kind?: TemplateKind | undefined;
                labelAssociations?: TemplateSummaryLabel[];
                templateMetaName?: string;
            }
        )[];
        notificationRules?: {
            description?: string;
            endpointID?: string;
            endpointTemplateMetaName?: string;
            endpointType?: string;
            envReferences?: TemplateEnvReferences;
            every?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            messageTemplate?: string;
            name?: string;
            offset?: string;
            status?: string;
            statusRules?: { currentLevel?: string; previousLevel?: string }[];
            tagRules?: { key?: string; operator?: string; value?: string }[];
            templateMetaName?: string;
        }[];
        tasks?: {
            cron?: string;
            description?: string;
            envReferences?: TemplateEnvReferences;
            every?: string;
            id?: string;
            kind?: TemplateKind;
            name?: string;
            offset?: string;
            query?: string;
            status?: string;
            templateMetaName?: string;
        }[];
        telegrafConfigs?: (
            TelegrafRequest & {
                envReferences?: TemplateEnvReferences;
                kind?: TemplateKind;
                labelAssociations?: TemplateSummaryLabel[];
                templateMetaName?: string;
            }
        )[];
        variables?: {
            arguments?: VariableProperties;
            description?: string;
            envReferences?: TemplateEnvReferences;
            id?: string;
            kind?: TemplateKind;
            labelAssociations?: TemplateSummaryLabel[];
            name?: string;
            orgID?: string;
            templateMetaName?: string;
        }[];
    }
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TemplateSummaryLabel.html b/interfaces/_influxdata_influxdb-client-apis.TemplateSummaryLabel.html index 3ff43caf..63fd4280 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TemplateSummaryLabel.html +++ b/interfaces/_influxdata_influxdb-client-apis.TemplateSummaryLabel.html @@ -1,8 +1,8 @@ -TemplateSummaryLabel | Documentation
    interface TemplateSummaryLabel {
        envReferences?: TemplateEnvReferences;
        id?: string;
        kind?: TemplateKind;
        name?: string;
        orgID?: string;
        properties?: { color?: string; description?: string };
        templateMetaName?: string;
    }

    Properties

    envReferences? +TemplateSummaryLabel | Documentation
    interface TemplateSummaryLabel {
        envReferences?: TemplateEnvReferences;
        id?: string;
        kind?: TemplateKind;
        name?: string;
        orgID?: string;
        properties?: { color?: string; description?: string };
        templateMetaName?: string;
    }

    Properties

    envReferences?: TemplateEnvReferences
    id?: string
    name?: string
    orgID?: string
    properties?: { color?: string; description?: string }
    templateMetaName?: string
    +

    Properties

    envReferences?: TemplateEnvReferences
    id?: string
    name?: string
    orgID?: string
    properties?: { color?: string; description?: string }
    templateMetaName?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.TestStatement.html b/interfaces/_influxdata_influxdb-client-apis.TestStatement.html index 74e6149d..aa6ba125 100644 --- a/interfaces/_influxdata_influxdb-client-apis.TestStatement.html +++ b/interfaces/_influxdata_influxdb-client-apis.TestStatement.html @@ -1,4 +1,4 @@ TestStatement | Documentation

    Declares a Flux test case

    -
    interface TestStatement {
        assignment?: VariableAssignment;
        type?: string;
    }

    Properties

    interface TestStatement {
        assignment?: VariableAssignment;
        type?: string;
    }

    Properties

    Properties

    assignment?: VariableAssignment
    type?: string
    +

    Properties

    assignment?: VariableAssignment
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.ThresholdBase.html b/interfaces/_influxdata_influxdb-client-apis.ThresholdBase.html index d33e8b38..6b522cc2 100644 --- a/interfaces/_influxdata_influxdb-client-apis.ThresholdBase.html +++ b/interfaces/_influxdata_influxdb-client-apis.ThresholdBase.html @@ -1,4 +1,4 @@ -ThresholdBase | Documentation
    interface ThresholdBase {
        allValues?: boolean;
        level?: CheckStatusLevel;
    }

    Properties

    allValues? +ThresholdBase | Documentation
    interface ThresholdBase {
        allValues?: boolean;
        level?: CheckStatusLevel;
    }

    Properties

    Properties

    allValues?: boolean

    If true, only alert if all values meet threshold.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.UnaryExpression.html b/interfaces/_influxdata_influxdb-client-apis.UnaryExpression.html index aab1ad44..28faa112 100644 --- a/interfaces/_influxdata_influxdb-client-apis.UnaryExpression.html +++ b/interfaces/_influxdata_influxdb-client-apis.UnaryExpression.html @@ -1,5 +1,5 @@ UnaryExpression | Documentation

    Uses operators to act on a single operand in an expression

    -
    interface UnaryExpression {
        argument?: Expression;
        operator?: string;
        type?: string;
    }

    Properties

    interface UnaryExpression {
        argument?: Expression;
        operator?: string;
        type?: string;
    }

    Properties

    argument?: Expression
    operator?: string
    type?: string
    +

    Properties

    argument?: Expression
    operator?: string
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.UninstallStackRequest.html b/interfaces/_influxdata_influxdb-client-apis.UninstallStackRequest.html index 6b87dce1..5cd32623 100644 --- a/interfaces/_influxdata_influxdb-client-apis.UninstallStackRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.UninstallStackRequest.html @@ -1,3 +1,3 @@ -UninstallStackRequest | Documentation
    interface UninstallStackRequest {
        stack_id: string;
    }

    Properties

    stack_id +UninstallStackRequest | Documentation
    interface UninstallStackRequest {
        stack_id: string;
    }

    Properties

    Properties

    stack_id: string

    The identifier of the stack.

    -
    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.UnsignedIntegerLiteral.html b/interfaces/_influxdata_influxdb-client-apis.UnsignedIntegerLiteral.html index ec2081d8..992433f4 100644 --- a/interfaces/_influxdata_influxdb-client-apis.UnsignedIntegerLiteral.html +++ b/interfaces/_influxdata_influxdb-client-apis.UnsignedIntegerLiteral.html @@ -1,4 +1,4 @@ UnsignedIntegerLiteral | Documentation

    Represents integer numbers

    -
    interface UnsignedIntegerLiteral {
        type?: string;
        value?: string;
    }

    Properties

    interface UnsignedIntegerLiteral {
        type?: string;
        value?: string;
    }

    Properties

    Properties

    type?: string
    value?: string
    +

    Properties

    type?: string
    value?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.UpdateStackRequest.html b/interfaces/_influxdata_influxdb-client-apis.UpdateStackRequest.html index 474d23d7..a809a8f6 100644 --- a/interfaces/_influxdata_influxdb-client-apis.UpdateStackRequest.html +++ b/interfaces/_influxdata_influxdb-client-apis.UpdateStackRequest.html @@ -1,5 +1,5 @@ -UpdateStackRequest | Documentation
    interface UpdateStackRequest {
        body: {
            additionalResources?: {
                kind: string;
                resourceID: string;
                templateMetaName?: string;
            }[];
            description?: string;
            name?: string;
            templateURLs?: string[];
        };
        stack_id: string;
    }

    Properties

    body +UpdateStackRequest | Documentation
    interface UpdateStackRequest {
        body: {
            additionalResources?: {
                kind: string;
                resourceID: string;
                templateMetaName?: string;
            }[];
            description?: string;
            name?: string;
            templateURLs?: string[];
        };
        stack_id: string;
    }

    Properties

    Properties

    body: {
        additionalResources?: {
            kind: string;
            resourceID: string;
            templateMetaName?: string;
        }[];
        description?: string;
        name?: string;
        templateURLs?: string[];
    }

    The stack to update.

    -
    stack_id: string

    The identifier of the stack.

    -
    +
    stack_id: string

    The identifier of the stack.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.User.html b/interfaces/_influxdata_influxdb-client-apis.User.html index a93966e9..fa1e76ca 100644 --- a/interfaces/_influxdata_influxdb-client-apis.User.html +++ b/interfaces/_influxdata_influxdb-client-apis.User.html @@ -1,6 +1,6 @@ -User | Documentation
    interface User {
        id?: string;
        name: string;
        oauthID?: string;
        status?: "active" | "inactive";
    }

    Properties

    id? +User | Documentation
    interface User {
        id?: string;
        name: string;
        oauthID?: string;
        status?: "active" | "inactive";
    }

    Properties

    Properties

    id?: string
    name: string
    oauthID?: string
    status?: "active" | "inactive"

    If inactive the user is inactive.

    -
    +

    Properties

    id?: string
    name: string
    oauthID?: string
    status?: "active" | "inactive"

    If inactive the user is inactive.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.UserResponse.html b/interfaces/_influxdata_influxdb-client-apis.UserResponse.html index 5e273ec7..d11548e7 100644 --- a/interfaces/_influxdata_influxdb-client-apis.UserResponse.html +++ b/interfaces/_influxdata_influxdb-client-apis.UserResponse.html @@ -1,8 +1,8 @@ -UserResponse | Documentation
    interface UserResponse {
        id?: string;
        links?: { self?: string };
        name: string;
        status?: "active" | "inactive";
    }

    Properties

    id? +UserResponse | Documentation
    interface UserResponse {
        id?: string;
        links?: { self?: string };
        name: string;
        status?: "active" | "inactive";
    }

    Properties

    Properties

    id?: string

    The ID of the user.

    -
    links?: { self?: string }
    name: string

    The name of the user.

    -
    status?: "active" | "inactive"

    The status of a user. An inactive user won't have access to resources.

    -
    +
    links?: { self?: string }
    name: string

    The name of the user.

    +
    status?: "active" | "inactive"

    The status of a user. An inactive user won't have access to resources.

    +
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Users.html b/interfaces/_influxdata_influxdb-client-apis.Users.html index de02999a..ddeb6e8c 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Users.html +++ b/interfaces/_influxdata_influxdb-client-apis.Users.html @@ -1,3 +1,3 @@ -Users | Documentation
    interface Users {
        links?: { self?: string };
        users?: UserResponse[];
    }

    Properties

    links? +Users | Documentation
    interface Users {
        links?: { self?: string };
        users?: UserResponse[];
    }

    Properties

    Properties

    links?: { self?: string }
    users?: UserResponse[]
    +

    Properties

    links?: { self?: string }
    users?: UserResponse[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Variable.html b/interfaces/_influxdata_influxdb-client-apis.Variable.html index 394c7407..7ed59088 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Variable.html +++ b/interfaces/_influxdata_influxdb-client-apis.Variable.html @@ -1,4 +1,4 @@ -Variable | Documentation
    interface Variable {
        arguments: VariableProperties;
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        links?: { labels?: string; org?: string; self?: string };
        name: string;
        orgID: string;
        selected?: string[];
        updatedAt?: string;
    }

    Properties

    arguments +Variable | Documentation
    interface Variable {
        arguments: VariableProperties;
        createdAt?: string;
        description?: string;
        id?: string;
        labels?: Labels;
        links?: { labels?: string; org?: string; self?: string };
        name: string;
        orgID: string;
        selected?: string[];
        updatedAt?: string;
    }

    Properties

    createdAt?: string
    description?: string
    id?: string
    labels?: Labels
    links?: { labels?: string; org?: string; self?: string }
    name: string
    orgID: string
    selected?: string[]
    updatedAt?: string
    +

    Properties

    createdAt?: string
    description?: string
    id?: string
    labels?: Labels
    links?: { labels?: string; org?: string; self?: string }
    name: string
    orgID: string
    selected?: string[]
    updatedAt?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.VariableAssignment.html b/interfaces/_influxdata_influxdb-client-apis.VariableAssignment.html index 8f564375..5a167c2e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.VariableAssignment.html +++ b/interfaces/_influxdata_influxdb-client-apis.VariableAssignment.html @@ -1,5 +1,5 @@ VariableAssignment | Documentation

    Represents the declaration of a variable

    -
    interface VariableAssignment {
        id?: Identifier;
        init?: Expression;
        type?: string;
    }

    Properties

    id? +
    interface VariableAssignment {
        id?: Identifier;
        init?: Expression;
        type?: string;
    }

    Properties

    Properties

    init?: Expression
    type?: string
    +

    Properties

    init?: Expression
    type?: string
    diff --git a/interfaces/_influxdata_influxdb-client-apis.Variables.html b/interfaces/_influxdata_influxdb-client-apis.Variables.html index 73efbc1e..6886a74e 100644 --- a/interfaces/_influxdata_influxdb-client-apis.Variables.html +++ b/interfaces/_influxdata_influxdb-client-apis.Variables.html @@ -1,2 +1,2 @@ -Variables | Documentation
    interface Variables {
        variables?: Variable[];
    }

    Properties

    Properties

    variables?: Variable[]
    +Variables | Documentation
    interface Variables {
        variables?: Variable[];
    }

    Properties

    Properties

    variables?: Variable[]
    diff --git a/interfaces/_influxdata_influxdb-client-apis.View.html b/interfaces/_influxdata_influxdb-client-apis.View.html index 4d4290af..5b2b71fb 100644 --- a/interfaces/_influxdata_influxdb-client-apis.View.html +++ b/interfaces/_influxdata_influxdb-client-apis.View.html @@ -1,5 +1,5 @@ -View | Documentation
    interface View {
        id?: string;
        links?: { self?: string };
        name: string;
        properties: ViewProperties;
    }

    Properties

    id? +View | Documentation
    interface View {
        id?: string;
        links?: { self?: string };
        name: string;
        properties: ViewProperties;
    }

    Properties

    id?: string
    links?: { self?: string }
    name: string
    properties: ViewProperties
    +

    Properties

    id?: string
    links?: { self?: string }
    name: string
    properties: ViewProperties
    diff --git a/interfaces/_influxdata_influxdb-client-apis.XYViewProperties.html b/interfaces/_influxdata_influxdb-client-apis.XYViewProperties.html index 411615de..9677a1aa 100644 --- a/interfaces/_influxdata_influxdb-client-apis.XYViewProperties.html +++ b/interfaces/_influxdata_influxdb-client-apis.XYViewProperties.html @@ -1,4 +1,4 @@ -XYViewProperties | Documentation
    interface XYViewProperties {
        adaptiveZoomHide?: boolean;
        axes: Axes;
        colorMapping?: any;
        colors: DashboardColor[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        geom: XYGeom;
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        position: "overlaid" | "stacked";
        queries: DashboardQuery[];
        shadeBelow?: boolean;
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        timeFormat?: string;
        type: "xy";
        xColumn?: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yColumn?: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide? +XYViewProperties | Documentation
    interface XYViewProperties {
        adaptiveZoomHide?: boolean;
        axes: Axes;
        colorMapping?: any;
        colors: DashboardColor[];
        generateXAxisTicks?: string[];
        generateYAxisTicks?: string[];
        geom: XYGeom;
        hoverDimension?: "auto" | "x" | "y" | "xy";
        legendColorizeRows?: boolean;
        legendHide?: boolean;
        legendOpacity?: number;
        legendOrientationThreshold?: number;
        note: string;
        position: "overlaid" | "stacked";
        queries: DashboardQuery[];
        shadeBelow?: boolean;
        shape: "chronograf-v2";
        showNoteWhenEmpty: boolean;
        staticLegend?: StaticLegend;
        timeFormat?: string;
        type: "xy";
        xColumn?: string;
        xTickStart?: number;
        xTickStep?: number;
        xTotalTicks?: number;
        yColumn?: string;
        yTickStart?: number;
        yTickStep?: number;
        yTotalTicks?: number;
    }

    Properties

    adaptiveZoomHide?: boolean
    axes: Axes
    colorMapping?: any

    An object that contains information about the color mapping

    -
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    -
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    geom: XYGeom
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    position: "overlaid" | "stacked"
    queries: DashboardQuery[]
    shadeBelow?: boolean
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    -
    staticLegend?: StaticLegend
    timeFormat?: string
    type: "xy"
    xColumn?: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yColumn?: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    +

    Properties

    adaptiveZoomHide?: boolean
    axes: Axes
    colorMapping?: any

    An object that contains information about the color mapping

    +
    colors: DashboardColor[]

    Colors define color encoding of data into a visualization

    +
    generateXAxisTicks?: string[]
    generateYAxisTicks?: string[]
    geom: XYGeom
    hoverDimension?: "auto" | "x" | "y" | "xy"
    legendColorizeRows?: boolean
    legendHide?: boolean
    legendOpacity?: number
    legendOrientationThreshold?: number
    note: string
    position: "overlaid" | "stacked"
    queries: DashboardQuery[]
    shadeBelow?: boolean
    shape: "chronograf-v2"
    showNoteWhenEmpty: boolean

    If true, will display note when empty

    +
    staticLegend?: StaticLegend
    timeFormat?: string
    type: "xy"
    xColumn?: string
    xTickStart?: number
    xTickStep?: number
    xTotalTicks?: number
    yColumn?: string
    yTickStart?: number
    yTickStep?: number
    yTotalTicks?: number
    diff --git a/interfaces/_influxdata_influxdb-client-giraffe.TableOptions.html b/interfaces/_influxdata_influxdb-client-giraffe.TableOptions.html index ce4bc1cc..a3067347 100644 --- a/interfaces/_influxdata_influxdb-client-giraffe.TableOptions.html +++ b/interfaces/_influxdata_influxdb-client-giraffe.TableOptions.html @@ -1,12 +1,12 @@ TableOptions | Documentation

    Contains parameters that optimize/drive creation of the query result Table.

    -
    interface TableOptions {
        accept?: AcceptRowFunction | AcceptRowFunction[];
        columns?: string[];
        computeFluxGroupKeyUnion?: boolean;
        computeResultColumnNames?: boolean;
        maxTableLength?: number;
    }

    Properties

    interface TableOptions {
        accept?: AcceptRowFunction | AcceptRowFunction[];
        columns?: string[];
        computeFluxGroupKeyUnion?: boolean;
        computeResultColumnNames?: boolean;
        maxTableLength?: number;
    }

    Properties

    Accept allows to accept/reject specific rows or terminate processing.

    -
    columns?: string[]

    column keys to collect in the table, undefined means all columns

    -
    computeFluxGroupKeyUnion?: boolean

    compute also fluxGroupKeyUnion

    -
    computeResultColumnNames?: boolean

    compute also resultColumnNames

    -
    maxTableLength?: number

    Sets maximum table length, QUERY_MAX_TABLE_LENGTH when undefined.

    -
    +
    columns?: string[]

    column keys to collect in the table, undefined means all columns

    +
    computeFluxGroupKeyUnion?: boolean

    compute also fluxGroupKeyUnion

    +
    computeResultColumnNames?: boolean

    compute also resultColumnNames

    +
    maxTableLength?: number

    Sets maximum table length, QUERY_MAX_TABLE_LENGTH when undefined.

    +
    diff --git a/interfaces/_influxdata_influxdb-client.AnnotatedCSVResponse.html b/interfaces/_influxdata_influxdb-client.AnnotatedCSVResponse.html index ea1da91b..2d5c33d9 100644 --- a/interfaces/_influxdata_influxdb-client.AnnotatedCSVResponse.html +++ b/interfaces/_influxdata_influxdb-client.AnnotatedCSVResponse.html @@ -1,7 +1,7 @@ AnnotatedCSVResponse | Documentation

    AnnotatedCSVResponse provides various ways of how to process data from an annotated CSV response stream, which is returned as a result of a flux script execution.

    -
    interface AnnotatedCSVResponse {
        collectLines(): Promise<string[]>;
        collectRows<T>(
            rowMapper?: (
                values: string[],
                tableMeta: FluxTableMetaData,
            ) => undefined | T,
        ): Promise<T[]>;
        consumeLines(consumer: CommunicationObserver<string>): void;
        consumeRows(consumer: FluxResultObserver<string[]>): void;
        iterateLines(): AsyncIterable<string>;
        iterateRows(): AsyncIterable<Row>;
        lines(): Observable<string>;
        rows(): Observable<Row>;
    }

    Methods

    interface AnnotatedCSVResponse {
        collectLines(): Promise<string[]>;
        collectRows<T>(
            rowMapper?: (
                values: string[],
                tableMeta: FluxTableMetaData,
            ) => undefined | T,
        ): Promise<T[]>;
        consumeLines(consumer: CommunicationObserver<string>): void;
        consumeRows(consumer: FluxResultObserver<string[]>): void;
        iterateLines(): AsyncIterable<string>;
        iterateRows(): AsyncIterable<Row>;
        lines(): Observable<string>;
        rows(): Observable<Row>;
    }

    Methods

    collectLines collectRows consumeLines consumeRows @@ -13,24 +13,24 @@ This method is suitable to collect simple results. Use with caution, a possibly huge stream of lines is copied to memory.

    Returns Promise<string[]>

    Promise of returned csv lines

    -
    • CollectRows collects all the result rows in the returned Promise. This method is suitable to collect simple results. Use with caution, a possibly huge stream of results is copied to memory.

      Type Parameters

      • T

      Parameters

      • OptionalrowMapper: (values: string[], tableMeta: FluxTableMetaData) => undefined | T

        maps the supplied row to an item that is then collected, undefined return values are not collected. If no rowMapper is supplied, row => tableMeta.toObject(row.values) is used.

      Returns Promise<T[]>

      Promise of mapped results

      -
    • ConsumeRows consumes result rows through the supplied consumer.

      +

    Returns void

    • IterateLines returns iterable of CSV response lines suitable for for-await loop consumption.

      +

    Returns void

    +
    diff --git a/interfaces/_influxdata_influxdb-client.Cancellable.html b/interfaces/_influxdata_influxdb-client.Cancellable.html index 3833105a..45fa46de 100644 --- a/interfaces/_influxdata_influxdb-client.Cancellable.html +++ b/interfaces/_influxdata_influxdb-client.Cancellable.html @@ -1,5 +1,5 @@ Cancellable | Documentation

    Allows to cancel a running execution.

    -
    interface Cancellable {
        cancel(): void;
        isCancelled(): boolean;
    }

    Methods

    interface Cancellable {
        cancel(): void;
        isCancelled(): boolean;
    }

    Methods

    +

    Returns void

    diff --git a/interfaces/_influxdata_influxdb-client.ChunkCombiner.html b/interfaces/_influxdata_influxdb-client.ChunkCombiner.html index b1e9ac71..34da6560 100644 --- a/interfaces/_influxdata_influxdb-client.ChunkCombiner.html +++ b/interfaces/_influxdata_influxdb-client.ChunkCombiner.html @@ -1,21 +1,21 @@ ChunkCombiner | Documentation

    ChunkCombiner is a simplified platform-neutral manipulation of Uint8arrays that allows to process text data on the fly. The implementation can be optimized for the target platform (node vs browser).

    -
    interface ChunkCombiner {
        concat(first: Uint8Array, second: Uint8Array): Uint8Array;
        copy(chunk: Uint8Array, start: number, end: number): Uint8Array;
        toUtf8String(chunk: Uint8Array, start: number, end: number): string;
    }

    Methods

    interface ChunkCombiner {
        concat(first: Uint8Array, second: Uint8Array): Uint8Array;
        copy(chunk: Uint8Array, start: number, end: number): Uint8Array;
        toUtf8String(chunk: Uint8Array, start: number, end: number): string;
    }

    Methods

    • Concatenates first and second chunk.

      Parameters

      • first: Uint8Array

        first chunk

      • second: Uint8Array

        second chunk

      Returns Uint8Array

      first + second

      -
    • Creates a new chunk from the supplied chunk.

      Parameters

      • chunk: Uint8Array

        chunk to copy

      • start: number

        start index

      • end: number

        end index

      Returns Uint8Array

      a copy of a chunk slice

      -
    • Converts chunk into a string.

      Parameters

      • chunk: Uint8Array

        chunk

      • start: number

        start index

      • end: number

        end index

      Returns string

      string representation of chunk slice

      -
    +
    diff --git a/interfaces/_influxdata_influxdb-client.ClientOptions.html b/interfaces/_influxdata_influxdb-client.ClientOptions.html index bfb7ca80..aad859e7 100644 --- a/interfaces/_influxdata_influxdb-client.ClientOptions.html +++ b/interfaces/_influxdata_influxdb-client.ClientOptions.html @@ -1,5 +1,5 @@ ClientOptions | Documentation

    Options used by InfluxDB .

    -
    interface ClientOptions {
        headers?: Record<string, string>;
        proxyUrl?: string;
        timeout?: number;
        token?: string;
        transport?: Transport;
        transportOptions?: { [key: string]: any };
        url: string;
        writeOptions?: Partial<WriteOptions>;
    }

    Hierarchy (View Summary)

    Properties

    interface ClientOptions {
        headers?: Record<string, string>;
        proxyUrl?: string;
        timeout?: number;
        token?: string;
        transport?: Transport;
        transportOptions?: { [key: string]: any };
        url: string;
        writeOptions?: Partial<WriteOptions>;
    }

    Hierarchy (View Summary)

    Properties

    Properties

    headers?: Record<string, string>

    Default HTTP headers to send with every request.

    -
    proxyUrl?: string

    Full HTTP web proxy URL including schema, for example http://your-proxy:8080.

    -
    timeout?: number

    socket timeout, 10000 milliseconds by default in node.js

    +
    proxyUrl?: string

    Full HTTP web proxy URL including schema, for example http://your-proxy:8080.

    +
    timeout?: number

    socket timeout, 10000 milliseconds by default in node.js

    10000
     
    -
    token?: string

    authentication token

    -
    transport?: Transport

    specifies custom transport

    -
    transportOptions?: { [key: string]: any }

    TransportOptions supply extra options for the transport layer, they differ between node.js and browser/deno. +

    token?: string

    authentication token

    +
    transport?: Transport

    specifies custom transport

    +
    transportOptions?: { [key: string]: any }

    TransportOptions supply extra options for the transport layer, they differ between node.js and browser/deno. Node.js transport accepts options specified in http.request or https.request. For example, an agent property can be set to setup HTTP/HTTPS proxy, rejectUnauthorized @@ -25,6 +25,6 @@ fetch is used under the hood in browser/deno. For example, redirect property can be set to 'error' to abort request if a redirect occurs.

    -
    url: string

    base URL

    -
    writeOptions?: Partial<WriteOptions>

    supplies and overrides default writing options

    -
    +
    url: string

    base URL

    +
    writeOptions?: Partial<WriteOptions>

    supplies and overrides default writing options

    +
    diff --git a/interfaces/_influxdata_influxdb-client.CommunicationObserver.html b/interfaces/_influxdata_influxdb-client.CommunicationObserver.html index 62e8bc9b..fda1ada7 100644 --- a/interfaces/_influxdata_influxdb-client.CommunicationObserver.html +++ b/interfaces/_influxdata_influxdb-client.CommunicationObserver.html @@ -1,19 +1,19 @@ CommunicationObserver | Documentation

    Observes communication with the server.

    -
    interface CommunicationObserver<T> {
        responseStarted?: ResponseStartedFn;
        useCancellable?: (cancellable: Cancellable) => void;
        useResume?: (resume: () => void) => void;
        complete(): void;
        error(error: Error): void;
        next(data: T): boolean | void;
    }

    Type Parameters

    • T

    Properties

    interface CommunicationObserver<T> {
        responseStarted?: ResponseStartedFn;
        useCancellable?: (cancellable: Cancellable) => void;
        useResume?: (resume: () => void) => void;
        complete(): void;
        error(error: Error): void;
        next(data: T): boolean | void;
    }

    Type Parameters

    • T

    Properties

    responseStarted?: ResponseStartedFn

    Informs about a start of response processing.

    -
    useCancellable?: (cancellable: Cancellable) => void

    Setups cancelllable for this communication.

    -
    useResume?: (resume: () => void) => void

    Setups a callback that resumes reading of next data, it is called whenever +

    useCancellable?: (cancellable: Cancellable) => void

    Setups cancelllable for this communication.

    +
    useResume?: (resume: () => void) => void

    Setups a callback that resumes reading of next data, it is called whenever CommunicationObserver.next returns false.

    Type declaration

      • (resume: () => void): void
      • Parameters

        • resume: () => void

          a function that will resume reading of next data when called

          -

        Returns void

    Methods

    • Data chunk received, can be called multiple times.

      +

    Returns void

    Methods

    +
    diff --git a/interfaces/_influxdata_influxdb-client.ConnectionOptions.html b/interfaces/_influxdata_influxdb-client.ConnectionOptions.html index 6831e9bb..2b7c6994 100644 --- a/interfaces/_influxdata_influxdb-client.ConnectionOptions.html +++ b/interfaces/_influxdata_influxdb-client.ConnectionOptions.html @@ -1,18 +1,18 @@ ConnectionOptions | Documentation

    Option for the communication with InfluxDB server.

    -
    interface ConnectionOptions {
        headers?: Record<string, string>;
        proxyUrl?: string;
        timeout?: number;
        token?: string;
        transportOptions?: { [key: string]: any };
        url: string;
    }

    Hierarchy (View Summary)

    Properties

    interface ConnectionOptions {
        headers?: Record<string, string>;
        proxyUrl?: string;
        timeout?: number;
        token?: string;
        transportOptions?: { [key: string]: any };
        url: string;
    }

    Hierarchy (View Summary)

    Properties

    headers?: Record<string, string>

    Default HTTP headers to send with every request.

    -
    proxyUrl?: string

    Full HTTP web proxy URL including schema, for example http://your-proxy:8080.

    -
    timeout?: number

    socket timeout, 10000 milliseconds by default in node.js

    +
    proxyUrl?: string

    Full HTTP web proxy URL including schema, for example http://your-proxy:8080.

    +
    timeout?: number

    socket timeout, 10000 milliseconds by default in node.js

    10000
     
    -
    token?: string

    authentication token

    -
    transportOptions?: { [key: string]: any }

    TransportOptions supply extra options for the transport layer, they differ between node.js and browser/deno. +

    token?: string

    authentication token

    +
    transportOptions?: { [key: string]: any }

    TransportOptions supply extra options for the transport layer, they differ between node.js and browser/deno. Node.js transport accepts options specified in http.request or https.request. For example, an agent property can be set to setup HTTP/HTTPS proxy, rejectUnauthorized @@ -22,5 +22,5 @@ fetch is used under the hood in browser/deno. For example, redirect property can be set to 'error' to abort request if a redirect occurs.

    -
    url: string

    base URL

    -
    +
    url: string

    base URL

    +
    diff --git a/interfaces/_influxdata_influxdb-client.FluxParameterLike.html b/interfaces/_influxdata_influxdb-client.FluxParameterLike.html index 1309fc9e..92ae30dd 100644 --- a/interfaces/_influxdata_influxdb-client.FluxParameterLike.html +++ b/interfaces/_influxdata_influxdb-client.FluxParameterLike.html @@ -1,3 +1,3 @@ FluxParameterLike | Documentation

    A flux parameter can print its (sanitized) flux value.

    -
    interface FluxParameterLike {
        "[FLUX_VALUE]"(): string;
    }

    Methods

    Methods

    +
    interface FluxParameterLike {
        "[FLUX_VALUE]"(): string;
    }

    Methods

    Methods

    diff --git a/interfaces/_influxdata_influxdb-client.FluxResultObserver.html b/interfaces/_influxdata_influxdb-client.FluxResultObserver.html index ae841c1d..25ad5006 100644 --- a/interfaces/_influxdata_influxdb-client.FluxResultObserver.html +++ b/interfaces/_influxdata_influxdb-client.FluxResultObserver.html @@ -1,18 +1,18 @@ FluxResultObserver | Documentation

    Observes results of a flux query.

    -
    interface FluxResultObserver<T> {
        useCancellable?: (cancellable: Cancellable) => void;
        useResume?: (resume: () => void) => void;
        complete(): void;
        error(error: Error): void;
        next(row: T, tableMeta: FluxTableMetaData): boolean | void;
    }

    Type Parameters

    • T

    Properties

    interface FluxResultObserver<T> {
        useCancellable?: (cancellable: Cancellable) => void;
        useResume?: (resume: () => void) => void;
        complete(): void;
        error(error: Error): void;
        next(row: T, tableMeta: FluxTableMetaData): boolean | void;
    }

    Type Parameters

    • T

    Properties

    useCancellable?: (cancellable: Cancellable) => void

    Setups cancellable that can abort flux result processing.

    -
    useResume?: (resume: () => void) => void

    Setups a callback that resumes reading of next data, it is called whenever +

    useResume?: (resume: () => void) => void

    Setups a callback that resumes reading of next data, it is called whenever FluxResultObserver.next returns false.

    Type declaration

      • (resume: () => void): void
      • Parameters

        • resume: () => void

          a function that will resume reading of next data when called

          -

        Returns void

    Methods

    • Inform about a next record in a table.

      +

    Returns void

    Methods

    +
    diff --git a/interfaces/_influxdata_influxdb-client.FluxTableColumn.html b/interfaces/_influxdata_influxdb-client.FluxTableColumn.html index 567916e9..d2204833 100644 --- a/interfaces/_influxdata_influxdb-client.FluxTableColumn.html +++ b/interfaces/_influxdata_influxdb-client.FluxTableColumn.html @@ -1,16 +1,16 @@ FluxTableColumn | Documentation

    FluxTableColumn describes flux table column.

    -
    interface FluxTableColumn {
        dataType: string;
        defaultValue: string;
        get: (row: string[]) => any;
        group: boolean;
        index: number;
        label: string;
    }

    Properties

    interface FluxTableColumn {
        dataType: string;
        defaultValue: string;
        get: (row: string[]) => any;
        group: boolean;
        index: number;
        label: string;
    }

    Properties

    dataType: string

    The data type of column (e.g., "string", "long", "dateTime:RFC3339").

    -
    defaultValue: string

    Default value to be used for rows whose string value is an empty string.

    -
    get: (row: string[]) => any

    Get returns a JavaScript object of this column in the supplied result row, using default deserializers.

    +
    defaultValue: string

    Default value to be used for rows whose string value is an empty string.

    +
    get: (row: string[]) => any

    Get returns a JavaScript object of this column in the supplied result row, using default deserializers.

    Type declaration

      • (row: string[]): any
      • Parameters

        • row: string[]

          a data row

        Returns any

        column value

        -
    group: boolean

    Boolean flag indicating if the column is a part of the table's group key.

    -
    index: number

    Index of this column in a row array.

    -
    label: string

    Label (e.g., "_start", "_stop", "_time").

    -
    +
    group: boolean

    Boolean flag indicating if the column is a part of the table's group key.

    +
    index: number

    Index of this column in a row array.

    +
    label: string

    Label (e.g., "_start", "_stop", "_time").

    +
    diff --git a/interfaces/_influxdata_influxdb-client.FluxTableMetaData.html b/interfaces/_influxdata_influxdb-client.FluxTableMetaData.html index a86d277e..fee27c83 100644 --- a/interfaces/_influxdata_influxdb-client.FluxTableMetaData.html +++ b/interfaces/_influxdata_influxdb-client.FluxTableMetaData.html @@ -1,18 +1,18 @@ FluxTableMetaData | Documentation

    Represents metadata of a flux table.

    -
    interface FluxTableMetaData {
        columns: FluxTableColumn[];
        column(label: string, errorOnMissingColumn?: boolean): FluxTableColumn;
        get(row: string[], column: string): any;
        toObject(row: string[]): { [key: string]: any };
    }

    Properties

    interface FluxTableMetaData {
        columns: FluxTableColumn[];
        column(label: string, errorOnMissingColumn?: boolean): FluxTableColumn;
        get(row: string[], column: string): any;
        toObject(row: string[]): { [key: string]: any };
    }

    Properties

    Methods

    Properties

    columns: FluxTableColumn[]

    Table columns.

    -

    Methods

    Methods

    • Gets column values out of the supplied row.

      +
    • Gets column values out of the supplied row.

      Parameters

      • row: string[]

        a row with data for each column

      • column: string

        column name

      Returns any

      column value, undefined for unknown column

      -
    • Creates an object out of the supplied row with the help of column descriptors.

      Parameters

      • row: string[]

        a row with data for each column

        -

      Returns { [key: string]: any }

    +

    Returns { [key: string]: any }

    diff --git a/interfaces/_influxdata_influxdb-client.Logger.html b/interfaces/_influxdata_influxdb-client.Logger.html index 7c982b4c..bf80c50c 100644 --- a/interfaces/_influxdata_influxdb-client.Logger.html +++ b/interfaces/_influxdata_influxdb-client.Logger.html @@ -1,4 +1,4 @@ Logger | Documentation

    Logging interface.

    -
    interface Logger {
        error(message: string, err?: any): void;
        warn(message: string, err?: any): void;
    }

    Methods

    interface Logger {
        error(message: string, err?: any): void;
        warn(message: string, err?: any): void;
    }

    Methods

    Methods

    +

    Methods

    diff --git a/interfaces/_influxdata_influxdb-client.Observable.html b/interfaces/_influxdata_influxdb-client.Observable.html index ec83fae5..bc829c95 100644 --- a/interfaces/_influxdata_influxdb-client.Observable.html +++ b/interfaces/_influxdata_influxdb-client.Observable.html @@ -3,6 +3,6 @@ can be consumed by other observable libraries like rx js or zen-observable.

    -
    interface Observable<T> {
        "[observable]"(): Subscribable<T>;
        subscribe(): Subscription;
        subscribe(observer: Partial<Observer<T>>): Subscription;
        subscribe(
            next: ObserverNext<T>,
            error?: ObserverError,
            complete?: ObserverComplete,
        ): Subscription;
    }

    Type Parameters

    Methods

    interface Observable<T> {
        "[observable]"(): Subscribable<T>;
        subscribe(): Subscription;
        subscribe(observer: Partial<Observer<T>>): Subscription;
        subscribe(
            next: ObserverNext<T>,
            error?: ObserverError,
            complete?: ObserverComplete,
        ): Subscription;
    }

    Type Parameters

    • T

    Methods

    +

    Methods

    diff --git a/interfaces/_influxdata_influxdb-client.Observer.html b/interfaces/_influxdata_influxdb-client.Observer.html index 1169c220..2bff3039 100644 --- a/interfaces/_influxdata_influxdb-client.Observer.html +++ b/interfaces/_influxdata_influxdb-client.Observer.html @@ -1,5 +1,5 @@ Observer | Documentation

    Observer mimics Observer from ECMAScript TC39 Observable proposal

    -
    interface Observer<T> {
        complete: ObserverComplete;
        error: ObserverError;
        next: ObserverNext<T>;
    }

    Type Parameters

    • T

    Properties

    interface Observer<T> {
        complete: ObserverComplete;
        error: ObserverError;
        next: ObserverNext<T>;
    }

    Type Parameters

    • T

    Properties

    Properties

    +

    Properties

    diff --git a/interfaces/_influxdata_influxdb-client.ParameterizedQuery.html b/interfaces/_influxdata_influxdb-client.ParameterizedQuery.html index 8a5589ed..e37bd207 100644 --- a/interfaces/_influxdata_influxdb-client.ParameterizedQuery.html +++ b/interfaces/_influxdata_influxdb-client.ParameterizedQuery.html @@ -1,4 +1,4 @@ ParameterizedQuery | Documentation

    Represents a parameterized query.

    -
    interface ParameterizedQuery {
        toString(): string;
    }

    Methods

    interface ParameterizedQuery {
        toString(): string;
    }

    Methods

    Methods

    +

    Returns string

    diff --git a/interfaces/_influxdata_influxdb-client.PointSettings.html b/interfaces/_influxdata_influxdb-client.PointSettings.html index 048a2bbb..fb5e3d09 100644 --- a/interfaces/_influxdata_influxdb-client.PointSettings.html +++ b/interfaces/_influxdata_influxdb-client.PointSettings.html @@ -1,7 +1,7 @@ PointSettings | Documentation

    Settings that control the way of how a Point is serialized to a protocol line.

    -
    interface PointSettings {
        convertTime?: (
            value: undefined | string | number | Date,
        ) => undefined | string;
        defaultTags?: { [key: string]: string };
    }

    Hierarchy (View Summary)

    Properties

    interface PointSettings {
        convertTime?: (
            value: undefined | string | number | Date,
        ) => undefined | string;
        defaultTags?: { [key: string]: string };
    }

    Hierarchy (View Summary)

    Properties

    convertTime?: (value: undefined | string | number | Date) => undefined | string

    convertTime serializes Point's timestamp to a line protocol value

    -
    defaultTags?: { [key: string]: string }

    default tags to add to every point

    -
    +
    defaultTags?: { [key: string]: string }

    default tags to add to every point

    +
    diff --git a/interfaces/_influxdata_influxdb-client.QueryApi.html b/interfaces/_influxdata_influxdb-client.QueryApi.html index 61fa2066..05be98a5 100644 --- a/interfaces/_influxdata_influxdb-client.QueryApi.html +++ b/interfaces/_influxdata_influxdb-client.QueryApi.html @@ -1,6 +1,6 @@ QueryApi | Documentation

    Query InfluxDB. Provides methods that notify about result lines of the executed query. See https://docs.influxdata.com/influxdb/latest/api/#operation/PostQuery

    -
    interface QueryApi {
        collectLines(query: string | ParameterizedQuery): Promise<string[]>;
        collectRows<T>(
            query: string | ParameterizedQuery,
            rowMapper?: (
                values: string[],
                tableMeta: FluxTableMetaData,
            ) => undefined | T,
        ): Promise<T[]>;
        iterateLines(query: string | ParameterizedQuery): AsyncIterable<string>;
        iterateRows(query: string | ParameterizedQuery): AsyncIterable<Row>;
        lines(query: string | ParameterizedQuery): Observable<string>;
        queryLines(
            query: string | ParameterizedQuery,
            consumer: CommunicationObserver<string>,
        ): void;
        queryRaw(query: string | ParameterizedQuery): Promise<string>;
        queryRows(
            query: string | ParameterizedQuery,
            consumer: FluxResultObserver<string[]>,
        ): void;
        response(query: string | ParameterizedQuery): AnnotatedCSVResponse;
        rows(query: string | ParameterizedQuery): Observable<Row>;
        with(options: Partial<QueryOptions>): QueryApi;
    }

    Methods

    interface QueryApi {
        collectLines(query: string | ParameterizedQuery): Promise<string[]>;
        collectRows<T>(
            query: string | ParameterizedQuery,
            rowMapper?: (
                values: string[],
                tableMeta: FluxTableMetaData,
            ) => undefined | T,
        ): Promise<T[]>;
        iterateLines(query: string | ParameterizedQuery): AsyncIterable<string>;
        iterateRows(query: string | ParameterizedQuery): AsyncIterable<Row>;
        lines(query: string | ParameterizedQuery): Observable<string>;
        queryLines(
            query: string | ParameterizedQuery,
            consumer: CommunicationObserver<string>,
        ): void;
        queryRaw(query: string | ParameterizedQuery): Promise<string>;
        queryRows(
            query: string | ParameterizedQuery,
            consumer: FluxResultObserver<string[]>,
        ): void;
        response(query: string | ParameterizedQuery): AnnotatedCSVResponse;
        rows(query: string | ParameterizedQuery): Observable<Row>;
        with(options: Partial<QueryOptions>): QueryApi;
    }

    Methods

    collectLines collectRows iterateLines iterateRows @@ -16,7 +16,7 @@ a possibly huge stream of lines is copied to memory.

    Parameters

    Returns Promise<string[]>

    Promise of returned csv lines

    -
    • CollectRows executes the query and collects all the results in the returned Promise. This method is suitable to collect simple results. Use with caution, a possibly huge stream of results is copied to memory.

      Type Parameters

      • T

      Parameters

      • query: string | ParameterizedQuery

        query

        @@ -24,39 +24,39 @@ undefined return values are not collected. If no rowMapper is supplied, row => tableMeta.toObject(row.values) is used.

      Returns Promise<T[]>

      Promise of mapped results

      -
    • IterateLines executes the supplied query and returns results in an async iterable of annotated CSV lines. Async iterables are best consumed by for-await loop.

      Parameters

      Returns AsyncIterable<string>

      async iterable of CSV result lines

      -
    • IterateRows executes the supplied query and returns results in an async iterable of row data and table metadata pairs. Async iterables are best consumed by for-await loop.

      Parameters

      Returns AsyncIterable<Row>

      async iterable of CSV result lines

      -
    • QueryRaw executes a query and returns the full response as a string. +

    Returns void

    Returns void

    +
    diff --git a/interfaces/_influxdata_influxdb-client.QueryOptions.html b/interfaces/_influxdata_influxdb-client.QueryOptions.html index b05d74df..bf5de43e 100644 --- a/interfaces/_influxdata_influxdb-client.QueryOptions.html +++ b/interfaces/_influxdata_influxdb-client.QueryOptions.html @@ -1,13 +1,13 @@ QueryOptions | Documentation

    QueryOptions contains QueryApi configuration options.

    -
    interface QueryOptions {
        gzip?: boolean;
        headers?: { [key: string]: string };
        now?: () => string;
        org: string;
        type?: "flux";
    }

    Properties

    interface QueryOptions {
        gzip?: boolean;
        headers?: { [key: string]: string };
        now?: () => string;
        org: string;
        type?: "flux";
    }

    Properties

    gzip?: boolean

    Requests gzip encoded response.

    -
    headers?: { [key: string]: string }

    HTTP headers that will be sent with every query request.

    -
    now?: () => string

    Specifies the time that should be reported as "now" in the query. RFC3339 value must be returned, +

    headers?: { [key: string]: string }

    HTTP headers that will be sent with every query request.

    +
    now?: () => string

    Specifies the time that should be reported as "now" in the query. RFC3339 value must be returned, for example new Date().toISOString().

    -
    org: string

    Specifies the name of the organization executing the query. Takes either the ID or Name interchangeably.

    -
    type?: "flux"

    Type of the query, default is "flux"

    -
    +
    org: string

    Specifies the name of the organization executing the query. Takes either the ID or Name interchangeably.

    +
    type?: "flux"

    Type of the query, default is "flux"

    +
    diff --git a/interfaces/_influxdata_influxdb-client.RetriableDecision.html b/interfaces/_influxdata_influxdb-client.RetriableDecision.html index e26566c4..f6d39256 100644 --- a/interfaces/_influxdata_influxdb-client.RetriableDecision.html +++ b/interfaces/_influxdata_influxdb-client.RetriableDecision.html @@ -1,7 +1,7 @@ RetriableDecision | Documentation

    Interface for errors to inform that an associated operation can be retried.

    -
    interface RetriableDecision {
        canRetry(): boolean;
        retryAfter(): number;
    }

    Implemented by

    Methods

    interface RetriableDecision {
        canRetry(): boolean;
        retryAfter(): number;
    }

    Implemented by

    Methods

    • Get the delay in milliseconds to retry the action.

      Returns number

      0 to let the implementation decide, miliseconds delay otherwise

      -
    +
    diff --git a/interfaces/_influxdata_influxdb-client.RetryDelayStrategy.html b/interfaces/_influxdata_influxdb-client.RetryDelayStrategy.html index 96056485..e3265696 100644 --- a/interfaces/_influxdata_influxdb-client.RetryDelayStrategy.html +++ b/interfaces/_influxdata_influxdb-client.RetryDelayStrategy.html @@ -1,9 +1,9 @@ RetryDelayStrategy | Documentation

    Strategy for calculating retry delays.

    -
    interface RetryDelayStrategy {
        nextDelay(error?: Error, failedAttempts?: number): number;
        success(): void;
    }

    Methods

    interface RetryDelayStrategy {
        nextDelay(error?: Error, failedAttempts?: number): number;
        success(): void;
    }

    Methods

    • Returns delay for a next retry

      Parameters

      • Optionalerror: Error

        reason for retrying

      • OptionalfailedAttempts: number

        a count of already failed attempts, 1 being the first

      Returns number

      milliseconds to wait before retrying

      -
    +
    diff --git a/interfaces/_influxdata_influxdb-client.RetryDelayStrategyOptions.html b/interfaces/_influxdata_influxdb-client.RetryDelayStrategyOptions.html index 757a4793..9d7c223d 100644 --- a/interfaces/_influxdata_influxdb-client.RetryDelayStrategyOptions.html +++ b/interfaces/_influxdata_influxdb-client.RetryDelayStrategyOptions.html @@ -1,16 +1,16 @@ RetryDelayStrategyOptions | Documentation

    Options that configure strategy for retrying failed requests.

    -
    interface RetryDelayStrategyOptions {
        exponentialBase: number;
        maxRetryDelay: number;
        minRetryDelay: number;
        randomRetry: boolean;
        retryJitter: number;
    }

    Hierarchy (View Summary)

    Properties

    interface RetryDelayStrategyOptions {
        exponentialBase: number;
        maxRetryDelay: number;
        minRetryDelay: number;
        randomRetry: boolean;
        retryJitter: number;
    }

    Hierarchy (View Summary)

    Properties

    exponentialBase: number

    base for the exponential retry delay

    -
    maxRetryDelay: number

    maximum delay when retrying write (milliseconds)

    -
    minRetryDelay: number

    minimum delay when retrying write (milliseconds)

    -
    randomRetry: boolean

    randomRetry indicates whether the next retry delay is deterministic (false) or random (true). +

    maxRetryDelay: number

    maximum delay when retrying write (milliseconds)

    +
    minRetryDelay: number

    minimum delay when retrying write (milliseconds)

    +
    randomRetry: boolean

    randomRetry indicates whether the next retry delay is deterministic (false) or random (true). The deterministic delay starts with minRetryDelay * exponentialBase and it is multiplied by exponentialBase until it exceeds maxRetryDelay. When random is true, the next delay is computed as a random number between next retry attempt (upper) and the lower number in the deterministic sequence. random(retryJitter) is added to every returned value.

    -
    retryJitter: number

    add random(retryJitter) milliseconds delay when retrying HTTP calls

    -
    +
    retryJitter: number

    add random(retryJitter) milliseconds delay when retrying HTTP calls

    +
    diff --git a/interfaces/_influxdata_influxdb-client.Row.html b/interfaces/_influxdata_influxdb-client.Row.html index 5af17845..8b883c6c 100644 --- a/interfaces/_influxdata_influxdb-client.Row.html +++ b/interfaces/_influxdata_influxdb-client.Row.html @@ -1,4 +1,4 @@ Row | Documentation

    Wraps values and associated metadata of a query result row

    -
    interface Row {
        tableMeta: FluxTableMetaData;
        values: string[];
    }

    Properties

    interface Row {
        tableMeta: FluxTableMetaData;
        values: string[];
    }

    Properties

    Properties

    values: string[]
    +

    Properties

    values: string[]
    diff --git a/interfaces/_influxdata_influxdb-client.SendOptions.html b/interfaces/_influxdata_influxdb-client.SendOptions.html index f7d02561..563ef102 100644 --- a/interfaces/_influxdata_influxdb-client.SendOptions.html +++ b/interfaces/_influxdata_influxdb-client.SendOptions.html @@ -1,10 +1,10 @@ SendOptions | Documentation

    Options for sending a request message.

    -
    interface SendOptions {
        gzipThreshold?: number;
        headers?: { [key: string]: string };
        method: string;
        signal?: AbortSignal;
    }

    Properties

    interface SendOptions {
        gzipThreshold?: number;
        headers?: { [key: string]: string };
        method: string;
        signal?: AbortSignal;
    }

    Properties

    gzipThreshold?: number

    When specified, message body larger than the treshold is gzipped

    -
    headers?: { [key: string]: string }

    Request HTTP headers.

    -
    method: string

    HTTP method (POST, PUT, GET, PATCH ...)

    -
    signal?: AbortSignal

    Abort signal

    -
    +
    headers?: { [key: string]: string }

    Request HTTP headers.

    +
    method: string

    HTTP method (POST, PUT, GET, PATCH ...)

    +
    signal?: AbortSignal

    Abort signal

    +
    diff --git a/interfaces/_influxdata_influxdb-client.Subscribable.html b/interfaces/_influxdata_influxdb-client.Subscribable.html index 049eba3a..0f50f2b6 100644 --- a/interfaces/_influxdata_influxdb-client.Subscribable.html +++ b/interfaces/_influxdata_influxdb-client.Subscribable.html @@ -1,2 +1,2 @@ -Subscribable | Documentation
    interface Subscribable<T> {
        subscribe(observer: Partial<Observer<T>>): Subscription;
    }

    Type Parameters

    • T

    Methods

    Methods

    +Subscribable | Documentation
    interface Subscribable<T> {
        subscribe(observer: Partial<Observer<T>>): Subscription;
    }

    Type Parameters

    • T

    Methods

    Methods

    diff --git a/interfaces/_influxdata_influxdb-client.Subscription.html b/interfaces/_influxdata_influxdb-client.Subscription.html index a0450fc7..8232fac5 100644 --- a/interfaces/_influxdata_influxdb-client.Subscription.html +++ b/interfaces/_influxdata_influxdb-client.Subscription.html @@ -1,4 +1,4 @@ Subscription | Documentation

    Subscription mimics Subscription from ECMAScript TC39 Observable proposal

    -
    interface Subscription {
        closed: boolean;
        unsubscribe(): void;
    }

    Properties

    interface Subscription {
        closed: boolean;
        unsubscribe(): void;
    }

    Properties

    Methods

    Properties

    closed: boolean

    Methods

    +

    Properties

    closed: boolean

    Methods

    diff --git a/interfaces/_influxdata_influxdb-client.Transport.html b/interfaces/_influxdata_influxdb-client.Transport.html index 3cbc17a5..b2d584e2 100644 --- a/interfaces/_influxdata_influxdb-client.Transport.html +++ b/interfaces/_influxdata_influxdb-client.Transport.html @@ -1,24 +1,24 @@ Transport | Documentation

    Simpified platform-neutral transport layer for communication with InfluxDB.

    -
    interface Transport {
        chunkCombiner: ChunkCombiner;
        iterate(
            path: string,
            requestBody: any,
            options: SendOptions,
        ): AsyncIterableIterator<Uint8Array>;
        request(
            path: string,
            requestBody: any,
            options: SendOptions,
            responseStarted?: ResponseStartedFn,
        ): Promise<any>;
        send(
            path: string,
            requestBody: string,
            options: SendOptions,
            callbacks?: Partial<CommunicationObserver<Uint8Array>>,
        ): void;
    }

    Properties

    interface Transport {
        chunkCombiner: ChunkCombiner;
        iterate(
            path: string,
            requestBody: any,
            options: SendOptions,
        ): AsyncIterableIterator<Uint8Array>;
        request(
            path: string,
            requestBody: any,
            options: SendOptions,
            responseStarted?: ResponseStartedFn,
        ): Promise<any>;
        send(
            path: string,
            requestBody: string,
            options: SendOptions,
            callbacks?: Partial<CommunicationObserver<Uint8Array>>,
        ): void;
    }

    Properties

    Methods

    Properties

    chunkCombiner: ChunkCombiner

    Combines response chunks to create a single response object.

    -

    Methods

    • Sends requestBody and returns response chunks in an async iterable +

    Methods

    • Sends requestBody and returns response chunks in an async iterable that can be easily consumed in an for-await loop.

      Parameters

      • path: string

        HTTP request path

      • requestBody: any

        request body

      • options: SendOptions

        send options

      Returns AsyncIterableIterator<Uint8Array>

      async iterable

      -
    • Sends data to the server and receives decoded result. The type of the result depends on response's content-type (deserialized json, text).

      Parameters

      Returns Promise<any>

      response data

      -
    • Send data to the server and receive communication events via callbacks.

      Parameters

      • path: string

        HTTP request path

      • requestBody: string

        HTTP request body

      • options: SendOptions

        send options

      • Optionalcallbacks: Partial<CommunicationObserver<Uint8Array>>

        communication callbacks to received data in Uint8Array

        -

      Returns void

    +

    Returns void

    diff --git a/interfaces/_influxdata_influxdb-client.WriteApi.html b/interfaces/_influxdata_influxdb-client.WriteApi.html index 9569c6e8..cd8a1373 100644 --- a/interfaces/_influxdata_influxdb-client.WriteApi.html +++ b/interfaces/_influxdata_influxdb-client.WriteApi.html @@ -2,7 +2,7 @@ This API always buffers points/lines to create batches under the hood to optimize data transfer to InfluxDB server, use flush to send the buffered data to InfluxDB immediately.

    -
    interface WriteApi {
        convertTime?: (
            value: undefined | string | number | Date,
        ) => undefined | string;
        defaultTags?: { [key: string]: string };
        path: string;
        close(): Promise<void>;
        dispose(): number;
        flush(withRetryBuffer?: boolean): Promise<void>;
        useDefaultTags(tags: { [key: string]: string }): WriteApi;
        writePoint(point: Point): void;
        writePoints(points: ArrayLike<Point>): void;
        writeRecord(record: string): void;
        writeRecords(records: string[]): void;
    }

    Hierarchy (View Summary)

    Properties

    interface WriteApi {
        convertTime?: (
            value: undefined | string | number | Date,
        ) => undefined | string;
        defaultTags?: { [key: string]: string };
        path: string;
        close(): Promise<void>;
        dispose(): number;
        flush(withRetryBuffer?: boolean): Promise<void>;
        useDefaultTags(tags: { [key: string]: string }): WriteApi;
        writePoint(point: Point): void;
        writePoints(points: ArrayLike<Point>): void;
        writeRecord(record: string): void;
        writeRecords(records: string[]): void;
    }

    Hierarchy (View Summary)

    Properties

    Methods

    close @@ -14,28 +14,28 @@ writeRecord writeRecords

    Properties

    convertTime?: (value: undefined | string | number | Date) => undefined | string

    convertTime serializes Point's timestamp to a line protocol value

    -
    defaultTags?: { [key: string]: string }

    default tags to add to every point

    -
    path: string

    HTTP path and query parameters of InfluxDB query API. It is +

    defaultTags?: { [key: string]: string }

    default tags to add to every point

    +
    path: string

    HTTP path and query parameters of InfluxDB query API. It is automatically initialized to /api/v2/write?org=..., but it can be changed after the API is obtained.

    -

    Methods

    Methods

    • Flushes this writer and cancels retries of write operations that failed.

      Returns Promise<void>

      completition promise

      -
    • Unlike close, dispose simply quits without trying to flush the buffered data.

      Returns number

      count of points that were not written to InfluxDB

      -
    • Flushes pending writes to the server.

      Parameters

      • OptionalwithRetryBuffer: boolean

        flush also all the scheduled retries

      Returns Promise<void>

      completition promise

      -
    • Instructs to use the following default tags when writing points. Not applicable for writing records/lines.

      Parameters

      • tags: { [key: string]: string }

        default tags

      Returns WriteApi

      this

      -
    • Write points.

      +

    Returns void

    • Write a line of Line Protocol.

      +

    Returns void

    • Write lines of Line Protocol.

      +

    Returns void

    +

    Returns void

    diff --git a/interfaces/_influxdata_influxdb-client.WriteOptions.html b/interfaces/_influxdata_influxdb-client.WriteOptions.html index b94c752c..f69eeca2 100644 --- a/interfaces/_influxdata_influxdb-client.WriteOptions.html +++ b/interfaces/_influxdata_influxdb-client.WriteOptions.html @@ -1,5 +1,5 @@ WriteOptions | Documentation

    Options used by WriteApi .

    -
    interface WriteOptions {
        batchSize: number;
        consistency?: "all" | "one" | "any" | "quorum";
        defaultTags?: Record<string, string>;
        exponentialBase: number;
        flushInterval: number;
        gzipThreshold?: number;
        headers?: { [key: string]: string };
        maxBatchBytes: number;
        maxBufferLines: number;
        maxRetries: number;
        maxRetryDelay: number;
        maxRetryTime: number;
        minRetryDelay: number;
        randomRetry: boolean;
        retryJitter: number;
        writeFailed(
            this: WriteApi,
            error: Error,
            lines: string[],
            attempt: number,
            expires: number,
        ): void | Promise<void>;
        writeRetrySkipped(entry: { expires: number; lines: string[] }): void;
        writeSuccess(this: WriteApi, lines: string[]): void;
    }

    Hierarchy (View Summary)

    Properties

    interface WriteOptions {
        batchSize: number;
        consistency?: "all" | "one" | "any" | "quorum";
        defaultTags?: Record<string, string>;
        exponentialBase: number;
        flushInterval: number;
        gzipThreshold?: number;
        headers?: { [key: string]: string };
        maxBatchBytes: number;
        maxBufferLines: number;
        maxRetries: number;
        maxRetryDelay: number;
        maxRetryTime: number;
        minRetryDelay: number;
        randomRetry: boolean;
        retryJitter: number;
        writeFailed(
            this: WriteApi,
            error: Error,
            lines: string[],
            attempt: number,
            expires: number,
        ): void | Promise<void>;
        writeRetrySkipped(entry: { expires: number; lines: string[] }): void;
        writeSuccess(this: WriteApi, lines: string[]): void;
    }

    Hierarchy (View Summary)

    Properties

    batchSize: number

    max number of records/lines to send in a batch

    -
    consistency?: "all" | "one" | "any" | "quorum"
    defaultTags?: Record<string, string>

    default tags, unescaped

    -
    exponentialBase: number

    base for the exponential retry delay

    -
    flushInterval: number

    delay between data flushes in milliseconds, at most batch size records are sent during flush

    -
    gzipThreshold?: number

    When specified, write bodies larger than the threshold are gzipped

    -
    headers?: { [key: string]: string }

    HTTP headers that will be sent with every write request

    -
    maxBatchBytes: number

    max size of a batch in bytes

    -
    maxBufferLines: number

    the maximum size of retry-buffer (in lines)

    -
    maxRetries: number

    max count of retries after the first write fails

    -
    maxRetryDelay: number

    maximum delay when retrying write (milliseconds)

    -
    maxRetryTime: number

    max time (millis) that can be spent with retries

    -
    minRetryDelay: number

    minimum delay when retrying write (milliseconds)

    -
    randomRetry: boolean

    randomRetry indicates whether the next retry delay is deterministic (false) or random (true). +

    consistency?: "all" | "one" | "any" | "quorum"
    defaultTags?: Record<string, string>

    default tags, unescaped

    +
    exponentialBase: number

    base for the exponential retry delay

    +
    flushInterval: number

    delay between data flushes in milliseconds, at most batch size records are sent during flush

    +
    gzipThreshold?: number

    When specified, write bodies larger than the threshold are gzipped

    +
    headers?: { [key: string]: string }

    HTTP headers that will be sent with every write request

    +
    maxBatchBytes: number

    max size of a batch in bytes

    +
    maxBufferLines: number

    the maximum size of retry-buffer (in lines)

    +
    maxRetries: number

    max count of retries after the first write fails

    +
    maxRetryDelay: number

    maximum delay when retrying write (milliseconds)

    +
    maxRetryTime: number

    max time (millis) that can be spent with retries

    +
    minRetryDelay: number

    minimum delay when retrying write (milliseconds)

    +
    randomRetry: boolean

    randomRetry indicates whether the next retry delay is deterministic (false) or random (true). The deterministic delay starts with minRetryDelay * exponentialBase and it is multiplied by exponentialBase until it exceeds maxRetryDelay. When random is true, the next delay is computed as a random number between next retry attempt (upper) and the lower number in the deterministic sequence. random(retryJitter) is added to every returned value.

    -
    retryJitter: number

    add random(retryJitter) milliseconds delay when retrying HTTP calls

    -

    Methods

    retryJitter: number

    add random(retryJitter) milliseconds delay when retrying HTTP calls

    +

    Methods

    • WriteFailed is called to inform about write errors.

      Parameters

      • this: WriteApi

        the instance of the API that failed

      • error: Error

        write error

      • lines: string[]

        failed lines

        @@ -44,10 +44,10 @@
      • expires: number

        expiration time for the lines to be retried in millis since epoch

      Returns void | Promise<void>

      a Promise to force the API to use it as a result of the flush operation, void/undefined to continue with default retry mechanism

      -
    • WriteRetrySkipped is informed about lines that were removed from the retry buffer to keep the size of the retry buffer under the configured limit (maxBufferLines).

      Parameters

      • entry: { expires: number; lines: string[] }

        lines that were skipped

        -

      Returns void

    • WriteSuccess is informed about successfully written lines.

      +

    Returns void

    +

    Returns void

    diff --git a/interfaces/_influxdata_influxdb-client.WriteRetryOptions.html b/interfaces/_influxdata_influxdb-client.WriteRetryOptions.html index 2746634d..39e3ecce 100644 --- a/interfaces/_influxdata_influxdb-client.WriteRetryOptions.html +++ b/interfaces/_influxdata_influxdb-client.WriteRetryOptions.html @@ -1,5 +1,5 @@ WriteRetryOptions | Documentation

    Options that configure strategy for retrying failed InfluxDB write operations.

    -
    interface WriteRetryOptions {
        exponentialBase: number;
        maxBufferLines: number;
        maxRetries: number;
        maxRetryDelay: number;
        maxRetryTime: number;
        minRetryDelay: number;
        randomRetry: boolean;
        retryJitter: number;
        writeFailed(
            this: WriteApi,
            error: Error,
            lines: string[],
            attempt: number,
            expires: number,
        ): void | Promise<void>;
        writeRetrySkipped(entry: { expires: number; lines: string[] }): void;
        writeSuccess(this: WriteApi, lines: string[]): void;
    }

    Hierarchy (View Summary)

    Properties

    interface WriteRetryOptions {
        exponentialBase: number;
        maxBufferLines: number;
        maxRetries: number;
        maxRetryDelay: number;
        maxRetryTime: number;
        minRetryDelay: number;
        randomRetry: boolean;
        retryJitter: number;
        writeFailed(
            this: WriteApi,
            error: Error,
            lines: string[],
            attempt: number,
            expires: number,
        ): void | Promise<void>;
        writeRetrySkipped(entry: { expires: number; lines: string[] }): void;
        writeSuccess(this: WriteApi, lines: string[]): void;
    }

    Hierarchy (View Summary)

    Properties

    exponentialBase: number

    base for the exponential retry delay

    -
    maxBufferLines: number

    the maximum size of retry-buffer (in lines)

    -
    maxRetries: number

    max count of retries after the first write fails

    -
    maxRetryDelay: number

    maximum delay when retrying write (milliseconds)

    -
    maxRetryTime: number

    max time (millis) that can be spent with retries

    -
    minRetryDelay: number

    minimum delay when retrying write (milliseconds)

    -
    randomRetry: boolean

    randomRetry indicates whether the next retry delay is deterministic (false) or random (true). +

    maxBufferLines: number

    the maximum size of retry-buffer (in lines)

    +
    maxRetries: number

    max count of retries after the first write fails

    +
    maxRetryDelay: number

    maximum delay when retrying write (milliseconds)

    +
    maxRetryTime: number

    max time (millis) that can be spent with retries

    +
    minRetryDelay: number

    minimum delay when retrying write (milliseconds)

    +
    randomRetry: boolean

    randomRetry indicates whether the next retry delay is deterministic (false) or random (true). The deterministic delay starts with minRetryDelay * exponentialBase and it is multiplied by exponentialBase until it exceeds maxRetryDelay. When random is true, the next delay is computed as a random number between next retry attempt (upper) and the lower number in the deterministic sequence. random(retryJitter) is added to every returned value.

    -
    retryJitter: number

    add random(retryJitter) milliseconds delay when retrying HTTP calls

    -

    Methods

    retryJitter: number

    add random(retryJitter) milliseconds delay when retrying HTTP calls

    +

    Methods

    • WriteFailed is called to inform about write errors.

      Parameters

      • this: WriteApi

        the instance of the API that failed

      • error: Error

        write error

      • lines: string[]

        failed lines

        @@ -30,10 +30,10 @@
      • expires: number

        expiration time for the lines to be retried in millis since epoch

      Returns void | Promise<void>

      a Promise to force the API to use it as a result of the flush operation, void/undefined to continue with default retry mechanism

      -
    • WriteRetrySkipped is informed about lines that were removed from the retry buffer +

    • WriteRetrySkipped is informed about lines that were removed from the retry buffer to keep the size of the retry buffer under the configured limit (maxBufferLines).

      Parameters

      • entry: { expires: number; lines: string[] }

        lines that were skipped

        -

      Returns void

    • WriteSuccess is informed about successfully written lines.

      +

    Returns void

    • WriteSuccess is informed about successfully written lines.

      Parameters

      • this: WriteApi

        the instance of the API in use

      • lines: string[]

        written lines

        -

      Returns void

    +

    Returns void

    diff --git a/media/CHANGELOG.md b/media/CHANGELOG.md index 191e0aa4..2fcde127 100644 --- a/media/CHANGELOG.md +++ b/media/CHANGELOG.md @@ -1,9 +1,5 @@ ## 1.36.0 [unreleased] -### Features: - -1.[1110](https://github.com/influxdata/influxdb-client-js/pull/1110) Change the document library to Typedoc - ## 1.35.0 [2024-08-15] ### Bug Fixes diff --git a/types/_influxdata_influxdb-client-apis.Authorization.html b/types/_influxdata_influxdb-client-apis.Authorization.html index f057d6b6..dabc383c 100644 --- a/types/_influxdata_influxdb-client-apis.Authorization.html +++ b/types/_influxdata_influxdb-client-apis.Authorization.html @@ -5,4 +5,4 @@
  • Optional Readonlytoken?: string

    The API token for authenticating InfluxDB API and CLI requests.

  • Optional ReadonlyupdatedAt?: string
  • Optional Readonlyuser?: string

    The name of the user that the token is scoped to.

  • Optional ReadonlyuserID?: string

    The ID of the user that the token is scoped to.

    -
  • +
    diff --git a/types/_influxdata_influxdb-client-apis.AuthorizationPostRequest.html b/types/_influxdata_influxdb-client-apis.AuthorizationPostRequest.html index 2e236a2a..6b63ab1d 100644 --- a/types/_influxdata_influxdb-client-apis.AuthorizationPostRequest.html +++ b/types/_influxdata_influxdb-client-apis.AuthorizationPostRequest.html @@ -2,4 +2,4 @@
  • Optionalpermissions?: Permission[]

    A list of permissions for an authorization. An authorization must have at least one permission.

  • OptionaluserID?: string

    The ID of the user that the authorization is scoped to.

    -
  • +
    diff --git a/types/_influxdata_influxdb-client-apis.AxisScale.html b/types/_influxdata_influxdb-client-apis.AxisScale.html index b35d95c0..1d64f192 100644 --- a/types/_influxdata_influxdb-client-apis.AxisScale.html +++ b/types/_influxdata_influxdb-client-apis.AxisScale.html @@ -1,2 +1,2 @@ AxisScale | Documentation
    AxisScale: "log" | "linear"

    Scale is the axis formatting scale. Supported: "log", "linear"

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.BucketMetadataManifests.html b/types/_influxdata_influxdb-client-apis.BucketMetadataManifests.html index 76ae1933..8001513a 100644 --- a/types/_influxdata_influxdb-client-apis.BucketMetadataManifests.html +++ b/types/_influxdata_influxdb-client-apis.BucketMetadataManifests.html @@ -1 +1 @@ -BucketMetadataManifests | Documentation
    +BucketMetadataManifests | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.BucketShardMappings.html b/types/_influxdata_influxdb-client-apis.BucketShardMappings.html index c0a13b29..edd89d2c 100644 --- a/types/_influxdata_influxdb-client-apis.BucketShardMappings.html +++ b/types/_influxdata_influxdb-client-apis.BucketShardMappings.html @@ -1 +1 @@ -BucketShardMappings | Documentation
    +BucketShardMappings | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.BuilderAggregateFunctionType.html b/types/_influxdata_influxdb-client-apis.BuilderAggregateFunctionType.html index acd417a1..3588b1da 100644 --- a/types/_influxdata_influxdb-client-apis.BuilderAggregateFunctionType.html +++ b/types/_influxdata_influxdb-client-apis.BuilderAggregateFunctionType.html @@ -1 +1 @@ -BuilderAggregateFunctionType | Documentation
    BuilderAggregateFunctionType: "filter" | "group"
    +BuilderAggregateFunctionType | Documentation
    BuilderAggregateFunctionType: "filter" | "group"
    diff --git a/types/_influxdata_influxdb-client-apis.CellWithViewProperties.html b/types/_influxdata_influxdb-client-apis.CellWithViewProperties.html index 4d4fb03d..8f7ba5ee 100644 --- a/types/_influxdata_influxdb-client-apis.CellWithViewProperties.html +++ b/types/_influxdata_influxdb-client-apis.CellWithViewProperties.html @@ -1 +1 @@ -CellWithViewProperties | Documentation
    CellWithViewProperties: Cell & { name?: string; properties?: ViewProperties }
    +CellWithViewProperties | Documentation
    CellWithViewProperties: Cell & { name?: string; properties?: ViewProperties }
    diff --git a/types/_influxdata_influxdb-client-apis.Cells.html b/types/_influxdata_influxdb-client-apis.Cells.html index 4c181f4c..24d908f3 100644 --- a/types/_influxdata_influxdb-client-apis.Cells.html +++ b/types/_influxdata_influxdb-client-apis.Cells.html @@ -1 +1 @@ -Cells | Documentation
    +Cells | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.CellsWithViewProperties.html b/types/_influxdata_influxdb-client-apis.CellsWithViewProperties.html index 093a3c7d..824b116b 100644 --- a/types/_influxdata_influxdb-client-apis.CellsWithViewProperties.html +++ b/types/_influxdata_influxdb-client-apis.CellsWithViewProperties.html @@ -1 +1 @@ -CellsWithViewProperties | Documentation
    +CellsWithViewProperties | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.Check.html b/types/_influxdata_influxdb-client-apis.Check.html index a3741535..98ea8962 100644 --- a/types/_influxdata_influxdb-client-apis.Check.html +++ b/types/_influxdata_influxdb-client-apis.Check.html @@ -1 +1 @@ -Check | Documentation
    +Check | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.CheckDiscriminator.html b/types/_influxdata_influxdb-client-apis.CheckDiscriminator.html index 862c7358..d64b9c73 100644 --- a/types/_influxdata_influxdb-client-apis.CheckDiscriminator.html +++ b/types/_influxdata_influxdb-client-apis.CheckDiscriminator.html @@ -1 +1 @@ -CheckDiscriminator | Documentation
    CheckDiscriminator:
        | DeadmanCheck & { type: string }
        | ThresholdCheck & { type: string }
        | CustomCheck & { type: string }
    +CheckDiscriminator | Documentation
    CheckDiscriminator:
        | DeadmanCheck & { type: string }
        | ThresholdCheck & { type: string }
        | CustomCheck & { type: string }
    diff --git a/types/_influxdata_influxdb-client-apis.CheckStatusLevel.html b/types/_influxdata_influxdb-client-apis.CheckStatusLevel.html index 9ad3933a..49820b9f 100644 --- a/types/_influxdata_influxdb-client-apis.CheckStatusLevel.html +++ b/types/_influxdata_influxdb-client-apis.CheckStatusLevel.html @@ -1,2 +1,2 @@ CheckStatusLevel | Documentation
    CheckStatusLevel: "UNKNOWN" | "OK" | "INFO" | "CRIT" | "WARN"

    The state to record if check matches a criteria.

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.ColorMapping.html b/types/_influxdata_influxdb-client-apis.ColorMapping.html index 9882c113..079e77c3 100644 --- a/types/_influxdata_influxdb-client-apis.ColorMapping.html +++ b/types/_influxdata_influxdb-client-apis.ColorMapping.html @@ -1,2 +1,2 @@ ColorMapping | Documentation
    ColorMapping: any

    A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.CustomCheck.html b/types/_influxdata_influxdb-client-apis.CustomCheck.html index ca2e31cb..6d26bbf4 100644 --- a/types/_influxdata_influxdb-client-apis.CustomCheck.html +++ b/types/_influxdata_influxdb-client-apis.CustomCheck.html @@ -1 +1 @@ -CustomCheck | Documentation
    CustomCheck: CheckBase & { type: "custom" }
    +CustomCheck | Documentation
    CustomCheck: CheckBase & { type: "custom" }
    diff --git a/types/_influxdata_influxdb-client-apis.Dashboard.html b/types/_influxdata_influxdb-client-apis.Dashboard.html index 7d8fbed1..9d1c18b4 100644 --- a/types/_influxdata_influxdb-client-apis.Dashboard.html +++ b/types/_influxdata_influxdb-client-apis.Dashboard.html @@ -1 +1 @@ -Dashboard | Documentation
    Dashboard: CreateDashboardRequest & {
        cells?: Cells;
        id?: string;
        labels?: Labels;
        links?: {
            cells?: Link;
            labels?: Link;
            members?: Link;
            org?: Link;
            owners?: Link;
            self?: Link;
        };
        meta?: { createdAt?: string; updatedAt?: string };
    }
    +Dashboard | Documentation
    Dashboard: CreateDashboardRequest & {
        cells?: Cells;
        id?: string;
        labels?: Labels;
        links?: {
            cells?: Link;
            labels?: Link;
            members?: Link;
            org?: Link;
            owners?: Link;
            self?: Link;
        };
        meta?: { createdAt?: string; updatedAt?: string };
    }
    diff --git a/types/_influxdata_influxdb-client-apis.DashboardWithViewProperties.html b/types/_influxdata_influxdb-client-apis.DashboardWithViewProperties.html index 3beaee05..db4b21f8 100644 --- a/types/_influxdata_influxdb-client-apis.DashboardWithViewProperties.html +++ b/types/_influxdata_influxdb-client-apis.DashboardWithViewProperties.html @@ -1 +1 @@ -DashboardWithViewProperties | Documentation
    DashboardWithViewProperties: CreateDashboardRequest & {
        cells?: CellsWithViewProperties;
        id?: string;
        labels?: Labels;
        links?: {
            cells?: Link;
            labels?: Link;
            members?: Link;
            org?: Link;
            owners?: Link;
            self?: Link;
        };
        meta?: { createdAt?: string; updatedAt?: string };
    }
    +DashboardWithViewProperties | Documentation
    DashboardWithViewProperties: CreateDashboardRequest & {
        cells?: CellsWithViewProperties;
        id?: string;
        labels?: Labels;
        links?: {
            cells?: Link;
            labels?: Link;
            members?: Link;
            org?: Link;
            owners?: Link;
            self?: Link;
        };
        meta?: { createdAt?: string; updatedAt?: string };
    }
    diff --git a/types/_influxdata_influxdb-client-apis.DeadmanCheck.html b/types/_influxdata_influxdb-client-apis.DeadmanCheck.html index 22fa6c90..036eaba6 100644 --- a/types/_influxdata_influxdb-client-apis.DeadmanCheck.html +++ b/types/_influxdata_influxdb-client-apis.DeadmanCheck.html @@ -5,4 +5,4 @@
  • OptionalstatusMessageTemplate?: string

    The template used to generate and write a status message.

  • Optionaltags?: { key?: string; value?: string }[]

    List of tags to write to each status.

  • OptionaltimeSince?: string

    String duration before deadman triggers.

    -
  • type: "deadman"
  • +
  • type: "deadman"
  • diff --git a/types/_influxdata_influxdb-client-apis.Expression.html b/types/_influxdata_influxdb-client-apis.Expression.html index feda19b3..3f55c4b4 100644 --- a/types/_influxdata_influxdb-client-apis.Expression.html +++ b/types/_influxdata_influxdb-client-apis.Expression.html @@ -1 +1 @@ -Expression | Documentation
    +Expression | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.Flags.html b/types/_influxdata_influxdb-client-apis.Flags.html index 1803afc9..3545f3fa 100644 --- a/types/_influxdata_influxdb-client-apis.Flags.html +++ b/types/_influxdata_influxdb-client-apis.Flags.html @@ -1 +1 @@ -Flags | Documentation
    +Flags | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.GeoCircleViewLayer.html b/types/_influxdata_influxdb-client-apis.GeoCircleViewLayer.html index f7c2fe63..ceaaa72c 100644 --- a/types/_influxdata_influxdb-client-apis.GeoCircleViewLayer.html +++ b/types/_influxdata_influxdb-client-apis.GeoCircleViewLayer.html @@ -3,4 +3,4 @@
  • OptionalinterpolateColors?: boolean

    Interpolate circle color based on displayed value

  • Optionalradius?: number

    Maximum radius size in pixels

  • radiusDimension: Axis
  • radiusField: string

    Radius field

    -
  • +
    diff --git a/types/_influxdata_influxdb-client-apis.GeoHeatMapViewLayer.html b/types/_influxdata_influxdb-client-apis.GeoHeatMapViewLayer.html index 6a7dc663..cb8d278b 100644 --- a/types/_influxdata_influxdb-client-apis.GeoHeatMapViewLayer.html +++ b/types/_influxdata_influxdb-client-apis.GeoHeatMapViewLayer.html @@ -2,4 +2,4 @@
  • colors: DashboardColor[]

    Colors define color encoding of data into a visualization

  • intensityDimension: Axis
  • intensityField: string

    Intensity field

  • radius: number

    Radius size in pixels

    -
  • +
    diff --git a/types/_influxdata_influxdb-client-apis.GeoPointMapViewLayer.html b/types/_influxdata_influxdb-client-apis.GeoPointMapViewLayer.html index d0957fde..23a0fb43 100644 --- a/types/_influxdata_influxdb-client-apis.GeoPointMapViewLayer.html +++ b/types/_influxdata_influxdb-client-apis.GeoPointMapViewLayer.html @@ -2,4 +2,4 @@
  • colors: DashboardColor[]

    Colors define color encoding of data into a visualization

  • OptionalisClustered?: boolean

    Cluster close markers together

  • OptionaltooltipColumns?: string[]

    An array for which columns to display in tooltip

    -
  • +
    diff --git a/types/_influxdata_influxdb-client-apis.GeoTrackMapViewLayer.html b/types/_influxdata_influxdb-client-apis.GeoTrackMapViewLayer.html index 21bb01ce..5c5a7015 100644 --- a/types/_influxdata_influxdb-client-apis.GeoTrackMapViewLayer.html +++ b/types/_influxdata_influxdb-client-apis.GeoTrackMapViewLayer.html @@ -1 +1 @@ -GeoTrackMapViewLayer | Documentation
    +GeoTrackMapViewLayer | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.GeoViewLayer.html b/types/_influxdata_influxdb-client-apis.GeoViewLayer.html index 04e2972d..a1b51f68 100644 --- a/types/_influxdata_influxdb-client-apis.GeoViewLayer.html +++ b/types/_influxdata_influxdb-client-apis.GeoViewLayer.html @@ -1 +1 @@ -GeoViewLayer | Documentation
    +GeoViewLayer | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.GreaterThreshold.html b/types/_influxdata_influxdb-client-apis.GreaterThreshold.html index 0dc4d2d5..96ea806c 100644 --- a/types/_influxdata_influxdb-client-apis.GreaterThreshold.html +++ b/types/_influxdata_influxdb-client-apis.GreaterThreshold.html @@ -1 +1 @@ -GreaterThreshold | Documentation
    GreaterThreshold: ThresholdBase & { type: "greater"; value: number }
    +GreaterThreshold | Documentation
    GreaterThreshold: ThresholdBase & { type: "greater"; value: number }
    diff --git a/types/_influxdata_influxdb-client-apis.HTTPNotificationEndpoint.html b/types/_influxdata_influxdb-client-apis.HTTPNotificationEndpoint.html index d9ace741..372de85c 100644 --- a/types/_influxdata_influxdb-client-apis.HTTPNotificationEndpoint.html +++ b/types/_influxdata_influxdb-client-apis.HTTPNotificationEndpoint.html @@ -1,2 +1,2 @@ HTTPNotificationEndpoint | Documentation
    HTTPNotificationEndpoint: NotificationEndpointBase & {
        authMethod: "none" | "basic" | "bearer";
        contentTemplate?: string;
        headers?: any;
        method: "POST" | "GET" | "PUT";
        password?: string;
        token?: string;
        url: string;
        username?: string;
    }

    Type declaration

    • authMethod: "none" | "basic" | "bearer"
    • OptionalcontentTemplate?: string
    • Optionalheaders?: any

      Customized headers.

      -
    • method: "POST" | "GET" | "PUT"
    • Optionalpassword?: string
    • Optionaltoken?: string
    • url: string
    • Optionalusername?: string
    +
  • method: "POST" | "GET" | "PUT"
  • Optionalpassword?: string
  • Optionaltoken?: string
  • url: string
  • Optionalusername?: string
  • diff --git a/types/_influxdata_influxdb-client-apis.HTTPNotificationRule.html b/types/_influxdata_influxdb-client-apis.HTTPNotificationRule.html index f4eb1ca8..9fa88f02 100644 --- a/types/_influxdata_influxdb-client-apis.HTTPNotificationRule.html +++ b/types/_influxdata_influxdb-client-apis.HTTPNotificationRule.html @@ -1 +1 @@ -HTTPNotificationRule | Documentation
    +HTTPNotificationRule | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.Labels.html b/types/_influxdata_influxdb-client-apis.Labels.html index 87eff695..b1d56706 100644 --- a/types/_influxdata_influxdb-client-apis.Labels.html +++ b/types/_influxdata_influxdb-client-apis.Labels.html @@ -1 +1 @@ -Labels | Documentation
    +Labels | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.LesserThreshold.html b/types/_influxdata_influxdb-client-apis.LesserThreshold.html index 25e579ca..f638e4cd 100644 --- a/types/_influxdata_influxdb-client-apis.LesserThreshold.html +++ b/types/_influxdata_influxdb-client-apis.LesserThreshold.html @@ -1 +1 @@ -LesserThreshold | Documentation
    LesserThreshold: ThresholdBase & { type: "lesser"; value: number }
    +LesserThreshold | Documentation
    LesserThreshold: ThresholdBase & { type: "lesser"; value: number }
    diff --git a/types/_influxdata_influxdb-client-apis.Link.html b/types/_influxdata_influxdb-client-apis.Link.html index eb62b000..d4c5a419 100644 --- a/types/_influxdata_influxdb-client-apis.Link.html +++ b/types/_influxdata_influxdb-client-apis.Link.html @@ -1,2 +1,2 @@ Link | Documentation
    Link: string

    URI of resource.

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.Node.html b/types/_influxdata_influxdb-client-apis.Node.html index 3ff3b0b2..761e25cd 100644 --- a/types/_influxdata_influxdb-client-apis.Node.html +++ b/types/_influxdata_influxdb-client-apis.Node.html @@ -1 +1 @@ -Node | Documentation
    +Node | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.NodeType.html b/types/_influxdata_influxdb-client-apis.NodeType.html index 982c7e57..02ec57a8 100644 --- a/types/_influxdata_influxdb-client-apis.NodeType.html +++ b/types/_influxdata_influxdb-client-apis.NodeType.html @@ -1,2 +1,2 @@ NodeType | Documentation
    NodeType: string

    Type of AST node

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.NotificationEndpoint.html b/types/_influxdata_influxdb-client-apis.NotificationEndpoint.html index 211a276a..1ec0e883 100644 --- a/types/_influxdata_influxdb-client-apis.NotificationEndpoint.html +++ b/types/_influxdata_influxdb-client-apis.NotificationEndpoint.html @@ -1 +1 @@ -NotificationEndpoint | Documentation
    +NotificationEndpoint | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.NotificationEndpointDiscriminator.html b/types/_influxdata_influxdb-client-apis.NotificationEndpointDiscriminator.html index 635b1d10..a9ecc416 100644 --- a/types/_influxdata_influxdb-client-apis.NotificationEndpointDiscriminator.html +++ b/types/_influxdata_influxdb-client-apis.NotificationEndpointDiscriminator.html @@ -1 +1 @@ -NotificationEndpointDiscriminator | Documentation
    NotificationEndpointDiscriminator:
        | SlackNotificationEndpoint & { type: string }
        | PagerDutyNotificationEndpoint & { type: string }
        | HTTPNotificationEndpoint & { type: string }
        | TelegramNotificationEndpoint & { type: string }
    +NotificationEndpointDiscriminator | Documentation
    NotificationEndpointDiscriminator:
        | SlackNotificationEndpoint & { type: string }
        | PagerDutyNotificationEndpoint & { type: string }
        | HTTPNotificationEndpoint & { type: string }
        | TelegramNotificationEndpoint & { type: string }
    diff --git a/types/_influxdata_influxdb-client-apis.NotificationEndpointType.html b/types/_influxdata_influxdb-client-apis.NotificationEndpointType.html index 064e19c6..1ab4f49f 100644 --- a/types/_influxdata_influxdb-client-apis.NotificationEndpointType.html +++ b/types/_influxdata_influxdb-client-apis.NotificationEndpointType.html @@ -1 +1 @@ -NotificationEndpointType | Documentation
    NotificationEndpointType: "slack" | "pagerduty" | "http" | "telegram"
    +NotificationEndpointType | Documentation
    NotificationEndpointType: "slack" | "pagerduty" | "http" | "telegram"
    diff --git a/types/_influxdata_influxdb-client-apis.NotificationRule.html b/types/_influxdata_influxdb-client-apis.NotificationRule.html index 42f04f50..cefa74fa 100644 --- a/types/_influxdata_influxdb-client-apis.NotificationRule.html +++ b/types/_influxdata_influxdb-client-apis.NotificationRule.html @@ -1 +1 @@ -NotificationRule | Documentation
    +NotificationRule | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.NotificationRuleDiscriminator.html b/types/_influxdata_influxdb-client-apis.NotificationRuleDiscriminator.html index b9e2b118..2cae033c 100644 --- a/types/_influxdata_influxdb-client-apis.NotificationRuleDiscriminator.html +++ b/types/_influxdata_influxdb-client-apis.NotificationRuleDiscriminator.html @@ -1 +1 @@ -NotificationRuleDiscriminator | Documentation
    NotificationRuleDiscriminator:
        | SlackNotificationRule & { type: string }
        | SMTPNotificationRule & { type: string }
        | PagerDutyNotificationRule & { type: string }
        | HTTPNotificationRule & { type: string }
        | TelegramNotificationRule & { type: string }
    +NotificationRuleDiscriminator | Documentation
    NotificationRuleDiscriminator:
        | SlackNotificationRule & { type: string }
        | SMTPNotificationRule & { type: string }
        | PagerDutyNotificationRule & { type: string }
        | HTTPNotificationRule & { type: string }
        | TelegramNotificationRule & { type: string }
    diff --git a/types/_influxdata_influxdb-client-apis.PagerDutyNotificationEndpoint.html b/types/_influxdata_influxdb-client-apis.PagerDutyNotificationEndpoint.html index c39198af..7e099d8e 100644 --- a/types/_influxdata_influxdb-client-apis.PagerDutyNotificationEndpoint.html +++ b/types/_influxdata_influxdb-client-apis.PagerDutyNotificationEndpoint.html @@ -1 +1 @@ -PagerDutyNotificationEndpoint | Documentation
    PagerDutyNotificationEndpoint: NotificationEndpointBase & {
        clientURL?: string;
        routingKey: string;
    }
    +PagerDutyNotificationEndpoint | Documentation
    PagerDutyNotificationEndpoint: NotificationEndpointBase & {
        clientURL?: string;
        routingKey: string;
    }
    diff --git a/types/_influxdata_influxdb-client-apis.PagerDutyNotificationRule.html b/types/_influxdata_influxdb-client-apis.PagerDutyNotificationRule.html index 380824e1..ee2f854b 100644 --- a/types/_influxdata_influxdb-client-apis.PagerDutyNotificationRule.html +++ b/types/_influxdata_influxdb-client-apis.PagerDutyNotificationRule.html @@ -1 +1 @@ -PagerDutyNotificationRule | Documentation
    +PagerDutyNotificationRule | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.PatchRetentionRules.html b/types/_influxdata_influxdb-client-apis.PatchRetentionRules.html index 75b203a0..ec2983cb 100644 --- a/types/_influxdata_influxdb-client-apis.PatchRetentionRules.html +++ b/types/_influxdata_influxdb-client-apis.PatchRetentionRules.html @@ -1,2 +1,2 @@ PatchRetentionRules | Documentation
    PatchRetentionRules: PatchRetentionRule[]

    Updates to rules to expire or retain data. No rules means no updates.

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.PostCheck.html b/types/_influxdata_influxdb-client-apis.PostCheck.html index c0f79d26..2764877e 100644 --- a/types/_influxdata_influxdb-client-apis.PostCheck.html +++ b/types/_influxdata_influxdb-client-apis.PostCheck.html @@ -1 +1 @@ -PostCheck | Documentation
    +PostCheck | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.PostNotificationEndpoint.html b/types/_influxdata_influxdb-client-apis.PostNotificationEndpoint.html index 09db9d59..13bb161a 100644 --- a/types/_influxdata_influxdb-client-apis.PostNotificationEndpoint.html +++ b/types/_influxdata_influxdb-client-apis.PostNotificationEndpoint.html @@ -1 +1 @@ -PostNotificationEndpoint | Documentation
    +PostNotificationEndpoint | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.PostNotificationRule.html b/types/_influxdata_influxdb-client-apis.PostNotificationRule.html index f7feeab0..2a98af3e 100644 --- a/types/_influxdata_influxdb-client-apis.PostNotificationRule.html +++ b/types/_influxdata_influxdb-client-apis.PostNotificationRule.html @@ -1 +1 @@ -PostNotificationRule | Documentation
    +PostNotificationRule | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.PropertyKey.html b/types/_influxdata_influxdb-client-apis.PropertyKey.html index bd4a7376..eab497f1 100644 --- a/types/_influxdata_influxdb-client-apis.PropertyKey.html +++ b/types/_influxdata_influxdb-client-apis.PropertyKey.html @@ -1 +1 @@ -PropertyKey | Documentation
    +PropertyKey | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.QueryEditMode.html b/types/_influxdata_influxdb-client-apis.QueryEditMode.html index 7cd2c092..12650edd 100644 --- a/types/_influxdata_influxdb-client-apis.QueryEditMode.html +++ b/types/_influxdata_influxdb-client-apis.QueryEditMode.html @@ -1 +1 @@ -QueryEditMode | Documentation
    QueryEditMode: "builder" | "advanced"
    +QueryEditMode | Documentation
    QueryEditMode: "builder" | "advanced"
    diff --git a/types/_influxdata_influxdb-client-apis.RangeThreshold.html b/types/_influxdata_influxdb-client-apis.RangeThreshold.html index dd28ed12..326f43b4 100644 --- a/types/_influxdata_influxdb-client-apis.RangeThreshold.html +++ b/types/_influxdata_influxdb-client-apis.RangeThreshold.html @@ -1 +1 @@ -RangeThreshold | Documentation
    RangeThreshold: ThresholdBase & {
        max: number;
        min: number;
        type: "range";
        within: boolean;
    }
    +RangeThreshold | Documentation
    RangeThreshold: ThresholdBase & {
        max: number;
        min: number;
        type: "range";
        within: boolean;
    }
    diff --git a/types/_influxdata_influxdb-client-apis.ResourceMember.html b/types/_influxdata_influxdb-client-apis.ResourceMember.html index 7734cd39..4dbacd90 100644 --- a/types/_influxdata_influxdb-client-apis.ResourceMember.html +++ b/types/_influxdata_influxdb-client-apis.ResourceMember.html @@ -1 +1 @@ -ResourceMember | Documentation
    ResourceMember: UserResponse & { role?: "member" }
    +ResourceMember | Documentation
    ResourceMember: UserResponse & { role?: "member" }
    diff --git a/types/_influxdata_influxdb-client-apis.ResourceOwner.html b/types/_influxdata_influxdb-client-apis.ResourceOwner.html index c592e324..2df9f092 100644 --- a/types/_influxdata_influxdb-client-apis.ResourceOwner.html +++ b/types/_influxdata_influxdb-client-apis.ResourceOwner.html @@ -1 +1 @@ -ResourceOwner | Documentation
    ResourceOwner: UserResponse & { role?: "owner" }
    +ResourceOwner | Documentation
    ResourceOwner: UserResponse & { role?: "owner" }
    diff --git a/types/_influxdata_influxdb-client-apis.RetentionPolicyManifests.html b/types/_influxdata_influxdb-client-apis.RetentionPolicyManifests.html index 3d46749c..3a33bc97 100644 --- a/types/_influxdata_influxdb-client-apis.RetentionPolicyManifests.html +++ b/types/_influxdata_influxdb-client-apis.RetentionPolicyManifests.html @@ -1 +1 @@ -RetentionPolicyManifests | Documentation
    +RetentionPolicyManifests | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.RetentionRules.html b/types/_influxdata_influxdb-client-apis.RetentionRules.html index 7cfd1489..2b741e13 100644 --- a/types/_influxdata_influxdb-client-apis.RetentionRules.html +++ b/types/_influxdata_influxdb-client-apis.RetentionRules.html @@ -5,4 +5,4 @@ -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.RuleStatusLevel.html b/types/_influxdata_influxdb-client-apis.RuleStatusLevel.html index be23465e..7c6d4784 100644 --- a/types/_influxdata_influxdb-client-apis.RuleStatusLevel.html +++ b/types/_influxdata_influxdb-client-apis.RuleStatusLevel.html @@ -1,2 +1,2 @@ RuleStatusLevel | Documentation
    RuleStatusLevel: "UNKNOWN" | "OK" | "INFO" | "CRIT" | "WARN" | "ANY"

    The state to record if check matches a criteria.

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.SMTPNotificationRule.html b/types/_influxdata_influxdb-client-apis.SMTPNotificationRule.html index 8d7f0fc7..2eafaf1a 100644 --- a/types/_influxdata_influxdb-client-apis.SMTPNotificationRule.html +++ b/types/_influxdata_influxdb-client-apis.SMTPNotificationRule.html @@ -1 +1 @@ -SMTPNotificationRule | Documentation
    +SMTPNotificationRule | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.SchemaType.html b/types/_influxdata_influxdb-client-apis.SchemaType.html index 2e2db89a..d057f024 100644 --- a/types/_influxdata_influxdb-client-apis.SchemaType.html +++ b/types/_influxdata_influxdb-client-apis.SchemaType.html @@ -1 +1 @@ -SchemaType | Documentation
    SchemaType: "implicit" | "explicit"
    +SchemaType | Documentation
    SchemaType: "implicit" | "explicit"
    diff --git a/types/_influxdata_influxdb-client-apis.ScraperTargetResponse.html b/types/_influxdata_influxdb-client-apis.ScraperTargetResponse.html index bd60fdb7..c4c660c3 100644 --- a/types/_influxdata_influxdb-client-apis.ScraperTargetResponse.html +++ b/types/_influxdata_influxdb-client-apis.ScraperTargetResponse.html @@ -1,3 +1,3 @@ ScraperTargetResponse | Documentation
    ScraperTargetResponse: ScraperTargetRequest & {
        bucket?: string;
        id?: string;
        links?: {
            bucket?: Link;
            members?: Link;
            organization?: Link;
            owners?: Link;
            self?: Link;
        };
        org?: string;
    }

    Type declaration

    • Optionalbucket?: string

      The bucket name.

    • Optional Readonlyid?: string
    • Optional Readonlylinks?: {
          bucket?: Link;
          members?: Link;
          organization?: Link;
          owners?: Link;
          self?: Link;
      }
    • Optionalorg?: string

      The name of the organization.

      -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.ScriptHTTPResponseData.html b/types/_influxdata_influxdb-client-apis.ScriptHTTPResponseData.html index 576a4694..5c6e3608 100644 --- a/types/_influxdata_influxdb-client-apis.ScriptHTTPResponseData.html +++ b/types/_influxdata_influxdb-client-apis.ScriptHTTPResponseData.html @@ -1,3 +1,3 @@ ScriptHTTPResponseData | Documentation
    ScriptHTTPResponseData: string

    The response body contains the results of the executed script. The response is user-defined and dynamic.

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.ScriptLanguage.html b/types/_influxdata_influxdb-client-apis.ScriptLanguage.html index fb4bc01d..282f11bf 100644 --- a/types/_influxdata_influxdb-client-apis.ScriptLanguage.html +++ b/types/_influxdata_influxdb-client-apis.ScriptLanguage.html @@ -1 +1 @@ -ScriptLanguage | Documentation
    +ScriptLanguage | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.SecretKeysResponse.html b/types/_influxdata_influxdb-client-apis.SecretKeysResponse.html index df8bbb1c..4caf0b28 100644 --- a/types/_influxdata_influxdb-client-apis.SecretKeysResponse.html +++ b/types/_influxdata_influxdb-client-apis.SecretKeysResponse.html @@ -1 +1 @@ -SecretKeysResponse | Documentation
    SecretKeysResponse: SecretKeys & { links?: { org?: string; self?: string } }
    +SecretKeysResponse | Documentation
    SecretKeysResponse: SecretKeys & { links?: { org?: string; self?: string } }
    diff --git a/types/_influxdata_influxdb-client-apis.Secrets.html b/types/_influxdata_influxdb-client-apis.Secrets.html index 244e84a0..abdf8879 100644 --- a/types/_influxdata_influxdb-client-apis.Secrets.html +++ b/types/_influxdata_influxdb-client-apis.Secrets.html @@ -1 +1 @@ -Secrets | Documentation
    +Secrets | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.ShardGroupManifests.html b/types/_influxdata_influxdb-client-apis.ShardGroupManifests.html index d3823832..089b6524 100644 --- a/types/_influxdata_influxdb-client-apis.ShardGroupManifests.html +++ b/types/_influxdata_influxdb-client-apis.ShardGroupManifests.html @@ -1 +1 @@ -ShardGroupManifests | Documentation
    +ShardGroupManifests | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.ShardManifests.html b/types/_influxdata_influxdb-client-apis.ShardManifests.html index d5211365..6c0d1b93 100644 --- a/types/_influxdata_influxdb-client-apis.ShardManifests.html +++ b/types/_influxdata_influxdb-client-apis.ShardManifests.html @@ -1 +1 @@ -ShardManifests | Documentation
    +ShardManifests | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.ShardOwners.html b/types/_influxdata_influxdb-client-apis.ShardOwners.html index dbb34aea..f66d73bf 100644 --- a/types/_influxdata_influxdb-client-apis.ShardOwners.html +++ b/types/_influxdata_influxdb-client-apis.ShardOwners.html @@ -1 +1 @@ -ShardOwners | Documentation
    +ShardOwners | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.SlackNotificationEndpoint.html b/types/_influxdata_influxdb-client-apis.SlackNotificationEndpoint.html index ba7e05ff..c676b454 100644 --- a/types/_influxdata_influxdb-client-apis.SlackNotificationEndpoint.html +++ b/types/_influxdata_influxdb-client-apis.SlackNotificationEndpoint.html @@ -1,3 +1,3 @@ SlackNotificationEndpoint | Documentation
    SlackNotificationEndpoint: NotificationEndpointBase & {
        token?: string;
        url?: string;
    }

    Type declaration

    • Optionaltoken?: string

      Specifies the API token string. Specify either URL or Token.

    • Optionalurl?: string

      Specifies the URL of the Slack endpoint. Specify either URL or Token.

      -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.SlackNotificationRule.html b/types/_influxdata_influxdb-client-apis.SlackNotificationRule.html index abb31485..672a7a9a 100644 --- a/types/_influxdata_influxdb-client-apis.SlackNotificationRule.html +++ b/types/_influxdata_influxdb-client-apis.SlackNotificationRule.html @@ -1 +1 @@ -SlackNotificationRule | Documentation
    +SlackNotificationRule | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.Statement.html b/types/_influxdata_influxdb-client-apis.Statement.html index 3fcfb2af..7956e238 100644 --- a/types/_influxdata_influxdb-client-apis.Statement.html +++ b/types/_influxdata_influxdb-client-apis.Statement.html @@ -1 +1 @@ -Statement | Documentation
    +Statement | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.SubscriptionManifests.html b/types/_influxdata_influxdb-client-apis.SubscriptionManifests.html index f6fed745..d7fc6dec 100644 --- a/types/_influxdata_influxdb-client-apis.SubscriptionManifests.html +++ b/types/_influxdata_influxdb-client-apis.SubscriptionManifests.html @@ -1 +1 @@ -SubscriptionManifests | Documentation
    +SubscriptionManifests | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.TaskStatusType.html b/types/_influxdata_influxdb-client-apis.TaskStatusType.html index f57ad4db..b8fac9f9 100644 --- a/types/_influxdata_influxdb-client-apis.TaskStatusType.html +++ b/types/_influxdata_influxdb-client-apis.TaskStatusType.html @@ -1,2 +1,2 @@ TaskStatusType | Documentation
    TaskStatusType: "active" | "inactive"

    inactive cancels scheduled runs and prevents manual runs of the task.

    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.Telegraf.html b/types/_influxdata_influxdb-client-apis.Telegraf.html index 565ab1f7..1c8c1a7e 100644 --- a/types/_influxdata_influxdb-client-apis.Telegraf.html +++ b/types/_influxdata_influxdb-client-apis.Telegraf.html @@ -1 +1 @@ -Telegraf | Documentation
    Telegraf: TelegrafRequest & {
        id?: string;
        labels?: Labels;
        links?: { labels?: Link; members?: Link; owners?: Link; self?: Link };
    }
    +Telegraf | Documentation
    Telegraf: TelegrafRequest & {
        id?: string;
        labels?: Labels;
        links?: { labels?: Link; members?: Link; owners?: Link; self?: Link };
    }
    diff --git a/types/_influxdata_influxdb-client-apis.TelegramNotificationEndpoint.html b/types/_influxdata_influxdb-client-apis.TelegramNotificationEndpoint.html index 5f07ddc2..b9149740 100644 --- a/types/_influxdata_influxdb-client-apis.TelegramNotificationEndpoint.html +++ b/types/_influxdata_influxdb-client-apis.TelegramNotificationEndpoint.html @@ -1,3 +1,3 @@ TelegramNotificationEndpoint | Documentation
    TelegramNotificationEndpoint: NotificationEndpointBase & {
        channel: string;
        token: string;
    }

    Type declaration

    +
    diff --git a/types/_influxdata_influxdb-client-apis.TelegramNotificationRule.html b/types/_influxdata_influxdb-client-apis.TelegramNotificationRule.html index 254787cf..8c726a9c 100644 --- a/types/_influxdata_influxdb-client-apis.TelegramNotificationRule.html +++ b/types/_influxdata_influxdb-client-apis.TelegramNotificationRule.html @@ -1 +1 @@ -TelegramNotificationRule | Documentation
    +TelegramNotificationRule | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.Template.html b/types/_influxdata_influxdb-client-apis.Template.html index 6a5f8303..b8939dd2 100644 --- a/types/_influxdata_influxdb-client-apis.Template.html +++ b/types/_influxdata_influxdb-client-apis.Template.html @@ -14,4 +14,4 @@
    { "spec": {
    "language": "flux",
    "name": "Node_Service",
    "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\",
    tag: \"service\")",
    "type": "query"
    }
    }
    -
    +
    diff --git a/types/_influxdata_influxdb-client-apis.TemplateEnvReferences.html b/types/_influxdata_influxdb-client-apis.TemplateEnvReferences.html index 955b60da..d643a1e0 100644 --- a/types/_influxdata_influxdb-client-apis.TemplateEnvReferences.html +++ b/types/_influxdata_influxdb-client-apis.TemplateEnvReferences.html @@ -2,4 +2,4 @@
  • envRefKey: string

    Key identified as environment reference and is the key identified in the template

  • resourceField: string

    Field the environment reference corresponds too

  • Optionalvalue?: string | number | number | boolean

    Value provided to fulfill reference

    -
  • +
    diff --git a/types/_influxdata_influxdb-client-apis.TemplateKind.html b/types/_influxdata_influxdb-client-apis.TemplateKind.html index d4736617..63d2ea06 100644 --- a/types/_influxdata_influxdb-client-apis.TemplateKind.html +++ b/types/_influxdata_influxdb-client-apis.TemplateKind.html @@ -1 +1 @@ -TemplateKind | Documentation
    TemplateKind:
        | "Bucket"
        | "Check"
        | "CheckDeadman"
        | "CheckThreshold"
        | "Dashboard"
        | "Label"
        | "NotificationEndpoint"
        | "NotificationEndpointHTTP"
        | "NotificationEndpointPagerDuty"
        | "NotificationEndpointSlack"
        | "NotificationRule"
        | "Task"
        | "Telegraf"
        | "Variable"
    +TemplateKind | Documentation
    TemplateKind:
        | "Bucket"
        | "Check"
        | "CheckDeadman"
        | "CheckThreshold"
        | "Dashboard"
        | "Label"
        | "NotificationEndpoint"
        | "NotificationEndpointHTTP"
        | "NotificationEndpointPagerDuty"
        | "NotificationEndpointSlack"
        | "NotificationRule"
        | "Task"
        | "Telegraf"
        | "Variable"
    diff --git a/types/_influxdata_influxdb-client-apis.Threshold.html b/types/_influxdata_influxdb-client-apis.Threshold.html index 192c05ad..6b4dac1a 100644 --- a/types/_influxdata_influxdb-client-apis.Threshold.html +++ b/types/_influxdata_influxdb-client-apis.Threshold.html @@ -1 +1 @@ -Threshold | Documentation
    Threshold:
        | GreaterThreshold & { type: string }
        | LesserThreshold & { type: string }
        | RangeThreshold & { type: string }
    +Threshold | Documentation
    Threshold:
        | GreaterThreshold & { type: string }
        | LesserThreshold & { type: string }
        | RangeThreshold & { type: string }
    diff --git a/types/_influxdata_influxdb-client-apis.ThresholdCheck.html b/types/_influxdata_influxdb-client-apis.ThresholdCheck.html index fa2886f2..779d7aca 100644 --- a/types/_influxdata_influxdb-client-apis.ThresholdCheck.html +++ b/types/_influxdata_influxdb-client-apis.ThresholdCheck.html @@ -2,4 +2,4 @@
  • Optionaloffset?: string

    Duration to delay after the schedule, before executing check.

  • OptionalstatusMessageTemplate?: string

    The template used to generate and write a status message.

  • Optionaltags?: { key?: string; value?: string }[]

    List of tags to write to each status.

    -
  • Optionalthresholds?: Threshold[]
  • type: "threshold"
  • +
  • Optionalthresholds?: Threshold[]
  • type: "threshold"
  • diff --git a/types/_influxdata_influxdb-client-apis.VariableProperties.html b/types/_influxdata_influxdb-client-apis.VariableProperties.html index c08a730e..fe219d5f 100644 --- a/types/_influxdata_influxdb-client-apis.VariableProperties.html +++ b/types/_influxdata_influxdb-client-apis.VariableProperties.html @@ -1 +1 @@ -VariableProperties | Documentation
    +VariableProperties | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.ViewProperties.html b/types/_influxdata_influxdb-client-apis.ViewProperties.html index 4a2d52e6..bab9d077 100644 --- a/types/_influxdata_influxdb-client-apis.ViewProperties.html +++ b/types/_influxdata_influxdb-client-apis.ViewProperties.html @@ -1 +1 @@ -ViewProperties | Documentation
    +ViewProperties | Documentation
    diff --git a/types/_influxdata_influxdb-client-apis.XYGeom.html b/types/_influxdata_influxdb-client-apis.XYGeom.html index 726ff836..cd543e0d 100644 --- a/types/_influxdata_influxdb-client-apis.XYGeom.html +++ b/types/_influxdata_influxdb-client-apis.XYGeom.html @@ -1 +1 @@ -XYGeom | Documentation
    XYGeom:
        | "line"
        | "step"
        | "stacked"
        | "bar"
        | "monotoneX"
        | "stepBefore"
        | "stepAfter"
    +XYGeom | Documentation
    XYGeom:
        | "line"
        | "step"
        | "stacked"
        | "bar"
        | "monotoneX"
        | "stepBefore"
        | "stepAfter"
    diff --git a/types/_influxdata_influxdb-client-giraffe.AcceptRowFunction.html b/types/_influxdata_influxdb-client-giraffe.AcceptRowFunction.html index b4ea7e68..a067311f 100644 --- a/types/_influxdata_influxdb-client-giraffe.AcceptRowFunction.html +++ b/types/_influxdata_influxdb-client-giraffe.AcceptRowFunction.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/types/_influxdata_influxdb-client-giraffe.GiraffeTableFactory.html b/types/_influxdata_influxdb-client-giraffe.GiraffeTableFactory.html index f387afb6..fb0a8dc4 100644 --- a/types/_influxdata_influxdb-client-giraffe.GiraffeTableFactory.html +++ b/types/_influxdata_influxdb-client-giraffe.GiraffeTableFactory.html @@ -1,2 +1,2 @@ GiraffeTableFactory | Documentation
    GiraffeTableFactory: (length: number) => Table

    A type of a function that creates a new giraffe table of a specified length

    -

    Type declaration

      • (length: number): Table
      • Parameters

        • length: number

        Returns Table

    +

    Type declaration

    diff --git a/types/_influxdata_influxdb-client.APIExecutor.html b/types/_influxdata_influxdb-client.APIExecutor.html index 60bdc30f..3a9e3522 100644 --- a/types/_influxdata_influxdb-client.APIExecutor.html +++ b/types/_influxdata_influxdb-client.APIExecutor.html @@ -1,2 +1,2 @@ APIExecutor | Documentation
    APIExecutor: (consumer: CommunicationObserver<Uint8Array>) => void

    APIExecutor executes the API and passes its response to the supplied consumer

    -

    Type declaration

    +

    Type declaration

    diff --git a/types/_influxdata_influxdb-client.ColumnType.html b/types/_influxdata_influxdb-client.ColumnType.html index 2c73f0ef..7ec8a254 100644 --- a/types/_influxdata_influxdb-client.ColumnType.html +++ b/types/_influxdata_influxdb-client.ColumnType.html @@ -1,2 +1,2 @@ ColumnType | Documentation
    ColumnType:
        | "boolean"
        | "unsignedLong"
        | "long"
        | "double"
        | "string"
        | "base64Binary"
        | "dateTime:RFC3339"
        | "duration"
        | string
    +
    diff --git a/types/_influxdata_influxdb-client.HttpHeaders.html b/types/_influxdata_influxdb-client.HttpHeaders.html index 379653b6..4abc3876 100644 --- a/types/_influxdata_influxdb-client.HttpHeaders.html +++ b/types/_influxdata_influxdb-client.HttpHeaders.html @@ -1,2 +1,2 @@ HttpHeaders | Documentation
    HttpHeaders: { [header: string]: undefined | string | string[] }

    Type of HTTP headers.

    -

    Type declaration

    • [header: string]: undefined | string | string[]
    +

    Type declaration

    diff --git a/types/_influxdata_influxdb-client.IterableResultExecutor.html b/types/_influxdata_influxdb-client.IterableResultExecutor.html index 079eb7cb..81067c3a 100644 --- a/types/_influxdata_influxdb-client.IterableResultExecutor.html +++ b/types/_influxdata_influxdb-client.IterableResultExecutor.html @@ -1,2 +1,2 @@ IterableResultExecutor | Documentation
    IterableResultExecutor: () => AsyncIterable<Uint8Array>

    A factory that returns async iterables.

    -

    Type declaration

      • (): AsyncIterable<Uint8Array>
      • Returns AsyncIterable<Uint8Array>

    +

    Type declaration

    diff --git a/types/_influxdata_influxdb-client.ObserverComplete.html b/types/_influxdata_influxdb-client.ObserverComplete.html index 45af5dac..0f40718d 100644 --- a/types/_influxdata_influxdb-client.ObserverComplete.html +++ b/types/_influxdata_influxdb-client.ObserverComplete.html @@ -1,2 +1,2 @@ ObserverComplete | Documentation
    ObserverComplete: () => void

    Type declaration

      • (): void
      • Returns void

    +

    Type declaration

    diff --git a/types/_influxdata_influxdb-client.ObserverError.html b/types/_influxdata_influxdb-client.ObserverError.html index 4649356b..fb0c1920 100644 --- a/types/_influxdata_influxdb-client.ObserverError.html +++ b/types/_influxdata_influxdb-client.ObserverError.html @@ -1,2 +1,2 @@ ObserverError | Documentation
    ObserverError: (e: any) => void

    Type of Observer.error

    -

    Type declaration

      • (e: any): void
      • Parameters

        • e: any

        Returns void

    +

    Type declaration

    diff --git a/types/_influxdata_influxdb-client.ObserverNext.html b/types/_influxdata_influxdb-client.ObserverNext.html index 14218847..740933f6 100644 --- a/types/_influxdata_influxdb-client.ObserverNext.html +++ b/types/_influxdata_influxdb-client.ObserverNext.html @@ -1,2 +1,2 @@ ObserverNext | Documentation
    ObserverNext: (value: T) => void

    Type of Observer.next

    -

    Type Parameters

    • T

    Type declaration

      • (value: T): void
      • Parameters

        • value: T

        Returns void

    +

    Type Parameters

    Type declaration

    diff --git a/types/_influxdata_influxdb-client.ResponseStartedFn.html b/types/_influxdata_influxdb-client.ResponseStartedFn.html index 2025f4f0..6f0795dc 100644 --- a/types/_influxdata_influxdb-client.ResponseStartedFn.html +++ b/types/_influxdata_influxdb-client.ResponseStartedFn.html @@ -1,4 +1,4 @@ ResponseStartedFn | Documentation
    ResponseStartedFn: (headers: HttpHeaders, statusCode?: number) => void

    Informs about a start of response processing.

    Type declaration

      • (headers: HttpHeaders, statusCode?: number): void
      • Parameters

        • headers: HttpHeaders

          response HTTP headers

        • OptionalstatusCode: number

          response status code

          -

        Returns void

    +

    Returns void

    diff --git a/types/_influxdata_influxdb-client.WritePrecisionType.html b/types/_influxdata_influxdb-client.WritePrecisionType.html index 864947d4..bf6258e9 100644 --- a/types/_influxdata_influxdb-client.WritePrecisionType.html +++ b/types/_influxdata_influxdb-client.WritePrecisionType.html @@ -1,3 +1,3 @@ WritePrecisionType | Documentation
    WritePrecisionType: "ns" | "us" | "ms" | "s"

    Timestamp precision used in write operations. See https://docs.influxdata.com/influxdb/latest/api/#operation/PostWrite

    -
    +
    diff --git a/variables/_influxdata_influxdb-client-giraffe.QUERY_MAX_TABLE_LENGTH.html b/variables/_influxdata_influxdb-client-giraffe.QUERY_MAX_TABLE_LENGTH.html index 2d25142f..32bf4aff 100644 --- a/variables/_influxdata_influxdb-client-giraffe.QUERY_MAX_TABLE_LENGTH.html +++ b/variables/_influxdata_influxdb-client-giraffe.QUERY_MAX_TABLE_LENGTH.html @@ -1,3 +1,3 @@ QUERY_MAX_TABLE_LENGTH | Documentation
    QUERY_MAX_TABLE_LENGTH: 100000 = 100_000

    QUERY_MAX_TABLE_LENGTH is a default max table length, it can be overriden in TableOptions.

    -
    +
    diff --git a/variables/_influxdata_influxdb-client.DEFAULT_ConnectionOptions.html b/variables/_influxdata_influxdb-client.DEFAULT_ConnectionOptions.html index e5a5790a..9d7af5b9 100644 --- a/variables/_influxdata_influxdb-client.DEFAULT_ConnectionOptions.html +++ b/variables/_influxdata_influxdb-client.DEFAULT_ConnectionOptions.html @@ -1,2 +1,2 @@ DEFAULT_ConnectionOptions | Documentation
    DEFAULT_ConnectionOptions: Partial<ConnectionOptions> = ...

    default connection options

    -
    +
    diff --git a/variables/_influxdata_influxdb-client.DEFAULT_RetryDelayStrategyOptions.html b/variables/_influxdata_influxdb-client.DEFAULT_RetryDelayStrategyOptions.html index 7b425b10..7b32a8d8 100644 --- a/variables/_influxdata_influxdb-client.DEFAULT_RetryDelayStrategyOptions.html +++ b/variables/_influxdata_influxdb-client.DEFAULT_RetryDelayStrategyOptions.html @@ -1,2 +1,2 @@ DEFAULT_RetryDelayStrategyOptions | Documentation
    DEFAULT_RetryDelayStrategyOptions: {
        exponentialBase: number;
        maxRetryDelay: number;
        minRetryDelay: number;
        randomRetry: boolean;
        retryJitter: number;
    } = ...

    default RetryDelayStrategyOptions

    -

    Type declaration

    • exponentialBase: number
    • maxRetryDelay: number
    • minRetryDelay: number
    • randomRetry: boolean
    • retryJitter: number
    +

    Type declaration

    diff --git a/variables/_influxdata_influxdb-client.DEFAULT_WriteOptions.html b/variables/_influxdata_influxdb-client.DEFAULT_WriteOptions.html index 8a4016fa..db26c004 100644 --- a/variables/_influxdata_influxdb-client.DEFAULT_WriteOptions.html +++ b/variables/_influxdata_influxdb-client.DEFAULT_WriteOptions.html @@ -1,2 +1,2 @@ DEFAULT_WriteOptions | Documentation
    DEFAULT_WriteOptions: WriteOptions = ...

    default writeOptions

    -
    +
    diff --git a/variables/_influxdata_influxdb-client.FLUX_VALUE.html b/variables/_influxdata_influxdb-client.FLUX_VALUE.html index 88c6b9a5..f101fd4a 100644 --- a/variables/_influxdata_influxdb-client.FLUX_VALUE.html +++ b/variables/_influxdata_influxdb-client.FLUX_VALUE.html @@ -1,2 +1,2 @@ FLUX_VALUE | Documentation
    FLUX_VALUE: typeof FLUX_VALUE = ...

    Property that offers a function that returns flux-sanitized value of an object.

    -
    +
    diff --git a/variables/_influxdata_influxdb-client.Log.html b/variables/_influxdata_influxdb-client.Log.html index 0742b659..6cc2292f 100644 --- a/variables/_influxdata_influxdb-client.Log.html +++ b/variables/_influxdata_influxdb-client.Log.html @@ -1 +1 @@ -Log | Documentation
    +Log | Documentation
    diff --git a/variables/_influxdata_influxdb-client.UNKNOWN_COLUMN.html b/variables/_influxdata_influxdb-client.UNKNOWN_COLUMN.html index 735a820a..67a8ba28 100644 --- a/variables/_influxdata_influxdb-client.UNKNOWN_COLUMN.html +++ b/variables/_influxdata_influxdb-client.UNKNOWN_COLUMN.html @@ -1 +1 @@ -UNKNOWN_COLUMN | Documentation
    +UNKNOWN_COLUMN | Documentation
    diff --git a/variables/_influxdata_influxdb-client.consoleLogger.html b/variables/_influxdata_influxdb-client.consoleLogger.html index 2c2f45f1..ced11ebe 100644 --- a/variables/_influxdata_influxdb-client.consoleLogger.html +++ b/variables/_influxdata_influxdb-client.consoleLogger.html @@ -1,2 +1,2 @@ consoleLogger | Documentation
    consoleLogger: Logger = ...

    Logger that logs to console.out

    -
    +
    diff --git a/variables/_influxdata_influxdb-client.currentTime.html b/variables/_influxdata_influxdb-client.currentTime.html index 27683f18..9416945f 100644 --- a/variables/_influxdata_influxdb-client.currentTime.html +++ b/variables/_influxdata_influxdb-client.currentTime.html @@ -1,4 +1,4 @@ currentTime | Documentation
    currentTime: {
        micros: () => string;
        millis: () => string;
        ms: () => string;
        nanos: () => string;
        ns: () => string;
        s: () => string;
        seconds: () => string;
        us: () => string;
    } = ...

    Exposes functions that creates strings that represent a timestamp that can be used in the line protocol. Micro and nano timestamps are emulated depending on the js platform in use.

    -

    Type declaration

    • micros: () => string
    • millis: () => string
    • ms: () => string
    • nanos: () => string
    • ns: () => string
    • s: () => string
    • seconds: () => string
    • us: () => string
    +

    Type declaration

    diff --git a/variables/_influxdata_influxdb-client.dateToProtocolTimestamp.html b/variables/_influxdata_influxdb-client.dateToProtocolTimestamp.html index 9dc2b465..fb09b66e 100644 --- a/variables/_influxdata_influxdb-client.dateToProtocolTimestamp.html +++ b/variables/_influxdata_influxdb-client.dateToProtocolTimestamp.html @@ -1,2 +1,2 @@ dateToProtocolTimestamp | Documentation
    dateToProtocolTimestamp: {
        ms: (d: Date) => string;
        ns: (d: Date) => string;
        s: (d: Date) => string;
        us: (d: Date) => string;
    } = ...

    dateToProtocolTimestamp provides converters for JavaScript Date to InfluxDB Write Protocol Timestamp. Keys are supported precisions.

    -

    Type declaration

    • ms: (d: Date) => string
    • ns: (d: Date) => string
    • s: (d: Date) => string
    • us: (d: Date) => string
    +

    Type declaration

    diff --git a/variables/_influxdata_influxdb-client.escape.html b/variables/_influxdata_influxdb-client.escape.html index be0a6337..a530d128 100644 --- a/variables/_influxdata_influxdb-client.escape.html +++ b/variables/_influxdata_influxdb-client.escape.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/variables/_influxdata_influxdb-client.symbolObservable.html b/variables/_influxdata_influxdb-client.symbolObservable.html index 7d771a51..3ded490a 100644 --- a/variables/_influxdata_influxdb-client.symbolObservable.html +++ b/variables/_influxdata_influxdb-client.symbolObservable.html @@ -1,2 +1,2 @@ symbolObservable | Documentation
    symbolObservable: typeof observable | "@@observable" = ...

    Symbol.observable or a string "@@observable". Used for interop

    -
    +
    diff --git a/variables/_influxdata_influxdb-client.typeSerializers.html b/variables/_influxdata_influxdb-client.typeSerializers.html index 445a5498..1d90aad4 100644 --- a/variables/_influxdata_influxdb-client.typeSerializers.html +++ b/variables/_influxdata_influxdb-client.typeSerializers.html @@ -1,3 +1,3 @@ typeSerializers | Documentation
    typeSerializers: Record<ColumnType, (val: string) => any> = ...

    A dictionary of serializers of particular types returned by a flux query. See https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/#data-types

    -
    +