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