Class: DatadogAPIClient::V2::CloudNetworkMonitoringAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CloudNetworkMonitoringAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_aggregated_connections(opts = {}) ⇒ Object

Get all aggregated connections.

See Also:



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

def get_aggregated_connections(opts = {})
  data, _status_code, _headers = get_aggregated_connections_with_http_info(opts)
  data
end

#get_aggregated_connections_with_http_info(opts = {}) ⇒ Array<(SingleAggregatedConnectionResponseArray, Integer, Hash)>

Get all aggregated connections.

Get all aggregated connections.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the to timestamp. If neither from nor to are provided, the query window is [now - 15m, now].

  • :to (Integer) —

    Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither from nor to are provided, the query window is [now - 15m, now].

  • :group_by (String) —

    Comma-separated list of fields to group connections by.

  • :tags (String) —

    Comma-separated list of tags to filter connections by.

  • :limit (Integer) —

    The number of connections to be returned. The maximum value is 5000.

Returns:



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
99
100
101
102
103
104
105
106
 
# File 'lib/datadog_api_client/v2/api/cloud_network_monitoring_api.rb', line 45

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudNetworkMonitoringAPI.get_aggregated_connections ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudNetworkMonitoringAPI.get_aggregated_connections, must be smaller than or equal to 5000.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudNetworkMonitoringAPI.get_aggregated_connections, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/network/connections/aggregate'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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