Package com.influxdb.client.service

Interface DbrPsService

public interface DbrPsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteDBRPID(String dbrpID, String zapTraceSpan, String orgID, String org)	Delete a database retention policy
retrofit2.Call<DBRPs>	getDBRPs(String zapTraceSpan, String orgID, String org, String id, String bucketID, Boolean _default, String db, String rp)	List database retention policy mappings
retrofit2.Call<DBRPGet>	getDBRPsID(String dbrpID, String zapTraceSpan, String orgID, String org)	Retrieve a database retention policy mapping
retrofit2.Call<DBRPGet>	patchDBRPID(String dbrpID, DBRPUpdate dbRPUpdate, String zapTraceSpan, String orgID, String org)	Update a database retention policy mapping
retrofit2.Call<DBRP>	postDBRP(DBRPCreate dbRPCreate, String zapTraceSpan)	Add a database retention policy mapping

Method Details

deleteDBRPID

@DELETE("api/v2/dbrps/{dbrpID}")
retrofit2.Call<Void> deleteDBRPID(@Path("dbrpID")
 String dbrpID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("orgID")
 String orgID,
 @Query("org")
 String org)

Delete a database retention policy

Parameters:

dbrpID - The database retention policy mapping (required)

zapTraceSpan - OpenTracing span context (optional)

orgID - Specifies the organization ID of the mapping (optional)

org - Specifies the organization name of the mapping (optional)

Returns:

Call<Void>

getDBRPs

@GET("api/v2/dbrps")
retrofit2.Call<DBRPs> getDBRPs(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("orgID")
 String orgID,
 @Query("org")
 String org,
 @Query("id")
 String id,
 @Query("bucketID")
 String bucketID,
 @Query("default")
 Boolean _default,
 @Query("db")
 String db,
 @Query("rp")
 String rp)

List database retention policy mappings

Parameters:

zapTraceSpan - OpenTracing span context (optional)

orgID - Specifies the organization ID to filter on (optional)

org - Specifies the organization name to filter on (optional)

id - Specifies the mapping ID to filter on (optional)

bucketID - Specifies the bucket ID to filter on (optional)

_default - Specifies filtering on default (optional)

db - Specifies the database to filter on (optional)

rp - Specifies the retention policy to filter on (optional)

Returns:

Call<DBRPs>

getDBRPsID

@GET("api/v2/dbrps/{dbrpID}")
retrofit2.Call<DBRPGet> getDBRPsID(@Path("dbrpID")
 String dbrpID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("orgID")
 String orgID,
 @Query("org")
 String org)

Retrieve a database retention policy mapping

Parameters:

dbrpID - The database retention policy mapping ID (required)

zapTraceSpan - OpenTracing span context (optional)

orgID - Specifies the organization ID of the mapping (optional)

org - Specifies the organization name of the mapping (optional)

Returns:

Call<DBRPGet>

patchDBRPID

@Headers("Content-Type:application/json")
@PATCH("api/v2/dbrps/{dbrpID}")
retrofit2.Call<DBRPGet> patchDBRPID(@Path("dbrpID")
 String dbrpID,
 @Body
 DBRPUpdate dbRPUpdate,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("orgID")
 String orgID,
 @Query("org")
 String org)

Update a database retention policy mapping

Parameters:

dbrpID - The database retention policy mapping. (required)

dbRPUpdate - Database retention policy update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

orgID - Specifies the organization ID of the mapping (optional)

org - Specifies the organization name of the mapping (optional)

Returns:

Call<DBRPGet>

postDBRP

@Headers("Content-Type:application/json")
@POST("api/v2/dbrps")
retrofit2.Call<DBRP> postDBRP(@Body
 DBRPCreate dbRPCreate,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a database retention policy mapping

Parameters:

dbRPCreate - The database retention policy mapping to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<DBRP>