Class: Grafana::Api::Datasources::Uid

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Uid

Returns a new instance of Uid.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#correlations(source_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def correlations(source_uid:)
  raise ArgumentError, 'source_uid is required' if source_uid.nil?

  @connection.call(
    :GET,
    '/datasources/uid/{sourceUID}/correlations'
      .gsub('{sourceUID}', ERB::Util.url_encode(source_uid.to_s)),
    type: [Grafana::Api::Models::Correlation],
    auth: ['api_key', 'basic']
  )
end

#correlations_delete(uid:, correlation_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def correlations_delete(uid:, correlation_uid:)
  raise ArgumentError, 'uid is required' if uid.nil?
  raise ArgumentError, 'correlation_uid is required' if correlation_uid.nil?

  @connection.call(
    :DELETE,
    '/datasources/uid/{uid}/correlations/{correlationUID}'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s))
      .gsub('{correlationUID}', ERB::Util.url_encode(correlation_uid.to_s)),
    type: Grafana::Api::Models::DeleteCorrelationResponseBody,
    auth: ['api_key', 'basic']
  )
end

#correlations_get(source_uid:, correlation_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def correlations_get(source_uid:, correlation_uid:)
  raise ArgumentError, 'source_uid is required' if source_uid.nil?
  raise ArgumentError, 'correlation_uid is required' if correlation_uid.nil?

  @connection.call(
    :GET,
    '/datasources/uid/{sourceUID}/correlations/{correlationUID}'
      .gsub('{sourceUID}', ERB::Util.url_encode(source_uid.to_s))
      .gsub('{correlationUID}', ERB::Util.url_encode(correlation_uid.to_s)),
    type: Grafana::Api::Models::Correlation,
    auth: ['api_key', 'basic']
  )
end

#correlations_patch(source_uid:, correlation_uid:, update_correlation_command: nil) ⇒ Object

Raises:

  • (ArgumentError) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 49

def correlations_patch(source_uid:, correlation_uid:, update_correlation_command: nil)
  raise ArgumentError, 'source_uid is required' if source_uid.nil?
  raise ArgumentError, 'correlation_uid is required' if correlation_uid.nil?

  @connection.call(
    :PATCH,
    '/datasources/uid/{sourceUID}/correlations/{correlationUID}'
      .gsub('{sourceUID}', ERB::Util.url_encode(source_uid.to_s))
      .gsub('{correlationUID}', ERB::Util.url_encode(correlation_uid.to_s)),
    type: Grafana::Api::Models::UpdateCorrelationResponseBody,
    auth: ['api_key', 'basic'],
    body: update_correlation_command
  )
end

#correlations_post(source_uid:, create_correlation_command:) ⇒ Object

Raises:

  • (ArgumentError) 


64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 64

def correlations_post(source_uid:, create_correlation_command:)
  raise ArgumentError, 'source_uid is required' if source_uid.nil?
  raise ArgumentError, 'create_correlation_command is required' if create_correlation_command.nil?

  @connection.call(
    :POST,
    '/datasources/uid/{sourceUID}/correlations'
      .gsub('{sourceUID}', ERB::Util.url_encode(source_uid.to_s)),
    type: Grafana::Api::Models::CreateCorrelationResponseBody,
    auth: ['api_key', 'basic'],
    body: create_correlation_command
  )
end

#delete(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 78

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

  @connection.call(
    :DELETE,
    '/datasources/uid/{uid}'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic']
  )
end

#get(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 90

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

  @connection.call(
    :GET,
    '/datasources/uid/{uid}'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::DataSource,
    auth: ['api_key', 'basic']
  )
end

#health(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 102

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

  @connection.call(
    :GET,
    '/datasources/uid/{uid}/health'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic']
  )
end

#lbac_teams(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 114

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

  @connection.call(
    :GET,
    '/datasources/uid/{uid}/lbac/teams'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::TeamLBACRules,
    auth: ['api_key', 'basic']
  )
end

#lbac_teams_put(uid:, update_team_lbac_command: nil) ⇒ Object

Raises:

  • (ArgumentError) 


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

def lbac_teams_put(uid:, update_team_lbac_command: nil)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :PUT,
    '/datasources/uid/{uid}/lbac/teams'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::UpdateTeamLBACRulesApi200Response,
    auth: ['api_key', 'basic'],
    body: update_team_lbac_command
  )
end

#resources(datasource_proxy_route:, uid:) ⇒ Object

Raises:

  • (ArgumentError) 


139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 139

def resources(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/uid/{uid}/resources/{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: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic']
  )
end

#update(uid:, update_data_source_command:) ⇒ Object

Raises:

  • (ArgumentError) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/grafana-api/api/datasources/uid.rb', line 153

def update(uid:, update_data_source_command:)
  raise ArgumentError, 'uid is required' if uid.nil?
  raise ArgumentError, 'update_data_source_command is required' if update_data_source_command.nil?

  @connection.call(
    :PUT,
    '/datasources/uid/{uid}'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::AddDataSource200Response,
    auth: ['api_key', 'basic'],
    body: update_data_source_command
  )
end