Class: PipelinePublisher::StreamMetricsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pipeline_publisher_ruby/api/stream_metrics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StreamMetricsApi

Returns a new instance of StreamMetricsApi.



19
20
21
 
# File 'lib/pipeline_publisher_ruby/api/stream_metrics_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pipeline_publisher_ruby/api/stream_metrics_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#stream_metrics_get(opts = {}) ⇒ InlineResponse200

Fetches metrics about the stream

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :count_since_timestamp (String) —

    ISO 8601 compliant timestamp to perform message count calculations from. Example: 2018-04-12T23:54:57.595123Z

  • :count_until_timestamp (String) —

    ISO 8601 compliant timestamp to perform message count calculations until. Example: 2018-04-12T23:54:57.595123Z

Returns:



29
30
31
32
 
# File 'lib/pipeline_publisher_ruby/api/stream_metrics_api.rb', line 29

def stream_metrics_get(opts = {})
  data, _status_code, _headers = stream_metrics_get_with_http_info(opts)
  return data
end

#stream_metrics_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Fetches metrics about the stream

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :count_since_timestamp (String) —

    ISO 8601 compliant timestamp to perform message count calculations from. Example: 2018-04-12T23:54:57.595123Z

  • :count_until_timestamp (String) —

    ISO 8601 compliant timestamp to perform message count calculations until. Example: 2018-04-12T23:54:57.595123Z

Returns:

  • (Array<(InlineResponse200, Fixnum, Hash)>) —

    InlineResponse200 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
 
# File 'lib/pipeline_publisher_ruby/api/stream_metrics_api.rb', line 40

def stream_metrics_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StreamMetricsApi.stream_metrics_get ..."
  end
  # resource path
  local_var_path = "/stream_metrics"

  # query parameters
  query_params = {}
  query_params[:'count_since_timestamp'] = opts[:'count_since_timestamp'] if !opts[:'count_since_timestamp'].nil?
  query_params[:'count_until_timestamp'] = opts[:'count_until_timestamp'] if !opts[:'count_until_timestamp'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse200')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StreamMetricsApi#stream_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end