Package com.influxdb.client.service

Interface SetupService

public interface SetupService

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<IsOnboarding>
    getSetup(String zapTraceSpan)
    Check if database has default user, org, bucket Returns `true` if no default user, organization, or bucket has been created.
    retrofit2.Call<OnboardingResponse>
    postSetup(OnboardingRequest onboardingRequest, String zapTraceSpan)
    Set up initial user, org and bucket Post an onboarding request to set up initial user, org and bucket.

  • Method Details

    • getSetup

      @GET("api/v2/setup") retrofit2.Call<IsOnboarding> getSetup(@Header("Zap-Trace-Span") String zapTraceSpan)
      Check if database has default user, org, bucket Returns `true` if no default user, organization, or bucket has been created.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<IsOnboarding>

    • postSetup

      @Headers("Content-Type:application/json") @POST("api/v2/setup") retrofit2.Call<OnboardingResponse> postSetup(@Body OnboardingRequest onboardingRequest, @Header("Zap-Trace-Span") String zapTraceSpan)
      Set up initial user, org and bucket Post an onboarding request to set up initial user, org and bucket.
      Parameters:
      onboardingRequest - Source to create (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<OnboardingResponse>