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

Class ReplicationsService

Represents a collection of functions to interact with the API endpoints

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

Constructors

ReplicationsService(Configuration)

Initializes a new instance of the ReplicationsService class using Configuration object

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

An instance of Configuration

ReplicationsService(String)

Initializes a new instance of the ReplicationsService class.

Declaration
public ReplicationsService(string basePath)
Parameters
Type Name Description
System.String basePath

Properties

Configuration

Gets or sets the configuration object

Declaration
public Configuration Configuration { get; set; }
Property Value
Type Description
InfluxDB.Client.Api.Client.Configuration

An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration
public void AddDefaultHeader(string key, string value)
Parameters
Type Name Description
System.String key

Header field name.

System.String value

Header field value.

DefaultHeader()

Gets the default header.

Declaration
public IDictionary<string, string> DefaultHeader()
Returns
Type Description
IDictionary<System.String, System.String>

Dictionary of HTTP header

DeleteReplicationByID(String, String)

Delete a replication

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

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteReplicationByIDAsync(String, String, CancellationToken)

Delete a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task

Task of void

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

Thrown when fails to make API call

DeleteReplicationByIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse

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

Thrown when fails to make API call

DeleteReplicationByIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse

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

Thrown when fails to make API call

DeleteReplicationByIDWithHttpInfo(String, String)

Delete a replication

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

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteReplicationByIDWithIRestResponse(String, String)

Delete a replication

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

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteReplicationByIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteReplicationByIDWithRestRequest(String, String)

Delete a replication

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

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

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

Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
System.String

The base path

GetReplicationByID(String, String)

Retrieve a replication

Declaration
public Replication GetReplicationByID(string replicationID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String replicationID
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Replication

Replication

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

Thrown when fails to make API call

GetReplicationByIDAsync(String, String, CancellationToken)

Retrieve a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Replication

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

Thrown when fails to make API call

GetReplicationByIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Replication)

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

Thrown when fails to make API call

GetReplicationByIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Replication)

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

Thrown when fails to make API call

GetReplicationByIDWithHttpInfo(String, String)

Retrieve a replication

