Class: DatadogAPIClient::V2::RUMConfigAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RUMConfigAPI.



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

def api_client
  @api_client
end

Instance Method Details

#create_rum_config(body, opts = {}) ⇒ Object

Create the RUM configuration.

See Also:



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

def create_rum_config(body, opts = {})
  data, _status_code, _headers = create_rum_config_with_http_info(body, opts)
  data
end

#create_rum_config_with_http_info(body, opts = {}) ⇒ Array<(RumConfigResponse, Integer, Hash)>

Create the RUM configuration.

Create the RUM configuration for your organization. Returns the RUM configuration object from the request body when the request is successful.

Parameters:

  • body (RumConfigCreateRequest) —

    The definition of the RUM configuration to create.

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

    the optional parameters

Returns:

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

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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMConfigAPI.create_rum_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 RUMConfigAPI.create_rum_config"
  end
  # resource path
  local_var_path = '/api/v2/rum/config'

  # 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] || 'RumConfigResponse'

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

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

#get_rum_config(opts = {}) ⇒ Object

Get the RUM configuration.

See Also:



103
104
105
106
 
# File 'lib/datadog_api_client/v2/api/rum_config_api.rb', line 103

def get_rum_config(opts = {})
  data, _status_code, _headers = get_rum_config_with_http_info(opts)
  data
end

#get_rum_config_with_http_info(opts = {}) ⇒ Array<(RumConfigResponse, Integer, Hash)>

Get the RUM configuration.

Get the RUM configuration for your organization.

Parameters:

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

    the optional parameters

Returns:

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

    RumConfigResponse data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMConfigAPI.get_rum_config ...'
  end
  # resource path
  local_var_path = '/api/v2/rum/config'

  # 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] || 'RumConfigResponse'

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

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

#update_rum_config(body, opts = {}) ⇒ Object

Update the RUM configuration.

See Also:



169
170
171
172
 
# File 'lib/datadog_api_client/v2/api/rum_config_api.rb', line 169

def update_rum_config(body, opts = {})
  data, _status_code, _headers = update_rum_config_with_http_info(body, opts)
  data
end

#update_rum_config_with_http_info(body, opts = {}) ⇒ Array<(RumConfigResponse, Integer, Hash)>

Update the RUM configuration.

Update the RUM configuration for your organization. Returns the RUM configuration object from the request body when the request is successful.

Parameters:

  • body (RumConfigUpdateRequest) —

    New definition of the RUM configuration.

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

    the optional parameters

Returns:

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

    RumConfigResponse data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMConfigAPI.update_rum_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 RUMConfigAPI.update_rum_config"
  end
  # resource path
  local_var_path = '/api/v2/rum/config'

  # 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] || 'RumConfigResponse'

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

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