com.influxdb.client.service

Interface DefaultService

public interface DefaultService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Void>	deletePost(DeletePredicateRequest deletePredicateRequest, String zapTraceSpan, String org, String bucket, String orgID, String bucketID) Delete time series data from InfluxDB
retrofit2.Call<Routes>	getRoutes(String zapTraceSpan) Map of all top level routes available
retrofit2.Call<Void>	postSignin(String zapTraceSpan, String authorization) Exchange basic auth credentials for session
retrofit2.Call<Void>	postSignout(String zapTraceSpan) Expire the current session

Method Detail

deletePost

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/delete")
retrofit2.Call<Void> deletePost(@Body
                                                                                                              DeletePredicateRequest deletePredicateRequest,
                                                                                                              @Header(value="Zap-Trace-Span")
                                                                                                              String zapTraceSpan,
                                                                                                              @Query(value="org")
                                                                                                              String org,
                                                                                                              @Query(value="bucket")
                                                                                                              String bucket,
                                                                                                              @Query(value="orgID")
                                                                                                              String orgID,
                                                                                                              @Query(value="bucketID")
                                                                                                              String bucketID)

Delete time series data from InfluxDB

Parameters:

deletePredicateRequest - Predicate delete request (required)

zapTraceSpan - OpenTracing span context (optional)

org - Specifies the organization to delete data from. (optional)

bucket - Specifies the bucket to delete data from. (optional)

orgID - Specifies the organization ID of the resource. (optional)

bucketID - Specifies the bucket ID to delete data from. (optional)

Returns:

Call<Void>

getRoutes

@GET(value="api/v2/")
retrofit2.Call<Routes> getRoutes(@Header(value="Zap-Trace-Span")
                                                       String zapTraceSpan)

Map of all top level routes available

Parameters:

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Routes>

postSignin

@POST(value="api/v2/signin")
retrofit2.Call<Void> postSignin(@Header(value="Zap-Trace-Span")
                                                             String zapTraceSpan,
                                                             @Header(value="Authorization")
                                                             String authorization)

Exchange basic auth credentials for session

Parameters:

zapTraceSpan - OpenTracing span context (optional)

authorization - An auth credential for the Basic scheme (optional)

Returns:

Call<Void>

postSignout

@POST(value="api/v2/signout")
retrofit2.Call<Void> postSignout(@Header(value="Zap-Trace-Span")
                                                               String zapTraceSpan)

Expire the current session

Parameters:

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>