com.influxdb.client.service

Interface SourcesService

public interface SourcesService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Void>	deleteSourcesID(String sourceID, String zapTraceSpan) Delete a source
retrofit2.Call<Sources>	getSources(String zapTraceSpan, String org) Get all sources
retrofit2.Call<Source>	getSourcesID(String sourceID, String zapTraceSpan) Get a source
retrofit2.Call<Buckets>	getSourcesIDBuckets(String sourceID, String zapTraceSpan, String org) Get buckets in a source
retrofit2.Call<HealthCheck>	getSourcesIDHealth(String sourceID, String zapTraceSpan) Get the health of a source
retrofit2.Call<Source>	patchSourcesID(String sourceID, Source source, String zapTraceSpan) Update a Source
retrofit2.Call<Source>	postSources(Source source, String zapTraceSpan) Creates a source

Method Detail

deleteSourcesID

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

Delete a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getSources

@GET(value="api/v2/sources")
retrofit2.Call<Sources> getSources(@Header(value="Zap-Trace-Span")
                                                                String zapTraceSpan,
                                                                @Query(value="org")
                                                                String org)

Get all sources

Parameters:

zapTraceSpan - OpenTracing span context (optional)

org - The organization name. (optional)

Returns:

Call<Sources>

getSourcesID

@GET(value="api/v2/sources/{sourceID}")
retrofit2.Call<Source> getSourcesID(@Path(value="sourceID")
                                                                            String sourceID,
                                                                            @Header(value="Zap-Trace-Span")
                                                                            String zapTraceSpan)

Get a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Source>

getSourcesIDBuckets

@GET(value="api/v2/sources/{sourceID}/buckets")
retrofit2.Call<Buckets> getSourcesIDBuckets(@Path(value="sourceID")
                                                                                            String sourceID,
                                                                                            @Header(value="Zap-Trace-Span")
                                                                                            String zapTraceSpan,
                                                                                            @Query(value="org")
                                                                                            String org)

Get buckets in a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

org - The organization name. (optional)

Returns:

Call<Buckets>

getSourcesIDHealth

@GET(value="api/v2/sources/{sourceID}/health")
retrofit2.Call<HealthCheck> getSourcesIDHealth(@Path(value="sourceID")
                                                                                              String sourceID,
                                                                                              @Header(value="Zap-Trace-Span")
                                                                                              String zapTraceSpan)

Get the health of a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<HealthCheck>

patchSourcesID

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/v2/sources/{sourceID}")
retrofit2.Call<Source> patchSourcesID(@Path(value="sourceID")
                                                                                                                                 String sourceID,
                                                                                                                                 @Body
                                                                                                                                 Source source,
                                                                                                                                 @Header(value="Zap-Trace-Span")
                                                                                                                                 String zapTraceSpan)

Update a Source

Parameters:

sourceID - The source ID. (required)

source - Source update (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Source>

postSources

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/sources")
retrofit2.Call<Source> postSources(@Body
                                                                                                                  Source source,
                                                                                                                  @Header(value="Zap-Trace-Span")
                                                                                                                  String zapTraceSpan)

Creates a source

Parameters:

source - Source to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Source>