Package com.influxdb.client.service

Interface RemoteConnectionsService

public interface RemoteConnectionsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteRemoteConnectionByID(String remoteID, String zapTraceSpan)	Delete a remote connection
retrofit2.Call<RemoteConnection>	getRemoteConnectionByID(String remoteID, String zapTraceSpan)	Retrieve a remote connection
retrofit2.Call<RemoteConnections>	getRemoteConnections(String orgID, String zapTraceSpan, String name, String remoteURL)	List all remote connections
retrofit2.Call<RemoteConnection>	patchRemoteConnectionByID(String remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, String zapTraceSpan)	Update a remote connection
retrofit2.Call<RemoteConnection>	postRemoteConnection(RemoteConnectionCreationRequest remoteConnectionCreationRequest)	Register a new remote connection

Method Details

deleteRemoteConnectionByID

@DELETE("api/v2/remotes/{remoteID}")
retrofit2.Call<Void> deleteRemoteConnectionByID(@Path("remoteID")
 String remoteID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a remote connection

Parameters:

remoteID - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getRemoteConnectionByID

@GET("api/v2/remotes/{remoteID}")
retrofit2.Call<RemoteConnection> getRemoteConnectionByID(@Path("remoteID")
 String remoteID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a remote connection

Parameters:

remoteID - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<RemoteConnection>

getRemoteConnections

@GET("api/v2/remotes")
retrofit2.Call<RemoteConnections> getRemoteConnections(@Query("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("name")
 String name,
 @Query("remoteURL")
 String remoteURL)

List all remote connections

Parameters:

orgID - The organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

name - (optional)

remoteURL - (optional)

Returns:

Call<RemoteConnections>

patchRemoteConnectionByID

@Headers("Content-Type:application/json")
@PATCH("api/v2/remotes/{remoteID}")
retrofit2.Call<RemoteConnection> patchRemoteConnectionByID(@Path("remoteID")
 String remoteID,
 @Body
 RemoteConnectionUpdateRequest remoteConnectionUpdateRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a remote connection

Parameters:

remoteID - (required)

remoteConnectionUpdateRequest - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<RemoteConnection>

postRemoteConnection

@Headers("Content-Type:application/json")
@POST("api/v2/remotes")
retrofit2.Call<RemoteConnection> postRemoteConnection(@Body
 RemoteConnectionCreationRequest remoteConnectionCreationRequest)

Register a new remote connection

Parameters:

remoteConnectionCreationRequest - (required)

Returns:

Call<RemoteConnection>