com.influxdb.client.service

Interface DbrPsService

public interface DbrPsService

Method Summary

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

Method Detail

deleteDBRPID

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

Delete a database retention policy

Parameters:

dbrpID - The database retention policy mapping (required)

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getDBRPs

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

List all database retention policy mappings

Parameters:

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

zapTraceSpan - OpenTracing span context (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(value="api/v2/dbrps/{dbrpID}")
retrofit2.Call<DBRP> getDBRPsID(@Path(value="dbrpID")
                                                                    String dbrpID,
                                                                    @Query(value="orgID")
                                                                    String orgID,
                                                                    @Header(value="Zap-Trace-Span")
                                                                    String zapTraceSpan)

Retrieve a database retention policy mapping

Parameters:

dbrpID - The database retention policy mapping ID (required)

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<DBRP>

patchDBRPID

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

Update a database retention policy mapping

Parameters:

dbrpID - The database retention policy mapping. (required)

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

dbRPUpdate - Database retention policy update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<DBRP>

postDBRP

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

Add a database retention policy mapping

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<DBRP>