Class: Grafana::Api::LibraryElements

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

Defined Under Namespace

Classes: Name

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ LibraryElements

Returns a new instance of LibraryElements.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#connections(library_element_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def connections(library_element_uid:)
  raise ArgumentError, 'library_element_uid is required' if library_element_uid.nil?

  @connection.call(
    :GET,
    '/library-elements/{library_element_uid}/connections/'
      .gsub('{library_element_uid}', ERB::Util.url_encode(library_element_uid.to_s)),
    type: Grafana::Api::Models::LibraryElementConnectionsResponse,
    auth: ['api_key', 'basic']
  )
end

#create(create_library_element_command:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :POST,
    '/library-elements',
    type: Grafana::Api::Models::LibraryElementResponse,
    auth: ['api_key', 'basic'],
    body: create_library_element_command
  )
end

#delete(library_element_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#get(library_element_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :GET,
    '/library-elements/{library_element_uid}'
      .gsub('{library_element_uid}', ERB::Util.url_encode(library_element_uid.to_s)),
    type: Grafana::Api::Models::LibraryElementResponse,
    auth: ['api_key', 'basic']
  )
end

#list(search_string: nil, kind: nil, sort_direction: nil, type_filter: nil, exclude_uid: nil, folder_filter: nil, folder_filter_uids: nil, per_page: nil, page: nil) ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'lib/grafana-api/api/library_elements.rb', line 57

def list(search_string: nil, kind: nil, sort_direction: nil, type_filter: nil, exclude_uid: nil, folder_filter: nil, folder_filter_uids: nil, per_page: nil, page: nil)
  @connection.call(
    :GET,
    '/library-elements',
    type: Grafana::Api::Models::LibraryElementSearchResponse,
    auth: ['api_key', 'basic'],
    query: { 'searchString' => search_string, 'kind' => kind, 'sortDirection' => sort_direction, 'typeFilter' => type_filter, 'excludeUid' => exclude_uid, 'folderFilter' => folder_filter, 'folderFilterUIDs' => folder_filter_uids, 'perPage' => per_page, 'page' => page }
  )
end

#partial_update(library_element_uid:, patch_library_element_command:) ⇒ Object

Raises:

  • (ArgumentError) 


67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/grafana-api/api/library_elements.rb', line 67

def partial_update(library_element_uid:, patch_library_element_command:)
  raise ArgumentError, 'library_element_uid is required' if library_element_uid.nil?
  raise ArgumentError, 'patch_library_element_command is required' if patch_library_element_command.nil?

  @connection.call(
    :PATCH,
    '/library-elements/{library_element_uid}'
      .gsub('{library_element_uid}', ERB::Util.url_encode(library_element_uid.to_s)),
    type: Grafana::Api::Models::LibraryElementResponse,
    auth: ['api_key', 'basic'],
    body: patch_library_element_command
  )
end