Declaration
public ApiResponse<Replication> GetReplicationByIDWithHttpInfo(string replicationID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String replicationID
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Replication

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

Thrown when fails to make API call

GetReplicationByIDWithIRestResponse(String, String)

Retrieve a replication

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

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Replication

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

Thrown when fails to make API call

GetReplicationByIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Replication

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

Thrown when fails to make API call

GetReplicationByIDWithRestRequest(String, String)

Retrieve a replication

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

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Replication

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

Thrown when fails to make API call

GetReplications(String, String, String, String, String)

List all replications

Declaration
public Replications GetReplications(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

Returns
Type Description
Replications

Replications

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

Thrown when fails to make API call

GetReplicationsAsync(String, String, String, String, String, CancellationToken)

List all replications

Declaration
public async System.Threading.Tasks.Task<Replications> GetReplicationsAsync(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Replications

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

Thrown when fails to make API call

GetReplicationsAsyncWithHttpInfo(String, String, String, String, String, CancellationToken)

List all replications

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Replications>> GetReplicationsAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Replications)

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

Thrown when fails to make API call

GetReplicationsAsyncWithIRestResponse(String, String, String, String, String, CancellationToken)

List all replications

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetReplicationsAsyncWithIRestResponse(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Replications)

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

Thrown when fails to make API call

GetReplicationsWithHttpInfo(String, String, String, String, String)

List all replications

Declaration
public ApiResponse<Replications> GetReplicationsWithHttpInfo(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

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

ApiResponse of Replications

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

Thrown when fails to make API call

GetReplicationsWithIRestResponse(String, String, String, String, String)

List all replications

Declaration
public RestResponse GetReplicationsWithIRestResponse(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

Returns
Type Description
RestResponse

ApiResponse of Replications

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

Thrown when fails to make API call

GetReplicationsWithIRestResponseAsync(String, String, String, String, String, CancellationToken)

List all replications

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetReplicationsWithIRestResponseAsync(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Replications

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

Thrown when fails to make API call

GetReplicationsWithRestRequest(String, String, String, String, String)

List all replications

Declaration
public RestRequest GetReplicationsWithRestRequest(string orgID, string zapTraceSpan = null, string name = null, string remoteID = null, string localBucketID = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteID

(optional)

System.String localBucketID

(optional)

Returns
Type Description
RestRequest

ApiResponse of Replications

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

Thrown when fails to make API call

PatchReplicationByID(String, ReplicationUpdateRequest, String, Nullable<Boolean>)

Update a replication

Declaration
public Replication PatchReplicationByID(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

Returns
Type Description
Replication

Replication

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

Thrown when fails to make API call

PatchReplicationByIDAsync(String, ReplicationUpdateRequest, String, Nullable<Boolean>, CancellationToken)

Update a replication

Declaration
public async System.Threading.Tasks.Task<Replication> PatchReplicationByIDAsync(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

Task of Replication

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

Thrown when fails to make API call

PatchReplicationByIDAsyncWithHttpInfo(String, ReplicationUpdateRequest, String, Nullable<Boolean>, CancellationToken)

Update a replication

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Replication>> PatchReplicationByIDAsyncWithHttpInfo(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Replication)

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

Thrown when fails to make API call

PatchReplicationByIDAsyncWithIRestResponse(String, ReplicationUpdateRequest, String, Nullable<Boolean>, CancellationToken)

Update a replication

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchReplicationByIDAsyncWithIRestResponse(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Replication)

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

Thrown when fails to make API call

PatchReplicationByIDWithHttpInfo(String, ReplicationUpdateRequest, String, Nullable<Boolean>)

Update a replication

Declaration
public ApiResponse<Replication> PatchReplicationByIDWithHttpInfo(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

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

ApiResponse of Replication

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

Thrown when fails to make API call

PatchReplicationByIDWithIRestResponse(String, ReplicationUpdateRequest, String, Nullable<Boolean>)

Update a replication

Declaration
public RestResponse PatchReplicationByIDWithIRestResponse(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

Returns
Type Description
RestResponse

ApiResponse of Replication

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

Thrown when fails to make API call

PatchReplicationByIDWithIRestResponseAsync(String, ReplicationUpdateRequest, String, Nullable<Boolean>, CancellationToken)

Update a replication

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchReplicationByIDWithIRestResponseAsync(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Replication

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

Thrown when fails to make API call

PatchReplicationByIDWithRestRequest(String, ReplicationUpdateRequest, String, Nullable<Boolean>)

Update a replication

Declaration
public RestRequest PatchReplicationByIDWithRestRequest(string replicationID, ReplicationUpdateRequest replicationUpdateRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
System.String replicationID
ReplicationUpdateRequest replicationUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the updated information, but don't save it. (optional, default to false)

Returns
Type Description
RestRequest

ApiResponse of Replication

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

Thrown when fails to make API call

PostReplication(ReplicationCreationRequest, String, Nullable<Boolean>)

Register a new replication

Declaration
public Replication PostReplication(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

Returns
Type Description
Replication

Replication

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

Thrown when fails to make API call

PostReplicationAsync(ReplicationCreationRequest, String, Nullable<Boolean>, CancellationToken)

Register a new replication

Declaration
public async System.Threading.Tasks.Task<Replication> PostReplicationAsync(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

Task of Replication

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

Thrown when fails to make API call

PostReplicationAsyncWithHttpInfo(ReplicationCreationRequest, String, Nullable<Boolean>, CancellationToken)

Register a new replication

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Replication>> PostReplicationAsyncWithHttpInfo(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Replication)

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

Thrown when fails to make API call

PostReplicationAsyncWithIRestResponse(ReplicationCreationRequest, String, Nullable<Boolean>, CancellationToken)

Register a new replication

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostReplicationAsyncWithIRestResponse(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Replication)

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

Thrown when fails to make API call

PostReplicationWithHttpInfo(ReplicationCreationRequest, String, Nullable<Boolean>)

Register a new replication

Declaration
public ApiResponse<Replication> PostReplicationWithHttpInfo(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

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

ApiResponse of Replication

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

Thrown when fails to make API call

PostReplicationWithIRestResponse(ReplicationCreationRequest, String, Nullable<Boolean>)

Register a new replication

Declaration
public RestResponse PostReplicationWithIRestResponse(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

Returns
Type Description
RestResponse

ApiResponse of Replication

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

Thrown when fails to make API call

PostReplicationWithIRestResponseAsync(ReplicationCreationRequest, String, Nullable<Boolean>, CancellationToken)

Register a new replication

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostReplicationWithIRestResponseAsync(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Replication

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

Thrown when fails to make API call

PostReplicationWithRestRequest(ReplicationCreationRequest, String, Nullable<Boolean>)

Register a new replication

Declaration
public RestRequest PostReplicationWithRestRequest(ReplicationCreationRequest replicationCreationRequest, string zapTraceSpan = null, bool? validate = null)
Parameters
Type Name Description
ReplicationCreationRequest replicationCreationRequest
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Boolean> validate

If true, validate the replication, but don't save it. (optional, default to false)

Returns
Type Description
RestRequest

ApiResponse of Replication

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

Thrown when fails to make API call

PostValidateReplicationByID(String, String)

Validate a replication

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

OpenTracing span context (optional)

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

Thrown when fails to make API call

PostValidateReplicationByIDAsync(String, String, CancellationToken)

Validate a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task

Task of void

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

Thrown when fails to make API call

PostValidateReplicationByIDAsyncWithHttpInfo(String, String, CancellationToken)

Validate a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse

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

Thrown when fails to make API call

PostValidateReplicationByIDAsyncWithIRestResponse(String, String, CancellationToken)

Validate a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse

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

Thrown when fails to make API call

PostValidateReplicationByIDWithHttpInfo(String, String)

Validate a replication

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

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>

ApiResponse of Object(void)

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

Thrown when fails to make API call

PostValidateReplicationByIDWithIRestResponse(String, String)

Validate a replication

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

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

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

Thrown when fails to make API call

PostValidateReplicationByIDWithIRestResponseAsync(String, String, CancellationToken)

Validate a replication

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

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Object(void)

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

Thrown when fails to make API call

PostValidateReplicationByIDWithRestRequest(String, String)

Validate a replication

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

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

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

Thrown when fails to make API call

SetBasePath(String)

Sets the base path of the API client.

Declaration
public void SetBasePath(string basePath)
Parameters
Type Name Description
System.String basePath

Implements

IReplicationsService
In This Article
Back to top Generated by DocFX