Interface IRemoteConnectionsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IRemoteConnectionsService : IApiAccessor

Methods

DeleteRemoteConnectionByID(String, String)

Delete a remote connection

Declaration

void DeleteRemoteConnectionByID(string remoteID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	remoteID
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteRemoteConnectionByIDAsync(String, String, CancellationToken)

Delete a remote connection

Declaration

System.Threading.Tasks.Task DeleteRemoteConnectionByIDAsync(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	remoteID
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

DeleteRemoteConnectionByIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a remote connection

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteRemoteConnectionByIDAsyncWithHttpInfo(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	remoteID
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

DeleteRemoteConnectionByIDWithHttpInfo(String, String)

Delete a remote connection

Declaration

ApiResponse<object> DeleteRemoteConnectionByIDWithHttpInfo(string remoteID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	remoteID
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

GetRemoteConnectionByID(String, String)

Retrieve a remote connection

Declaration

RemoteConnection GetRemoteConnectionByID(string remoteID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	remoteID
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RemoteConnection	RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetRemoteConnectionByIDAsync(String, String, CancellationToken)

Retrieve a remote connection

Declaration

System.Threading.Tasks.Task<RemoteConnection> GetRemoteConnectionByIDAsync(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	remoteID
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RemoteConnection>	Task of RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetRemoteConnectionByIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a remote connection

Declaration

System.Threading.Tasks.Task<ApiResponse<RemoteConnection>> GetRemoteConnectionByIDAsyncWithHttpInfo(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	remoteID
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<RemoteConnection>>	Task of ApiResponse (RemoteConnection)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetRemoteConnectionByIDWithHttpInfo(String, String)

Retrieve a remote connection

Declaration

ApiResponse<RemoteConnection> GetRemoteConnectionByIDWithHttpInfo(string remoteID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	remoteID
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<RemoteConnection>	ApiResponse of RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetRemoteConnections(String, String, String, String)

List all remote connections

Declaration

RemoteConnections GetRemoteConnections(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	name	(optional)
System.String	remoteURL	(optional)

Returns

Type	Description
RemoteConnections	RemoteConnections

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetRemoteConnectionsAsync(String, String, String, String, CancellationToken)

List all remote connections

Declaration

System.Threading.Tasks.Task<RemoteConnections> GetRemoteConnectionsAsync(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = 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	remoteURL	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RemoteConnections>	Task of RemoteConnections

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetRemoteConnectionsAsyncWithHttpInfo(String, String, String, String, CancellationToken)

List all remote connections

Declaration

System.Threading.Tasks.Task<ApiResponse<RemoteConnections>> GetRemoteConnectionsAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = 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	remoteURL	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<RemoteConnections>>	Task of ApiResponse (RemoteConnections)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetRemoteConnectionsWithHttpInfo(String, String, String, String)

List all remote connections

Declaration

ApiResponse<RemoteConnections> GetRemoteConnectionsWithHttpInfo(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	name	(optional)
System.String	remoteURL	(optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<RemoteConnections>	ApiResponse of RemoteConnections

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchRemoteConnectionByID(String, RemoteConnectionUpdateRequest, String)

Update a remote connection

Declaration

RemoteConnection PatchRemoteConnectionByID(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	remoteID
RemoteConnectionUpdateRequest	remoteConnectionUpdateRequest
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RemoteConnection	RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchRemoteConnectionByIDAsync(String, RemoteConnectionUpdateRequest, String, CancellationToken)

Update a remote connection

Declaration

System.Threading.Tasks.Task<RemoteConnection> PatchRemoteConnectionByIDAsync(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	remoteID
RemoteConnectionUpdateRequest	remoteConnectionUpdateRequest
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RemoteConnection>	Task of RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchRemoteConnectionByIDAsyncWithHttpInfo(String, RemoteConnectionUpdateRequest, String, CancellationToken)

Update a remote connection

Declaration

System.Threading.Tasks.Task<ApiResponse<RemoteConnection>> PatchRemoteConnectionByIDAsyncWithHttpInfo(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	remoteID
RemoteConnectionUpdateRequest	remoteConnectionUpdateRequest
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<RemoteConnection>>	Task of ApiResponse (RemoteConnection)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchRemoteConnectionByIDWithHttpInfo(String, RemoteConnectionUpdateRequest, String)

Update a remote connection

Declaration

ApiResponse<RemoteConnection> PatchRemoteConnectionByIDWithHttpInfo(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	remoteID
RemoteConnectionUpdateRequest	remoteConnectionUpdateRequest
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<RemoteConnection>	ApiResponse of RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRemoteConnection(RemoteConnectionCreationRequest)

Register a new remote connection

Declaration

RemoteConnection PostRemoteConnection(RemoteConnectionCreationRequest remoteConnectionCreationRequest)

Parameters

Type	Name	Description
RemoteConnectionCreationRequest	remoteConnectionCreationRequest

Returns

Type	Description
RemoteConnection	RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRemoteConnectionAsync(RemoteConnectionCreationRequest, CancellationToken)

Register a new remote connection

Declaration

System.Threading.Tasks.Task<RemoteConnection> PostRemoteConnectionAsync(RemoteConnectionCreationRequest remoteConnectionCreationRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
RemoteConnectionCreationRequest	remoteConnectionCreationRequest
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RemoteConnection>	Task of RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRemoteConnectionAsyncWithHttpInfo(RemoteConnectionCreationRequest, CancellationToken)

Register a new remote connection

Declaration

System.Threading.Tasks.Task<ApiResponse<RemoteConnection>> PostRemoteConnectionAsyncWithHttpInfo(RemoteConnectionCreationRequest remoteConnectionCreationRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
RemoteConnectionCreationRequest	remoteConnectionCreationRequest
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<RemoteConnection>>	Task of ApiResponse (RemoteConnection)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostRemoteConnectionWithHttpInfo(RemoteConnectionCreationRequest)

Register a new remote connection

Declaration

ApiResponse<RemoteConnection> PostRemoteConnectionWithHttpInfo(RemoteConnectionCreationRequest remoteConnectionCreationRequest)

Parameters

Type	Name	Description
RemoteConnectionCreationRequest	remoteConnectionCreationRequest

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<RemoteConnection>	ApiResponse of RemoteConnection

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call