Class: DatadogAPIClient::V2::RUMRetentionFiltersHardcodedAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RUMRetentionFiltersHardcodedAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_hardcoded_retention_filter(app_id, rf_id, opts = {}) ⇒ Object

Get a hardcoded retention filter.

See Also:



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

def get_hardcoded_retention_filter(app_id, rf_id, opts = {})
  data, _status_code, _headers = get_hardcoded_retention_filter_with_http_info(app_id, rf_id, opts)
  data
end

#get_hardcoded_retention_filter_with_http_info(app_id, rf_id, opts = {}) ⇒ Array<(RumHardcodedRetentionFilterResponse, Integer, Hash)>

Get a hardcoded retention filter.

Get a single hardcoded retention filter for a RUM application.

Parameters:

  • app_id (String) —

    RUM application ID.

  • rf_id (String) —

    Hardcoded retention filter ID.

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

    the optional parameters

Returns:



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

def get_hardcoded_retention_filter_with_http_info(app_id, rf_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMRetentionFiltersHardcodedAPI.get_hardcoded_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RUMRetentionFiltersHardcodedAPI.get_hardcoded_retention_filter"
  end
  # verify the required parameter 'rf_id' is set
  if @api_client.config.client_side_validation && rf_id.nil?
    fail ArgumentError, "Missing the required parameter 'rf_id' when calling RUMRetentionFiltersHardcodedAPI.get_hardcoded_retention_filter"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/hardcoded_retention_filters/{rf_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')).sub('{rf_id}', CGI.escape(rf_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] || 'RumHardcodedRetentionFilterResponse'

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

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

#list_hardcoded_retention_filters(app_id, opts = {}) ⇒ Object

Get all hardcoded retention filters.

See Also:



99
100
101
102
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_hardcoded_api.rb', line 99

def list_hardcoded_retention_filters(app_id, opts = {})
  data, _status_code, _headers = list_hardcoded_retention_filters_with_http_info(app_id, opts)
  data
end

#list_hardcoded_retention_filters_with_http_info(app_id, opts = {}) ⇒ Array<(RumHardcodedRetentionFiltersResponse, Integer, Hash)>

Get all hardcoded retention filters.

Get the list of hardcoded retention filters for a RUM application.

Parameters:

  • app_id (String) —

    RUM application ID.

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

    the optional parameters

Returns:



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

def list_hardcoded_retention_filters_with_http_info(app_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMRetentionFiltersHardcodedAPI.list_hardcoded_retention_filters ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RUMRetentionFiltersHardcodedAPI.list_hardcoded_retention_filters"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/hardcoded_retention_filters'.sub('{app_id}', CGI.escape(app_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] || 'RumHardcodedRetentionFiltersResponse'

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

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

#update_hardcoded_retention_filter(app_id, rf_id, body, opts = {}) ⇒ Object

Update a hardcoded retention filter.

See Also:



164
165
166
167
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_hardcoded_api.rb', line 164

def update_hardcoded_retention_filter(app_id, rf_id, body, opts = {})
  data, _status_code, _headers = update_hardcoded_retention_filter_with_http_info(app_id, rf_id, body, opts)
  data
end

#update_hardcoded_retention_filter_with_http_info(app_id, rf_id, body, opts = {}) ⇒ Array<(RumHardcodedRetentionFilterResponse, Integer, Hash)>

Update a hardcoded retention filter.

Update the cross-product sample rates of a hardcoded retention filter for a RUM application. Only fields whose matching flag in cross_product_sampling_editability is true can be updated. Any other field is read-only and cannot be sent in the payload. Returns the updated hardcoded retention filter when the request is successful.

Parameters:

  • app_id (String) —

    RUM application ID.

  • rf_id (String) —

    Hardcoded retention filter ID.

  • body (RumHardcodedRetentionFilterUpdateRequest) —

    New cross-product sample rates for the hardcoded retention filter.

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

    the optional parameters

Returns:



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

def update_hardcoded_retention_filter_with_http_info(app_id, rf_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMRetentionFiltersHardcodedAPI.update_hardcoded_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RUMRetentionFiltersHardcodedAPI.update_hardcoded_retention_filter"
  end
  # verify the required parameter 'rf_id' is set
  if @api_client.config.client_side_validation && rf_id.nil?
    fail ArgumentError, "Missing the required parameter 'rf_id' when calling RUMRetentionFiltersHardcodedAPI.update_hardcoded_retention_filter"
  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 RUMRetentionFiltersHardcodedAPI.update_hardcoded_retention_filter"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/hardcoded_retention_filters/{rf_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')).sub('{rf_id}', CGI.escape(rf_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] || 'RumHardcodedRetentionFilterResponse'

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

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