Class: DatadogAPIClient::V1::PagerDutyIntegrationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/pager_duty_integration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of PagerDutyIntegrationAPI.



22
23
24
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 22

def initialize(api_client = APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



20
21
22
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create a new service object.



30
31
32
33
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 30

def create_pager_duty_integration_service(body, opts = {})
  data, _status_code, _headers = create_pager_duty_integration_service_with_http_info(body, opts)
  data
end

#create_pager_duty_integration_service_with_http_info(body, opts = {}) ⇒ Array<(PagerDutyServiceName, Integer, Hash)>

Create a new service object.

Create a new service object in the PagerDuty integration.

Parameters:

  • body (PagerDutyService)

    Create a new service object request body.

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

    the optional parameters

Returns:

  • (Array<(PagerDutyServiceName, Integer, Hash)>)

    PagerDutyServiceName data, response status code and response headers



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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 40

def create_pager_duty_integration_service_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_pager_duty_integration_service)
    unstable_enabled = @api_client.config.unstable_operations[:create_pager_duty_integration_service]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_pager_duty_integration_service")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_pager_duty_integration_service"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PagerDutyIntegrationAPI.create_pager_duty_integration_service ...'
  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 PagerDutyIntegrationAPI.create_pager_duty_integration_service"
  end
  # resource path
  local_var_path = '/api/v1/integration/pagerduty/configuration/services'

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

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

  new_options = opts.merge(
    :operation => :create_pager_duty_integration_service,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PagerDutyIntegrationAPI#create_pager_duty_integration_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_pager_duty_integration_service(service_name, opts = {}) ⇒ Object

Delete a single service object.



105
106
107
108
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 105

def delete_pager_duty_integration_service(service_name, opts = {})
  delete_pager_duty_integration_service_with_http_info(service_name, opts)
  nil
end

#delete_pager_duty_integration_service_with_http_info(service_name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a single service object.

Delete a single service object in the Datadog-PagerDuty integration.

Parameters:

  • service_name (String)

    The service name

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
165
166
167
168
169
170
171
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 115

def delete_pager_duty_integration_service_with_http_info(service_name, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_pager_duty_integration_service)
    unstable_enabled = @api_client.config.unstable_operations[:delete_pager_duty_integration_service]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_pager_duty_integration_service")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_pager_duty_integration_service"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PagerDutyIntegrationAPI.delete_pager_duty_integration_service ...'
  end
  # verify the required parameter 'service_name' is set
  if @api_client.config.client_side_validation && service_name.nil?
    fail ArgumentError, "Missing the required parameter 'service_name' when calling PagerDutyIntegrationAPI.delete_pager_duty_integration_service"
  end
  # resource path
  local_var_path = '/api/v1/integration/pagerduty/configuration/services/{service_name}'.sub('{' + 'service_name' + '}', CGI.escape(service_name.to_s))

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

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

  new_options = opts.merge(
    :operation => :delete_pager_duty_integration_service,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PagerDutyIntegrationAPI#delete_pager_duty_integration_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pager_duty_integration_service(service_name, opts = {}) ⇒ Object

Get a single service object.



178
179
180
181
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 178

def get_pager_duty_integration_service(service_name, opts = {})
  data, _status_code, _headers = get_pager_duty_integration_service_with_http_info(service_name, opts)
  data
end

#get_pager_duty_integration_service_with_http_info(service_name, opts = {}) ⇒ Array<(PagerDutyServiceName, Integer, Hash)>

Get a single service object.

Get service name in the Datadog-PagerDuty integration.

Parameters:

  • service_name (String)

    The service name.

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

    the optional parameters

Returns:

  • (Array<(PagerDutyServiceName, Integer, Hash)>)

    PagerDutyServiceName data, response status code and response headers



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
240
241
242
243
244
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 188

def get_pager_duty_integration_service_with_http_info(service_name, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_pager_duty_integration_service)
    unstable_enabled = @api_client.config.unstable_operations[:get_pager_duty_integration_service]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_pager_duty_integration_service")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_pager_duty_integration_service"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PagerDutyIntegrationAPI.get_pager_duty_integration_service ...'
  end
  # verify the required parameter 'service_name' is set
  if @api_client.config.client_side_validation && service_name.nil?
    fail ArgumentError, "Missing the required parameter 'service_name' when calling PagerDutyIntegrationAPI.get_pager_duty_integration_service"
  end
  # resource path
  local_var_path = '/api/v1/integration/pagerduty/configuration/services/{service_name}'.sub('{' + 'service_name' + '}', CGI.escape(service_name.to_s))

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

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

  new_options = opts.merge(
    :operation => :get_pager_duty_integration_service,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PagerDutyIntegrationAPI#get_pager_duty_integration_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_pager_duty_integration_service(service_name, body, opts = {}) ⇒ Object

Update a single service object.



252
253
254
255
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 252

def update_pager_duty_integration_service(service_name, body, opts = {})
  update_pager_duty_integration_service_with_http_info(service_name, body, opts)
  nil
end

#update_pager_duty_integration_service_with_http_info(service_name, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a single service object.

Update a single service object in the Datadog-PagerDuty integration.

Parameters:

  • service_name (String)

    The service name

  • body (PagerDutyServiceKey)

    Update an existing service object request body.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/datadog_api_client/v1/api/pager_duty_integration_api.rb', line 263

def update_pager_duty_integration_service_with_http_info(service_name, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_pager_duty_integration_service)
    unstable_enabled = @api_client.config.unstable_operations[:update_pager_duty_integration_service]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_pager_duty_integration_service")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_pager_duty_integration_service"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PagerDutyIntegrationAPI.update_pager_duty_integration_service ...'
  end
  # verify the required parameter 'service_name' is set
  if @api_client.config.client_side_validation && service_name.nil?
    fail ArgumentError, "Missing the required parameter 'service_name' when calling PagerDutyIntegrationAPI.update_pager_duty_integration_service"
  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 PagerDutyIntegrationAPI.update_pager_duty_integration_service"
  end
  # resource path
  local_var_path = '/api/v1/integration/pagerduty/configuration/services/{service_name}'.sub('{' + 'service_name' + '}', CGI.escape(service_name.to_s))

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

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

  new_options = opts.merge(
    :operation => :update_pager_duty_integration_service,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PagerDutyIntegrationAPI#update_pager_duty_integration_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end