-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy pathrestriction_policies_api.rb
267 lines (227 loc) · 11.4 KB
/
restriction_policies_api.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
=begin
#Datadog API V2 Collection
#Collection of all Datadog Public endpoints.
The version of the OpenAPI document: 1.0
Contact: [email protected]
Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
This product includes software developed at Datadog (https://www.datadoghq.com/).
Copyright 2020-Present Datadog, Inc.
=end
require 'cgi'
module DatadogAPIClient::V2
class RestrictionPoliciesAPI
attr_accessor :api_client
def initialize(api_client = DatadogAPIClient::APIClient.default)
@api_client = api_client
end
# Delete a restriction policy.
#
# @see #delete_restriction_policy_with_http_info
def delete_restriction_policy(resource_id, opts = {})
delete_restriction_policy_with_http_info(resource_id, opts)
nil
end
# Delete a restriction policy.
#
# Deletes the restriction policy associated with a specified resource.
#
# @param resource_id [String] Identifier, formatted as `type:id`. Supported types: `connection`, `dashboard`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`.
# @param opts [Hash] the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def delete_restriction_policy_with_http_info(resource_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RestrictionPoliciesAPI.delete_restriction_policy ...'
end
# verify the required parameter 'resource_id' is set
if @api_client.config.client_side_validation && resource_id.nil?
fail ArgumentError, "Missing the required parameter 'resource_id' when calling RestrictionPoliciesAPI.delete_restriction_policy"
end
# resource path
local_var_path = '/api/v2/restriction_policy/{resource_id}'.sub('{resource_id}', CGI.escape(resource_id.to_s).gsub('%2F', '/'))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type]
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
new_options = opts.merge(
:operation => :delete_restriction_policy,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type,
:api_version => "V2"
)
data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RestrictionPoliciesAPI#delete_restriction_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Get a restriction policy.
#
# @see #get_restriction_policy_with_http_info
def get_restriction_policy(resource_id, opts = {})
data, _status_code, _headers = get_restriction_policy_with_http_info(resource_id, opts)
data
end
# Get a restriction policy.
#
# Retrieves the restriction policy associated with a specified resource.
#
# @param resource_id [String] Identifier, formatted as `type:id`. Supported types: `connection`, `dashboard`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`.
# @param opts [Hash] the optional parameters
# @return [Array<(RestrictionPolicyResponse, Integer, Hash)>] RestrictionPolicyResponse data, response status code and response headers
def get_restriction_policy_with_http_info(resource_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RestrictionPoliciesAPI.get_restriction_policy ...'
end
# verify the required parameter 'resource_id' is set
if @api_client.config.client_side_validation && resource_id.nil?
fail ArgumentError, "Missing the required parameter 'resource_id' when calling RestrictionPoliciesAPI.get_restriction_policy"
end
# resource path
local_var_path = '/api/v2/restriction_policy/{resource_id}'.sub('{resource_id}', CGI.escape(resource_id.to_s).gsub('%2F', '/'))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'RestrictionPolicyResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
new_options = opts.merge(
:operation => :get_restriction_policy,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type,
:api_version => "V2"
)
data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RestrictionPoliciesAPI#get_restriction_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Update a restriction policy.
#
# @see #update_restriction_policy_with_http_info
def update_restriction_policy(resource_id, body, opts = {})
data, _status_code, _headers = update_restriction_policy_with_http_info(resource_id, body, opts)
data
end
# Update a restriction policy.
#
# Updates the restriction policy associated with a resource.
#
# #### Supported resources
# Restriction policies can be applied to the following resources:
# - Dashboards: `dashboard`
# - Notebooks: `notebook`
# - Powerpacks: `powerpack`
# - Reference Tables: `reference-table`
# - Security Rules: `security-rule`
# - Service Level Objectives: `slo`
# - Synthetic Global Variables: `synthetics-global-variable`
# - Synthetic Tests: `synthetics-test`
# - Synthetic Private Locations: `synthetics-private-location`
# - Monitors: `monitor`
# - Workflows: `workflow`
# - App Builder Apps: `app-builder-app`
# - Connections: `connection`
# - Connection Groups: `connection-group`
# - RUM Applications: `rum-application`
#
# #### Supported relations for resources
# Resource Type | Supported Relations
# ----------------------------|--------------------------
# Dashboards | `viewer`, `editor`
# Notebooks | `viewer`, `editor`
# Powerpacks | `viewer`, `editor`
# Security Rules | `viewer`, `editor`
# Service Level Objectives | `viewer`, `editor`
# Synthetic Global Variables | `viewer`, `editor`
# Synthetic Tests | `viewer`, `editor`
# Synthetic Private Locations | `viewer`, `editor`
# Monitors | `viewer`, `editor`
# Reference Tables | `viewer`, `editor`
# Workflows | `viewer`, `runner`, `editor`
# App Builder Apps | `viewer`, `editor`
# Connections | `viewer`, `resolver`, `editor`
# Connection Groups | `viewer`, `editor`
# RUM Application | `viewer`, `editor`
#
# @param resource_id [String] Identifier, formatted as `type:id`. Supported types: `connection`, `dashboard`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`.
# @param body [RestrictionPolicyUpdateRequest] Restriction policy payload
# @param opts [Hash] the optional parameters
# @option opts [Boolean] :allow_self_lockout Allows admins (users with the `user_access_manage` permission) to remove their own access from the resource if set to `true`. By default, this is set to `false`, preventing admins from locking themselves out.
# @return [Array<(RestrictionPolicyResponse, Integer, Hash)>] RestrictionPolicyResponse data, response status code and response headers
def update_restriction_policy_with_http_info(resource_id, body, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RestrictionPoliciesAPI.update_restriction_policy ...'
end
# verify the required parameter 'resource_id' is set
if @api_client.config.client_side_validation && resource_id.nil?
fail ArgumentError, "Missing the required parameter 'resource_id' when calling RestrictionPoliciesAPI.update_restriction_policy"
end
# verify the required parameter 'body' is set
if @api_client.config.client_side_validation && body.nil?
fail ArgumentError, "Missing the required parameter 'body' when calling RestrictionPoliciesAPI.update_restriction_policy"
end
# resource path
local_var_path = '/api/v2/restriction_policy/{resource_id}'.sub('{resource_id}', CGI.escape(resource_id.to_s).gsub('%2F', '/'))
# query parameters
query_params = opts[:query_params] || {}
query_params[:'allow_self_lockout'] = opts[:'allow_self_lockout'] if !opts[:'allow_self_lockout'].nil?
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
# return_type
return_type = opts[:debug_return_type] || 'RestrictionPolicyResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
new_options = opts.merge(
:operation => :update_restriction_policy,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type,
:api_version => "V2"
)
data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RestrictionPoliciesAPI#update_restriction_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
end
end