com.influxdb.client.service

Interface RemoteConnectionsService

public interface RemoteConnectionsService

Method Summary

Modifier and Type	Method and 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 Detail

deleteRemoteConnectionByID

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

Delete a remote connection

Parameters:

remoteID - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getRemoteConnectionByID

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

Retrieve a remote connection

Parameters:

remoteID - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<RemoteConnection>

getRemoteConnections

@GET(value="api/v2/remotes")
retrofit2.Call<RemoteConnections> getRemoteConnections(@Query(value="orgID")
                                                                                    String orgID,
                                                                                    @Header(value="Zap-Trace-Span")
                                                                                    String zapTraceSpan,
                                                                                    @Query(value="name")
                                                                                    String name,
                                                                                    @Query(value="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(value="Content-Type:application/json")
 @PATCH(value="api/v2/remotes/{remoteID}")
retrofit2.Call<RemoteConnection> patchRemoteConnectionByID(@Path(value="remoteID")
                                                                                                                                                      String remoteID,
                                                                                                                                                      @Body
                                                                                                                                                      RemoteConnectionUpdateRequest remoteConnectionUpdateRequest,
                                                                                                                                                      @Header(value="Zap-Trace-Span")
                                                                                                                                                      String zapTraceSpan)

Update a remote connection

Parameters:

remoteID - (required)

remoteConnectionUpdateRequest - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<RemoteConnection>

postRemoteConnection

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

Register a new remote connection

Parameters:

remoteConnectionCreationRequest - (required)

Returns:

Call<RemoteConnection>