com.influxdb.client.service

Interface ReplicationsService

public interface ReplicationsService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Void>	deleteReplicationByID(String replicationID, String zapTraceSpan) Delete a replication
retrofit2.Call<Replication>	getReplicationByID(String replicationID, String zapTraceSpan) Retrieve a replication
retrofit2.Call<Replications>	getReplications(String orgID, String zapTraceSpan, String name, String remoteID, String localBucketID) List all replications
retrofit2.Call<Replication>	patchReplicationByID(String replicationID, ReplicationUpdateRequest replicationUpdateRequest, String zapTraceSpan, Boolean validate) Update a replication
retrofit2.Call<Replication>	postReplication(ReplicationCreationRequest replicationCreationRequest, String zapTraceSpan, Boolean validate) Register a new replication
retrofit2.Call<Void>	postValidateReplicationByID(String replicationID, String zapTraceSpan) Validate a replication

Method Detail

deleteReplicationByID

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

Delete a replication

Parameters:

replicationID - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getReplicationByID

@GET(value="api/v2/replications/{replicationID}")
retrofit2.Call<Replication> getReplicationByID(@Path(value="replicationID")
                                                                                                 String replicationID,
                                                                                                 @Header(value="Zap-Trace-Span")
                                                                                                 String zapTraceSpan)

Retrieve a replication

Parameters:

replicationID - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Replication>

getReplications

@GET(value="api/v2/replications")
retrofit2.Call<Replications> getReplications(@Query(value="orgID")
                                                                               String orgID,
                                                                               @Header(value="Zap-Trace-Span")
                                                                               String zapTraceSpan,
                                                                               @Query(value="name")
                                                                               String name,
                                                                               @Query(value="remoteID")
                                                                               String remoteID,
                                                                               @Query(value="localBucketID")
                                                                               String localBucketID)

List all replications

Parameters:

orgID - The organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

name - (optional)

remoteID - (optional)

localBucketID - (optional)

Returns:

Call<Replications>

patchReplicationByID

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/v2/replications/{replicationID}")
retrofit2.Call<Replication> patchReplicationByID(@Path(value="replicationID")
                                                                                                                                                      String replicationID,
                                                                                                                                                      @Body
                                                                                                                                                      ReplicationUpdateRequest replicationUpdateRequest,
                                                                                                                                                      @Header(value="Zap-Trace-Span")
                                                                                                                                                      String zapTraceSpan,
                                                                                                                                                      @Query(value="validate")
                                                                                                                                                      Boolean validate)

Update a replication

Parameters:

replicationID - (required)

replicationUpdateRequest - (required)

zapTraceSpan - OpenTracing span context (optional)

validate - If true, validate the updated information, but don't save it. (optional, default to false)

Returns:

Call<Replication>

postReplication

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/replications")
retrofit2.Call<Replication> postReplication(@Body
                                                                                                                                ReplicationCreationRequest replicationCreationRequest,
                                                                                                                                @Header(value="Zap-Trace-Span")
                                                                                                                                String zapTraceSpan,
                                                                                                                                @Query(value="validate")
                                                                                                                                Boolean validate)

Register a new replication

Parameters:

replicationCreationRequest - (required)

zapTraceSpan - OpenTracing span context (optional)

validate - If true, validate the replication, but don't save it. (optional, default to false)

Returns:

Call<Replication>

postValidateReplicationByID

@POST(value="api/v2/replications/{replicationID}/validate")
retrofit2.Call<Void> postValidateReplicationByID(@Path(value="replicationID")
                                                                                                             String replicationID,
                                                                                                             @Header(value="Zap-Trace-Span")
                                                                                                             String zapTraceSpan)

Validate a replication

Parameters:

replicationID - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>