Class: DatadogAPIClient::V2::SyntheticsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SyntheticsAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_on_demand_concurrency_cap(opts = {}) ⇒ Object

Get the on-demand concurrency cap.

See Also:



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

def get_on_demand_concurrency_cap(opts = {})
  data, _status_code, _headers = get_on_demand_concurrency_cap_with_http_info(opts)
  data
end

#get_on_demand_concurrency_cap_with_http_info(opts = {}) ⇒ Array<(OnDemandConcurrencyCapResponse, Integer, Hash)>

Get the on-demand concurrency cap.

Get the on-demand concurrency cap.

Parameters:

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

    the optional parameters

Returns:



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

def get_on_demand_concurrency_cap_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_on_demand_concurrency_cap ...'
  end
  # resource path
  local_var_path = '/api/v2/synthetics/settings/on_demand_concurrency_cap'

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

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

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

#patch_global_variable(variable_id, body, opts = {}) ⇒ Object

Patch a global variable.

See Also:



89
90
91
92
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 89

def patch_global_variable(variable_id, body, opts = {})
  data, _status_code, _headers = patch_global_variable_with_http_info(variable_id, body, opts)
  data
end

#patch_global_variable_with_http_info(variable_id, body, opts = {}) ⇒ Array<(GlobalVariableResponse, Integer, Hash)>

Patch a global variable.

Patch a global variable using JSON Patch (RFC 6902). This endpoint allows partial updates to a global variable by specifying only the fields to modify.

Common operations include:

  • Replace field values: ‘“replace”, “path”: “/name”, “value”: “new_name”`

  • Update nested values: ‘“replace”, “path”: “/value/value”, “value”: “new_value”`

  • Add/update tags: ‘“add”, “path”: “/tags/-”, “value”: “new_tag”`

  • Remove fields: ‘“remove”, “path”: “/description”`

Parameters:

  • variable_id (String) —

    The ID of the global variable.

  • body (GlobalVariableJsonPatchRequest) —

    JSON Patch document with operations to apply.

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

    the optional parameters

Returns:

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

    GlobalVariableResponse data, response status code and response headers



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

def patch_global_variable_with_http_info(variable_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.patch_global_variable ...'
  end
  # verify the required parameter 'variable_id' is set
  if @api_client.config.client_side_validation && variable_id.nil?
    fail ArgumentError, "Missing the required parameter 'variable_id' when calling SyntheticsAPI.patch_global_variable"
  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 SyntheticsAPI.patch_global_variable"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/variables/{variable_id}/jsonpatch'.sub('{variable_id}', CGI.escape(variable_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] || 'GlobalVariableResponse'

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

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

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

Save new value for on-demand concurrency cap.

See Also:



168
169
170
171
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 168

def set_on_demand_concurrency_cap(body, opts = {})
  data, _status_code, _headers = set_on_demand_concurrency_cap_with_http_info(body, opts)
  data
end

#set_on_demand_concurrency_cap_with_http_info(body, opts = {}) ⇒ Array<(OnDemandConcurrencyCapResponse, Integer, Hash)>

Save new value for on-demand concurrency cap.

Save new value for on-demand concurrency cap.

Parameters:

Returns:



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

def set_on_demand_concurrency_cap_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.set_on_demand_concurrency_cap ...'
  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 SyntheticsAPI.set_on_demand_concurrency_cap"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/settings/on_demand_concurrency_cap'

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

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

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