Class: DatadogAPIClient::V2::EntityIntegrationConfigsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of EntityIntegrationConfigsAPI.



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

def api_client
  @api_client
end

Instance Method Details

#delete_entity_integration_config(integration_id, opts = {}) ⇒ Object

Delete an entity integration configuration.

See Also:



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

def delete_entity_integration_config(integration_id, opts = {})
  delete_entity_integration_config_with_http_info(integration_id, opts)
  nil
end

#delete_entity_integration_config_with_http_info(integration_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an entity integration configuration.

Delete the configuration stored for a given integration in the caller's organization.

Parameters:

  • integration_id (String) —

    The identifier of the integration whose configuration is being managed. Supported values are github, jira, and pagerduty.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityIntegrationConfigsAPI.delete_entity_integration_config ...'
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling EntityIntegrationConfigsAPI.delete_entity_integration_config"
  end
  # resource path
  local_var_path = '/api/v2/idp/entity_integrations/{integration_id}'.sub('{integration_id}', CGI.escape(integration_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_entity_integration_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: EntityIntegrationConfigsAPI#delete_entity_integration_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_entity_integration_config(integration_id, opts = {}) ⇒ Object

Get an entity integration configuration.

See Also:



100
101
102
103
 
# File 'lib/datadog_api_client/v2/api/entity_integration_configs_api.rb', line 100

def get_entity_integration_config(integration_id, opts = {})
  data, _status_code, _headers = get_entity_integration_config_with_http_info(integration_id, opts)
  data
end

#get_entity_integration_config_with_http_info(integration_id, opts = {}) ⇒ Array<(EntityIntegrationConfigResponse, Integer, Hash)>

Get an entity integration configuration.

Retrieve the configuration currently stored for a given integration in the caller's organization.

Parameters:

  • integration_id (String) —

    The identifier of the integration whose configuration is being managed. Supported values are github, jira, and pagerduty.

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

    the optional parameters

Returns:



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
164
165
166
 
# File 'lib/datadog_api_client/v2/api/entity_integration_configs_api.rb', line 112

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityIntegrationConfigsAPI.get_entity_integration_config ...'
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling EntityIntegrationConfigsAPI.get_entity_integration_config"
  end
  # resource path
  local_var_path = '/api/v2/idp/entity_integrations/{integration_id}'.sub('{integration_id}', CGI.escape(integration_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] || 'EntityIntegrationConfigResponse'

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

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

#update_entity_integration_config(integration_id, body, opts = {}) ⇒ Object

Create or update entity integration configuration.

See Also:



171
172
173
174
 
# File 'lib/datadog_api_client/v2/api/entity_integration_configs_api.rb', line 171

def update_entity_integration_config(integration_id, body, opts = {})
  data, _status_code, _headers = update_entity_integration_config_with_http_info(integration_id, body, opts)
  data
end

#update_entity_integration_config_with_http_info(integration_id, body, opts = {}) ⇒ Array<(EntityIntegrationConfigResponse, Integer, Hash)>

Create or update entity integration configuration.

Create or replace the configuration for a given integration in the caller's organization. The shape of data.attributes.config depends on the integration:

  • For github: config must contain an enabled_repos array of objects with hostname, github_org_name, and repo_name.
  • For jira: config must contain an enabled_projects array of objects with hostname, account_id, and project_key.
  • For pagerduty: config must contain an accounts array of objects with a required enabled boolean and an optional subdomain string.

Parameters:

  • integration_id (String) —

    The identifier of the integration whose configuration is being managed. Supported values are github, jira, and pagerduty.

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

    the optional parameters

Returns:



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
245
246
247
248
 
# File 'lib/datadog_api_client/v2/api/entity_integration_configs_api.rb', line 188

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityIntegrationConfigsAPI.update_entity_integration_config ...'
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling EntityIntegrationConfigsAPI.update_entity_integration_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 EntityIntegrationConfigsAPI.update_entity_integration_config"
  end
  # resource path
  local_var_path = '/api/v2/idp/entity_integrations/{integration_id}'.sub('{integration_id}', CGI.escape(integration_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] || 'EntityIntegrationConfigResponse'

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

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