Package com.influxdb.client.service

Interface SourcesService

public interface SourcesService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteSourcesID(String sourceID, String zapTraceSpan)	Delete a source
retrofit2.Call<Sources>	getSources(String zapTraceSpan, String org)	List all sources
retrofit2.Call<Source>	getSourcesID(String sourceID, String zapTraceSpan)	Retrieve 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)	Create a source

Method Details

deleteSourcesID

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

Delete a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getSources

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

List all sources

Parameters:

zapTraceSpan - OpenTracing span context (optional)

org - The name of the organization. (optional)

Returns:

Call<Sources>

getSourcesID

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

Retrieve a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Source>

getSourcesIDBuckets

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

Get buckets in a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

org - The name of the organization. (optional)

Returns:

Call<Buckets>

getSourcesIDHealth

@GET("api/v2/sources/{sourceID}/health")
retrofit2.Call<HealthCheck> getSourcesIDHealth(@Path("sourceID")
 String sourceID,
 @Header("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("Content-Type:application/json")
@PATCH("api/v2/sources/{sourceID}")
retrofit2.Call<Source> patchSourcesID(@Path("sourceID")
 String sourceID,
 @Body
 Source source,
 @Header("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("Content-Type:application/json")
@POST("api/v2/sources")
retrofit2.Call<Source> postSources(@Body
 Source source,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a source

Parameters:

source - Source to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Source>