Interface IReplicationsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IReplicationsService : IApiAccessor

Methods

DeleteReplicationByID(String, String)

Delete a replication

Declaration

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

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

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

DeleteReplicationByIDWithHttpInfo(String, String)

Delete a replication

Declaration

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

GetReplicationByID(String, String)

Retrieve a replication

Declaration

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

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

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

GetReplicationByIDWithHttpInfo(String, String)

Retrieve a replication

Declaration

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

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

List all replications

Declaration

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

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

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

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

List all replications

Declaration

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

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

Update a replication

Declaration

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

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

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

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

Update a replication

Declaration

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

PostReplication(ReplicationCreationRequest, String, Nullable<Boolean>)

Register a new replication

Declaration

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

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

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

PostReplicationWithHttpInfo(ReplicationCreationRequest, String, Nullable<Boolean>)

Register a new replication

Declaration

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

PostValidateReplicationByID(String, String)

Validate a replication

Declaration

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

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

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

PostValidateReplicationByIDWithHttpInfo(String, String)

Validate a replication

Declaration

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