Class: DatadogAPIClient::V2::SpaAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SpaAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_spa_recommendations(service, opts = {}) ⇒ Object

Get SPA Recommendations.

See Also:



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

def get_spa_recommendations(service, opts = {})
  data, _status_code, _headers = get_spa_recommendations_with_http_info(service, opts)
  data
end

#get_spa_recommendations_with_http_info(service, opts = {}) ⇒ Array<(RecommendationDocument, Integer, Hash)>

Get SPA Recommendations.

This endpoint is currently experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job. The caller (Spark Gateway or DJM UI) provides a service name and SPA returns structured recommendations for driver and executor resources. The version with a shard should be preferred, where possible, as it gives more accurate results.

Parameters:

  • service (String) —

    The service name for a spark job.

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

    the optional parameters

Options Hash (opts):

  • :bypass_cache (String) —

    The recommendation service should not use its metrics cache.

Returns:

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

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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpaAPI.get_spa_recommendations ...'
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling SpaAPI.get_spa_recommendations"
  end
  # resource path
  local_var_path = '/api/v2/spa/recommendations/{service}'.sub('{service}', CGI.escape(service.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'bypass_cache'] = opts[:'bypass_cache'] if !opts[:'bypass_cache'].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] || 'RecommendationDocument'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:AuthZ]

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

#get_spa_recommendations_with_shard(shard, service, opts = {}) ⇒ Object

Get SPA Recommendations with a shard parameter.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/spa_api.rb', line 102

def get_spa_recommendations_with_shard(shard, service, opts = {})
  data, _status_code, _headers = get_spa_recommendations_with_shard_with_http_info(shard, service, opts)
  data
end

#get_spa_recommendations_with_shard_with_http_info(shard, service, opts = {}) ⇒ Array<(RecommendationDocument, Integer, Hash)>

Get SPA Recommendations with a shard parameter.

This endpoint is currently experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job. The caller (Spark Gateway or DJM UI) provides a service name and shard identifier, and SPA returns structured recommendations for driver and executor resources.

Parameters:

  • shard (String) —

    The shard tag for a spark job, which differentiates jobs within the same service that have different resource needs

  • service (String) —

    The service name for a spark job

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

    the optional parameters

Options Hash (opts):

  • :bypass_cache (String) —

    The recommendation service should not use its metrics cache.

Returns:

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

    RecommendationDocument data, response status code and response headers



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
172
173
174
175
 
# File 'lib/datadog_api_client/v2/api/spa_api.rb', line 116

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpaAPI.get_spa_recommendations_with_shard ...'
  end
  # verify the required parameter 'shard' is set
  if @api_client.config.client_side_validation && shard.nil?
    fail ArgumentError, "Missing the required parameter 'shard' when calling SpaAPI.get_spa_recommendations_with_shard"
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling SpaAPI.get_spa_recommendations_with_shard"
  end
  # resource path
  local_var_path = '/api/v2/spa/recommendations/{service}/{shard}'.sub('{shard}', CGI.escape(shard.to_s).gsub('%2F', '/')).sub('{service}', CGI.escape(service.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'bypass_cache'] = opts[:'bypass_cache'] if !opts[:'bypass_cache'].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] || 'RecommendationDocument'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:AuthZ]

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