com.influxdb.client.service.ReplicationsService Maven / Gradle / Ivy

Go to download
package com.influxdb.client.service;

import retrofit2.Call;
import retrofit2.http.*;

import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import okhttp3.MultipartBody;

import com.influxdb.client.domain.Replication;
import com.influxdb.client.domain.ReplicationCreationRequest;
import com.influxdb.client.domain.ReplicationUpdateRequest;
import com.influxdb.client.domain.Replications;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public interface ReplicationsService {
  /**
   * Delete a replication
   * 
   * @param replicationID  (required)
   * @param zapTraceSpan OpenTracing span context (optional)
   * @return Call<Void>
   */
  @DELETE("api/v2/replications/{replicationID}")
  Call deleteReplicationByID(
    @retrofit2.http.Path("replicationID") String replicationID, @retrofit2.http.Header("Zap-Trace-Span") String zapTraceSpan
  );

  /**
   * Retrieve a replication
   * 
   * @param replicationID  (required)
   * @param zapTraceSpan OpenTracing span context (optional)
   * @return Call<Replication>
   */
  @GET("api/v2/replications/{replicationID}")
  Call getReplicationByID(
    @retrofit2.http.Path("replicationID") String replicationID, @retrofit2.http.Header("Zap-Trace-Span") String zapTraceSpan
  );

  /**
   * List all replications
   * 
   * @param orgID The organization ID. (required)
   * @param zapTraceSpan OpenTracing span context (optional)
   * @param name  (optional)
   * @param remoteID  (optional)
   * @param localBucketID  (optional)
   * @return Call<Replications>
   */
  @GET("api/v2/replications")
  Call getReplications(
    @retrofit2.http.Query("orgID") String orgID, @retrofit2.http.Header("Zap-Trace-Span") String zapTraceSpan, @retrofit2.http.Query("name") String name, @retrofit2.http.Query("remoteID") String remoteID, @retrofit2.http.Query("localBucketID") String localBucketID
  );

  /**
   * Update a replication
   * 
   * @param replicationID  (required)
   * @param replicationUpdateRequest  (required)
   * @param zapTraceSpan OpenTracing span context (optional)
   * @param validate If true, validate the updated information, but don't save it. (optional, default to false)
   * @return Call<Replication>
   */
  @Headers({
    "Content-Type:application/json"
  })
  @PATCH("api/v2/replications/{replicationID}")
  Call patchReplicationByID(
    @retrofit2.http.Path("replicationID") String replicationID, @retrofit2.http.Body ReplicationUpdateRequest replicationUpdateRequest, @retrofit2.http.Header("Zap-Trace-Span") String zapTraceSpan, @retrofit2.http.Query("validate") Boolean validate
  );

  /**
   * Register a new replication
   * 
   * @param replicationCreationRequest  (required)
   * @param zapTraceSpan OpenTracing span context (optional)
   * @param validate If true, validate the replication, but don't save it. (optional, default to false)
   * @return Call<Replication>
   */
  @Headers({
    "Content-Type:application/json"
  })
  @POST("api/v2/replications")
  Call postReplication(
    @retrofit2.http.Body ReplicationCreationRequest replicationCreationRequest, @retrofit2.http.Header("Zap-Trace-Span") String zapTraceSpan, @retrofit2.http.Query("validate") Boolean validate
  );

  /**
   * Validate a replication
   * 
   * @param replicationID  (required)
   * @param zapTraceSpan OpenTracing span context (optional)
   * @return Call<Void>
   */
  @POST("api/v2/replications/{replicationID}/validate")
  Call postValidateReplicationByID(
    @retrofit2.http.Path("replicationID") String replicationID, @retrofit2.http.Header("Zap-Trace-Span") String zapTraceSpan
  );

}