Class SetupService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

SetupService

Implements

ISetupService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class SetupService : object, ISetupService, IApiAccessor

Constructors

SetupService(Configuration)

Initializes a new instance of the SetupService class using Configuration object

Declaration

public SetupService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

SetupService(String)

Initializes a new instance of the SetupService class.

Declaration

public SetupService(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
IDictionary<System.String, System.String>	Dictionary of HTTP header

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

GetSetup(String)

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

Declaration

public IsOnboarding GetSetup(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
IsOnboarding	IsOnboarding

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 Returns true if no default user, organization, or bucket has been created.

Declaration

public async 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

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 Returns true if no default user, organization, or bucket has been created.

Declaration

public async 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)

Exceptions

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

GetSetupAsyncWithIRestResponse(String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetSetupAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (IsOnboarding)

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 Returns true if no default user, organization, or bucket has been created.

Declaration

public 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

Exceptions

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

GetSetupWithIRestResponse(String)

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

Declaration

public RestResponse GetSetupWithIRestResponse(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of IsOnboarding

Exceptions

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

GetSetupWithIRestResponseAsync(String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetSetupWithIRestResponseAsync(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<RestResponse>	ApiResponse of IsOnboarding

Exceptions

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

GetSetupWithRestRequest(String)

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

Declaration

public RestRequest GetSetupWithRestRequest(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestRequest	ApiResponse of IsOnboarding

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 Post an onboarding request to set up initial user, org and bucket.

Declaration

public 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

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 Post an onboarding request to set up initial user, org and bucket.

Declaration

public async 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

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 Post an onboarding request to set up initial user, org and bucket.

Declaration

public async 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)

Exceptions

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

PostSetupAsyncWithIRestResponse(OnboardingRequest, String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostSetupAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (OnboardingResponse)

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 Post an onboarding request to set up initial user, org and bucket.

Declaration

public 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

Exceptions

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

PostSetupWithIRestResponse(OnboardingRequest, String)

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

Declaration

public RestResponse PostSetupWithIRestResponse(OnboardingRequest onboardingRequest, string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of OnboardingResponse

Exceptions

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

PostSetupWithIRestResponseAsync(OnboardingRequest, String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostSetupWithIRestResponseAsync(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<RestResponse>	ApiResponse of OnboardingResponse

Exceptions

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

PostSetupWithRestRequest(OnboardingRequest, String)

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

Declaration

public RestRequest PostSetupWithRestRequest(OnboardingRequest onboardingRequest, string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestRequest	ApiResponse of OnboardingResponse

Exceptions

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

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

ISetupService