Interface ISetupService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ISetupService : IApiAccessor

Methods

GetSetup(String)

Check if database has default user, org, bucket

Declaration

IsOnboarding GetSetup(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
IsOnboarding	IsOnboarding

Remarks

Returns true if no default user, organization, or bucket has been created.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSetupAsync(String, CancellationToken)

Check if database has default user, org, bucket

Declaration

System.Threading.Tasks.Task<IsOnboarding> GetSetupAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IsOnboarding>	Task of IsOnboarding

Remarks

Returns true if no default user, organization, or bucket has been created.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSetupAsyncWithHttpInfo(String, CancellationToken)

Check if database has default user, org, bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<IsOnboarding>> GetSetupAsyncWithHttpInfo(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<IsOnboarding>>	Task of ApiResponse (IsOnboarding)

Remarks

Returns true if no default user, organization, or bucket has been created.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSetupWithHttpInfo(String)

Check if database has default user, org, bucket

Declaration

ApiResponse<IsOnboarding> GetSetupWithHttpInfo(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<IsOnboarding>	ApiResponse of IsOnboarding

Remarks

Returns true if no default user, organization, or bucket has been created.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSetup(OnboardingRequest, String)

Set up initial user, org and bucket

Declaration

OnboardingResponse PostSetup(OnboardingRequest onboardingRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
OnboardingRequest	onboardingRequest	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
OnboardingResponse	OnboardingResponse

Remarks

Post an onboarding request to set up initial user, org and bucket.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSetupAsync(OnboardingRequest, String, CancellationToken)

Set up initial user, org and bucket

Declaration

System.Threading.Tasks.Task<OnboardingResponse> PostSetupAsync(OnboardingRequest onboardingRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
OnboardingRequest	onboardingRequest	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<OnboardingResponse>	Task of OnboardingResponse

Remarks

Post an onboarding request to set up initial user, org and bucket.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSetupAsyncWithHttpInfo(OnboardingRequest, String, CancellationToken)

Set up initial user, org and bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<OnboardingResponse>> PostSetupAsyncWithHttpInfo(OnboardingRequest onboardingRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
OnboardingRequest	onboardingRequest	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<OnboardingResponse>>	Task of ApiResponse (OnboardingResponse)

Remarks

Post an onboarding request to set up initial user, org and bucket.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSetupWithHttpInfo(OnboardingRequest, String)

Set up initial user, org and bucket

Declaration

ApiResponse<OnboardingResponse> PostSetupWithHttpInfo(OnboardingRequest onboardingRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
OnboardingRequest	onboardingRequest	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<OnboardingResponse>	ApiResponse of OnboardingResponse

Remarks

Post an onboarding request to set up initial user, org and bucket.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call