Class: Grafana::Api::Datasources

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/datasources.rb

Defined Under Namespace

Classes: Correlations, Id, Name, Uid

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Datasources

Returns a new instance of Datasources.



5
6
7
 
# File 'lib/grafana-api/api/datasources.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#cache(data_source_uid:, data_source_type: nil) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/grafana-api/api/datasources.rb', line 9

def cache(data_source_uid:, data_source_type: nil)
  raise ArgumentError, 'data_source_uid is required' if data_source_uid.nil?

  @connection.call(
    :GET,
    '/datasources/{dataSourceUID}/cache'
      .gsub('{dataSourceUID}', ERB::Util.url_encode(data_source_uid.to_s)),
    type: Grafana::Api::Models::CacheConfigResponse,
    auth: ['api_key', 'basic'],
    query: { 'dataSourceType' => data_source_type }
  )
end

#cache_clean(data_source_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/grafana-api/api/datasources.rb', line 22

def cache_clean(data_source_uid:)
  raise ArgumentError, 'data_source_uid is required' if data_source_uid.nil?

  @connection.call(
    :POST,
    '/datasources/{dataSourceUID}/cache/clean'
      .gsub('{dataSourceUID}', ERB::Util.url_encode(data_source_uid.to_s)),
    type: Grafana::Api::Models::CacheConfigResponse,
    auth: ['api_key', 'basic']
  )
end

#cache_disable(data_source_uid:, data_source_type: nil) ⇒ Object

Raises:

  • (ArgumentError) 


34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/grafana-api/api/datasources.rb', line 34

def cache_disable(data_source_uid:, data_source_type: nil)
  raise ArgumentError, 'data_source_uid is required' if data_source_uid.nil?

  @connection.call(
    :POST,
    '/datasources/{dataSourceUID}/cache/disable'
      .gsub('{dataSourceUID}', ERB::Util.url_encode(data_source_uid.to_s)),
    type: Grafana::Api::Models::CacheConfigResponse,
    auth: ['api_key', 'basic'],
    query: { 'dataSourceType' => data_source_type }
  )
end

#cache_enable(data_source_uid:, data_source_type: nil) ⇒ Object

Raises:

  • (ArgumentError) 


47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/grafana-api/api/datasources.rb', line 47

def cache_enable(data_source_uid:, data_source_type: nil)
  raise ArgumentError, 'data_source_uid is required' if data_source_uid.nil?

  @connection.call(
    :POST,
    '/datasources/{dataSourceUID}/cache/enable'
      .gsub('{dataSourceUID}', ERB::Util.url_encode(data_source_uid.to_s)),
    type: Grafana::Api::Models::CacheConfigResponse,
    auth: ['api_key', 'basic'],
    query: { 'dataSourceType' => data_source_type }
  )
end

#cache_post(data_source_uid:, cache_config_setter:, data_source_type: nil) ⇒ Object

Raises:

  • (ArgumentError) 


60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/grafana-api/api/datasources.rb', line 60

def cache_post(data_source_uid:, cache_config_setter:, data_source_type: nil)
  raise ArgumentError, 'data_source_uid is required' if data_source_uid.nil?
  raise ArgumentError, 'cache_config_setter is required' if cache_config_setter.nil?

  @connection.call(
    :POST,
    '/datasources/{dataSourceUID}/cache'
      .gsub('{dataSourceUID}', ERB::Util.url_encode(data_source_uid.to_s)),
    type: Grafana::Api::Models::CacheConfigResponse,
    auth: ['api_key', 'basic'],
    query: { 'dataSourceType' => data_source_type },
    body: cache_config_setter
  )
end

#create(add_data_source_command:) ⇒ Object

Raises:

  • (ArgumentError) 


75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/grafana-api/api/datasources.rb', line 75

def create(add_data_source_command:)
  raise ArgumentError, 'add_data_source_command is required' if add_data_source_command.nil?

  @connection.call(
    :POST,
    '/datasources',
    type: Grafana::Api::Models::AddDataSource200Response,
    auth: ['api_key', 'basic'],
    body: add_data_source_command
  )
end

#list ⇒ Object 



87
88
89
90
91
92
93
94
 
# File 'lib/grafana-api/api/datasources.rb', line 87

def list
  @connection.call(
    :GET,
    '/datasources',
    type: [Grafana::Api::Models::DataSourceListItemDTO],
    auth: ['api_key', 'basic']
  )
end

#proxy_uid(datasource_proxy_route:, uid:) ⇒ Object

Raises:

  • (ArgumentError) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/grafana-api/api/datasources.rb', line 96

def proxy_uid(datasource_proxy_route:, uid:)
  raise ArgumentError, 'datasource_proxy_route is required' if datasource_proxy_route.nil?
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :GET,
    '/datasources/proxy/uid/{uid}/{datasource_proxy_route}'
      .gsub('{datasource_proxy_route}', ERB::Util.url_encode(datasource_proxy_route.to_s))
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: nil,
    auth: ['api_key', 'basic']
  )
end

#proxy_uid_delete(uid:, datasource_proxy_route:) ⇒ Object

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/grafana-api/api/datasources.rb', line 110

def proxy_uid_delete(uid:, datasource_proxy_route:)
  raise ArgumentError, 'uid is required' if uid.nil?
  raise ArgumentError, 'datasource_proxy_route is required' if datasource_proxy_route.nil?

  @connection.call(
    :DELETE,
    '/datasources/proxy/uid/{uid}/{datasource_proxy_route}'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s))
      .gsub('{datasource_proxy_route}', ERB::Util.url_encode(datasource_proxy_route.to_s)),
    type: nil,
    auth: ['api_key', 'basic']
  )
end

#proxy_uid_post(datasource_proxy_route:, uid:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/grafana-api/api/datasources.rb', line 124

def proxy_uid_post(datasource_proxy_route:, uid:, body:)
  raise ArgumentError, 'datasource_proxy_route is required' if datasource_proxy_route.nil?
  raise ArgumentError, 'uid is required' if uid.nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/datasources/proxy/uid/{uid}/{datasource_proxy_route}'
      .gsub('{datasource_proxy_route}', ERB::Util.url_encode(datasource_proxy_route.to_s))
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: nil,
    auth: ['api_key', 'basic'],
    body: body
  )
end