Class: DatadogAPIClient::V2::RestrictionPoliciesAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::RestrictionPoliciesAPI
- Defined in:
- lib/datadog_api_client/v2/api/restriction_policies_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_restriction_policy(resource_id, opts = {}) ⇒ Object
Delete a restriction policy.
-
#delete_restriction_policy_with_http_info(resource_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a restriction policy.
-
#get_restriction_policy(resource_id, opts = {}) ⇒ Object
Get a restriction policy.
-
#get_restriction_policy_with_http_info(resource_id, opts = {}) ⇒ Array<(RestrictionPolicyResponse, Integer, Hash)>
Get a restriction policy.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ RestrictionPoliciesAPI
constructor
A new instance of RestrictionPoliciesAPI.
-
#update_restriction_policy(resource_id, body, opts = {}) ⇒ Object
Update a restriction policy.
-
#update_restriction_policy_with_http_info(resource_id, body, opts = {}) ⇒ Array<(RestrictionPolicyResponse, Integer, Hash)>
Update a restriction policy.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ RestrictionPoliciesAPI
Returns a new instance of RestrictionPoliciesAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 22 def initialize(api_client = DatadogAPIClient::APIClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
20 21 22 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#delete_restriction_policy(resource_id, opts = {}) ⇒ Object
Delete a restriction policy.
29 30 31 32 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 29 def delete_restriction_policy(resource_id, opts = {}) delete_restriction_policy_with_http_info(resource_id, opts) nil end |
#delete_restriction_policy_with_http_info(resource_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a restriction policy.
Deletes the restriction policy associated with a specified resource.
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 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 41 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] = 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, ) 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_restriction_policy(resource_id, opts = {}) ⇒ Object
Get a restriction policy.
94 95 96 97 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 94 def get_restriction_policy(resource_id, opts = {}) data, _status_code, _headers = get_restriction_policy_with_http_info(resource_id, opts) data end |
#get_restriction_policy_with_http_info(resource_id, opts = {}) ⇒ Array<(RestrictionPolicyResponse, Integer, Hash)>
Get a restriction policy.
Retrieves the restriction policy associated with a specified resource.
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 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 106 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] = 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, ) 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_restriction_policy(resource_id, body, opts = {}) ⇒ Object
Update a restriction policy.
159 160 161 162 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 159 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_restriction_policy_with_http_info(resource_id, body, opts = {}) ⇒ Array<(RestrictionPolicyResponse, Integer, Hash)>
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`
-
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`
#### 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`
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 |
# File 'lib/datadog_api_client/v2/api/restriction_policies_api.rb', line 197 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] || {} # 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] = 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, ) 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 |