class InfluxDB2::API::Client

The client is the entry point to management HTTP API defined in github.com/influxdata/influxdb/blob/master/http/swagger.yml.

Attributes

api_client[RW]

Public Class Methods

new(client) click to toggle source

Initialize client that providing a support for managements APIs.

@example Instantiate a client.

client = InfluxDBClient::Client.new(url: 'https://localhost:8086', token: 'my-token')
api = InfluxDB2::API::Client.new(client)

@param [InfluxDB2::Client] :client The main InfluxDB client

# File lib/influxdb2/apis/api.rb, line 34
def initialize(client)
  configuration = Configuration.new

  uri = URI.parse(client.options[:url])
  # base URL
  configuration.scheme = uri.scheme
  configuration.host = uri.to_s
  # SSL
  configuration.verify_ssl = client.options[:use_ssl].nil? ? true : client.options[:use_ssl]
  # Token
  configuration.api_key_prefix['api_key'] = 'Token'
  configuration.api_key['api_key'] = client.options[:token]

  @api_client = ApiClient.new(configuration)
  # User Agent
  @api_client.user_agent = "influxdb-client-ruby/#{InfluxDB2::VERSION}"
end

Public Instance Methods

create_authorizations_api() click to toggle source

Create a new instance of AuthorizationsApi.

@return [InfluxDB2::API::AuthorizationsApi] New instance of OrganizationsApi.

# File lib/influxdb2/apis/api.rb, line 55
def create_authorizations_api
  InfluxDB2::API::AuthorizationsApi.new(@api_client)
end
create_buckets_api() click to toggle source

Create a new instance of BucketsApi.

@return [InfluxDB2::API::BucketsApi] New instance of BucketsApi.

# File lib/influxdb2/apis/api.rb, line 62
def create_buckets_api
  InfluxDB2::API::BucketsApi.new(@api_client)
end
create_labels_api() click to toggle source

Create a new instance of LabelsApi.

@return [InfluxDB2::API::LabelsApi] New instance of LabelsApi.

# File lib/influxdb2/apis/api.rb, line 69
def create_labels_api
  InfluxDB2::API::LabelsApi.new(@api_client)
end
create_organizations_api() click to toggle source

Create a new instance of OrganizationsApi.

@return [InfluxDB2::API::OrganizationsApi] New instance of OrganizationsApi.

# File lib/influxdb2/apis/api.rb, line 76
def create_organizations_api
  InfluxDB2::API::OrganizationsApi.new(@api_client)
end
create_users_api() click to toggle source

Create a new instance of UsersApi.

@return [InfluxDB2::API::UsersApi] New instance of UsersApi.

# File lib/influxdb2/apis/api.rb, line 83
def create_users_api
  InfluxDB2::API::UsersApi.new(@api_client)
end