Class: Grafana::Api::RecordingRules

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ RecordingRules

Returns a new instance of RecordingRules.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#bulk_update(recording_rule_json:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def bulk_update(recording_rule_json:)
  raise ArgumentError, 'recording_rule_json is required' if recording_rule_json.nil?

  @connection.call(
    :PUT,
    '/recording-rules',
    type: Grafana::Api::Models::RecordingRuleJSON,
    auth: ['api_key', 'basic'],
    body: recording_rule_json
  )
end

#create(recording_rule_json:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :POST,
    '/recording-rules',
    type: Grafana::Api::Models::RecordingRuleJSON,
    auth: ['api_key', 'basic'],
    body: recording_rule_json
  )
end

#delete(recording_rule_id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#list ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'lib/grafana-api/api/recording_rules.rb', line 45

def list
  @connection.call(
    :GET,
    '/recording-rules',
    type: [Grafana::Api::Models::RecordingRuleJSON],
    auth: ['api_key', 'basic']
  )
end

#test(recording_rule_json:) ⇒ Object

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/grafana-api/api/recording_rules.rb', line 54

def test(recording_rule_json:)
  raise ArgumentError, 'recording_rule_json is required' if recording_rule_json.nil?

  @connection.call(
    :POST,
    '/recording-rules/test',
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: recording_rule_json
  )
end

#writer ⇒ Object 



66
67
68
69
70
71
72
73
 
# File 'lib/grafana-api/api/recording_rules.rb', line 66

def writer
  @connection.call(
    :GET,
    '/recording-rules/writer',
    type: Grafana::Api::Models::PrometheusRemoteWriteTargetJSON,
    auth: ['api_key', 'basic']
  )
end

#writer_delete ⇒ Object 



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

def writer_delete
  @connection.call(
    :DELETE,
    '/recording-rules/writer',
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic']
  )
end

#writer_post(prometheus_remote_write_target_json:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def writer_post(prometheus_remote_write_target_json:)
  raise ArgumentError, 'prometheus_remote_write_target_json is required' if prometheus_remote_write_target_json.nil?

  @connection.call(
    :POST,
    '/recording-rules/writer',
    type: Grafana::Api::Models::PrometheusRemoteWriteTargetJSON,
    auth: ['api_key', 'basic'],
    body: prometheus_remote_write_target_json
  )
end