Class: Grafana::Api::Dashboards::Uid

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/dashboards/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/dashboards/uid.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#delete(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#get(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#permissions(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#permissions_post(uid:, update_dashboard_acl_command:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#public_dashboards(dashboard_uid:) ⇒ Object

Raises:

  • (ArgumentError) 


59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/grafana-api/api/dashboards/uid.rb', line 59

def public_dashboards(dashboard_uid:)
  raise ArgumentError, 'dashboard_uid is required' if dashboard_uid.nil?

  @connection.call(
    :GET,
    '/dashboards/uid/{dashboardUid}/public-dashboards'
      .gsub('{dashboardUid}', ERB::Util.url_encode(dashboard_uid.to_s)),
    type: Grafana::Api::Models::PublicDashboard,
    auth: ['api_key', 'basic']
  )
end

#public_dashboards_delete(dashboard_uid:, uid:) ⇒ Object

Raises:

  • (ArgumentError) 


71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/grafana-api/api/dashboards/uid.rb', line 71

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

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

#public_dashboards_patch(dashboard_uid:, uid:, public_dashboard_dto:) ⇒ Object

Raises:

  • (ArgumentError) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/grafana-api/api/dashboards/uid.rb', line 85

def public_dashboards_patch(dashboard_uid:, uid:, public_dashboard_dto:)
  raise ArgumentError, 'dashboard_uid is required' if dashboard_uid.nil?
  raise ArgumentError, 'uid is required' if uid.nil?
  raise ArgumentError, 'public_dashboard_dto is required' if public_dashboard_dto.nil?

  @connection.call(
    :PATCH,
    '/dashboards/uid/{dashboardUid}/public-dashboards/{uid}'
      .gsub('{dashboardUid}', ERB::Util.url_encode(dashboard_uid.to_s))
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::PublicDashboard,
    auth: ['api_key', 'basic'],
    body: public_dashboard_dto
  )
end

#public_dashboards_post(dashboard_uid:, public_dashboard_dto:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def public_dashboards_post(dashboard_uid:, public_dashboard_dto:)
  raise ArgumentError, 'dashboard_uid is required' if dashboard_uid.nil?
  raise ArgumentError, 'public_dashboard_dto is required' if public_dashboard_dto.nil?

  @connection.call(
    :POST,
    '/dashboards/uid/{dashboardUid}/public-dashboards'
      .gsub('{dashboardUid}', ERB::Util.url_encode(dashboard_uid.to_s)),
    type: Grafana::Api::Models::PublicDashboard,
    auth: ['api_key', 'basic'],
    body: public_dashboard_dto
  )
end

#restore(uid:, restore_dashboard_version_command:) ⇒ Object

Raises:

  • (ArgumentError) 


115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/grafana-api/api/dashboards/uid.rb', line 115

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

  @connection.call(
    :POST,
    '/dashboards/uid/{uid}/restore'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::PostDashboard200Response,
    auth: ['api_key', 'basic'],
    body: restore_dashboard_version_command
  )
end

#versions(uid:, limit: nil, start: nil) ⇒ Object

Raises:

  • (ArgumentError) 


129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/grafana-api/api/dashboards/uid.rb', line 129

def versions(uid:, limit: nil, start: nil)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :GET,
    '/dashboards/uid/{uid}/versions'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::DashboardVersionResponseMeta,
    auth: ['api_key', 'basic'],
    query: { 'limit' => limit, 'start' => start }
  )
end

#versions_get(dashboard_version_id:, uid:) ⇒ Object

Raises:

  • (ArgumentError) 


142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/grafana-api/api/dashboards/uid.rb', line 142

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

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