Class: DatadogAPIClient::V2::RumRateLimitAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/rum_rate_limit_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ RumRateLimitAPI

Returns a new instance of RumRateLimitAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/rum_rate_limit_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/rum_rate_limit_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#delete_rum_rate_limit_config(scope_type, scope_id, opts = {}) ⇒ Object

Delete a RUM rate limit configuration.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/rum_rate_limit_api.rb', line 29

def delete_rum_rate_limit_config(scope_type, scope_id, opts = {})
  delete_rum_rate_limit_config_with_http_info(scope_type, scope_id, opts)
  nil
end

#delete_rum_rate_limit_config_with_http_info(scope_type, scope_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a RUM rate limit configuration.

Delete the RUM rate limit configuration for a given scope.

Parameters:

  • scope_type (RumRateLimitScopeType) —

    The type of scope the rate limit configuration applies to.

  • scope_id (String) —

    The identifier of the scope the rate limit configuration applies to. For the application scope, this is the RUM application ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/rum_rate_limit_api.rb', line 42

def delete_rum_rate_limit_config_with_http_info(scope_type, scope_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_rum_rate_limit_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_rum_rate_limit_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_rum_rate_limit_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRateLimitAPI.delete_rum_rate_limit_config ...'
  end
  # verify the required parameter 'scope_type' is set
  if @api_client.config.client_side_validation && scope_type.nil?
    fail ArgumentError, "Missing the required parameter 'scope_type' when calling RumRateLimitAPI.delete_rum_rate_limit_config"
  end
  # verify enum value
  allowable_values = ['application']
  if @api_client.config.client_side_validation && !allowable_values.include?(scope_type)
    fail ArgumentError, "invalid value for \"scope_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'scope_id' is set
  if @api_client.config.client_side_validation && scope_id.nil?
    fail ArgumentError, "Missing the required parameter 'scope_id' when calling RumRateLimitAPI.delete_rum_rate_limit_config"
  end
  # resource path
  local_var_path = '/api/v2/rum/config/rate-limit/{scope_type}/{scope_id}'.sub('{scope_type}', CGI.escape(scope_type.to_s).gsub('%2F', '/')).sub('{scope_id}', CGI.escape(scope_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]

  new_options = opts.merge(
    :operation => :delete_rum_rate_limit_config,
    :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: RumRateLimitAPI#delete_rum_rate_limit_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rum_rate_limit_config(scope_type, scope_id, opts = {}) ⇒ Object

Get a RUM rate limit configuration.

See Also:



110
111
112
113
 
# File 'lib/datadog_api_client/v2/api/rum_rate_limit_api.rb', line 110

def get_rum_rate_limit_config(scope_type, scope_id, opts = {})
  data, _status_code, _headers = get_rum_rate_limit_config_with_http_info(scope_type, scope_id, opts)
  data
end

#get_rum_rate_limit_config_with_http_info(scope_type, scope_id, opts = {}) ⇒ Array<(RumRateLimitConfigResponse, Integer, Hash)>

Get a RUM rate limit configuration.

Get the RUM rate limit configuration for a given scope.

Parameters:

  • scope_type (RumRateLimitScopeType) —

    The type of scope the rate limit configuration applies to.

  • scope_id (String) —

    The identifier of the scope the rate limit configuration applies to. For the application scope, this is the RUM application ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RumRateLimitConfigResponse, Integer, Hash)>) —

    RumRateLimitConfigResponse data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/rum_rate_limit_api.rb', line 123

def get_rum_rate_limit_config_with_http_info(scope_type, scope_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_rum_rate_limit_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_rum_rate_limit_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_rum_rate_limit_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRateLimitAPI.get_rum_rate_limit_config ...'
  end
  # verify the required parameter 'scope_type' is set
  if @api_client.config.client_side_validation && scope_type.nil?
    fail ArgumentError, "Missing the required parameter 'scope_type' when calling RumRateLimitAPI.get_rum_rate_limit_config"
  end
  # verify enum value
  allowable_values = ['application']
  if @api_client.config.client_side_validation && !allowable_values.include?(scope_type)
    fail ArgumentError, "invalid value for \"scope_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'scope_id' is set
  if @api_client.config.client_side_validation && scope_id.nil?
    fail ArgumentError, "Missing the required parameter 'scope_id' when calling RumRateLimitAPI.get_rum_rate_limit_config"
  end
  # resource path
  local_var_path = '/api/v2/rum/config/rate-limit/{scope_type}/{scope_id}'.sub('{scope_type}', CGI.escape(scope_type.to_s).gsub('%2F', '/')).sub('{scope_id}', CGI.escape(scope_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] || 'RumRateLimitConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_rum_rate_limit_config,
    :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: RumRateLimitAPI#get_rum_rate_limit_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_rum_rate_limit_config(scope_type, scope_id, body, opts = {}) ⇒ Object

Create or update a RUM rate limit configuration.

See Also:



191
192
193
194
 
# File 'lib/datadog_api_client/v2/api/rum_rate_limit_api.rb', line 191

def update_rum_rate_limit_config(scope_type, scope_id, body, opts = {})
  data, _status_code, _headers = update_rum_rate_limit_config_with_http_info(scope_type, scope_id, body, opts)
  data
end

#update_rum_rate_limit_config_with_http_info(scope_type, scope_id, body, opts = {}) ⇒ Array<(RumRateLimitConfigResponse, Integer, Hash)>

Create or update a RUM rate limit configuration.

Create or update the RUM rate limit configuration for a given scope. Returns the rate limit configuration object when the request is successful.

Parameters:

  • scope_type (RumRateLimitScopeType) —

    The type of scope the rate limit configuration applies to.

  • scope_id (String) —

    The identifier of the scope the rate limit configuration applies to. For the application scope, this is the RUM application ID.

  • body (RumRateLimitConfigUpdateRequest) —

    The definition of the RUM rate limit configuration to create or update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RumRateLimitConfigResponse, Integer, Hash)>) —

    RumRateLimitConfigResponse data, response status code and response headers



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
268
269
270
271
272
273
274
275
 
# File 'lib/datadog_api_client/v2/api/rum_rate_limit_api.rb', line 206

def update_rum_rate_limit_config_with_http_info(scope_type, scope_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_rum_rate_limit_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_rum_rate_limit_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_rum_rate_limit_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRateLimitAPI.update_rum_rate_limit_config ...'
  end
  # verify the required parameter 'scope_type' is set
  if @api_client.config.client_side_validation && scope_type.nil?
    fail ArgumentError, "Missing the required parameter 'scope_type' when calling RumRateLimitAPI.update_rum_rate_limit_config"
  end
  # verify enum value
  allowable_values = ['application']
  if @api_client.config.client_side_validation && !allowable_values.include?(scope_type)
    fail ArgumentError, "invalid value for \"scope_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'scope_id' is set
  if @api_client.config.client_side_validation && scope_id.nil?
    fail ArgumentError, "Missing the required parameter 'scope_id' when calling RumRateLimitAPI.update_rum_rate_limit_config"
  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 RumRateLimitAPI.update_rum_rate_limit_config"
  end
  # resource path
  local_var_path = '/api/v2/rum/config/rate-limit/{scope_type}/{scope_id}'.sub('{scope_type}', CGI.escape(scope_type.to_s).gsub('%2F', '/')).sub('{scope_id}', CGI.escape(scope_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] || 'RumRateLimitConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_rum_rate_limit_config,
    :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::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumRateLimitAPI#update_rum_rate_limit_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end