Class: Falcon::EventStreamsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/event_streams_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventStreamsApi

Returns a new instance of EventStreamsApi.



36
37
38
 
# File 'lib/crimson-falcon/api/event_streams_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/event_streams_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#list_available_streams_o_auth2(app_id, opts = {}) ⇒ MainDiscoveryResponseV2

Discover all event streams in your environment

Parameters:

  • app_id (String) —

    Label that identifies your connection. Max: 32 alphanumeric characters (a-z, A-Z, 0-9).

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Format for streaming events. Valid values: json, flatjson

Returns:



44
45
46
47
 
# File 'lib/crimson-falcon/api/event_streams_api.rb', line 44

def list_available_streams_o_auth2(app_id, opts = {})
  data, _status_code, _headers = list_available_streams_o_auth2_with_http_info(app_id, opts)
  data
end

#list_available_streams_o_auth2_with_http_info(app_id, opts = {}) ⇒ Array<(MainDiscoveryResponseV2, Integer, Hash)>

Discover all event streams in your environment

Parameters:

  • app_id (String) —

    Label that identifies your connection. Max: 32 alphanumeric characters (a-z, A-Z, 0-9).

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Format for streaming events. Valid values: json, flatjson

Returns:

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

    MainDiscoveryResponseV2 data, response status code and response headers



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
 
# File 'lib/crimson-falcon/api/event_streams_api.rb', line 54

def list_available_streams_o_auth2_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventStreamsApi.list_available_streams_o_auth2 ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EventStreamsApi.list_available_streams_o_auth2"
  end
  # resource path
  local_var_path = '/sensors/entities/datafeed/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'appId'] = app_id
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].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] || 'MainDiscoveryResponseV2'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#refresh_active_stream_session(action_name, app_id, partition, opts = {}) ⇒ MsaReplyMetaOnly

Refresh an active event stream. Use the URL shown in a GET /sensors/entities/datafeed/v2 response.

Parameters:

  • action_name (String) —

    Action name. Allowed value is refresh_active_stream_session.

  • app_id (String) —

    Label that identifies your connection. Max: 32 alphanumeric characters (a-z, A-Z, 0-9).

  • partition (Integer) —

    Partition to request data for.

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

    the optional parameters

Returns:



110
111
112
113
 
# File 'lib/crimson-falcon/api/event_streams_api.rb', line 110

def refresh_active_stream_session(action_name, app_id, partition, opts = {})
  data, _status_code, _headers = refresh_active_stream_session_with_http_info(action_name, app_id, partition, opts)
  data
end

#refresh_active_stream_session_with_http_info(action_name, app_id, partition, opts = {}) ⇒ Array<(MsaReplyMetaOnly, Integer, Hash)>

Refresh an active event stream. Use the URL shown in a GET /sensors/entities/datafeed/v2 response.

Parameters:

  • action_name (String) —

    Action name. Allowed value is refresh_active_stream_session.

  • app_id (String) —

    Label that identifies your connection. Max: 32 alphanumeric characters (a-z, A-Z, 0-9).

  • partition (Integer) —

    Partition to request data for.

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

    the optional parameters

Returns:

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

    MsaReplyMetaOnly data, response status code and response headers



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
176
177
 
# File 'lib/crimson-falcon/api/event_streams_api.rb', line 121

def refresh_active_stream_session_with_http_info(action_name, app_id, partition, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventStreamsApi.refresh_active_stream_session ...'
  end
  # verify the required parameter 'action_name' is set
  if @api_client.config.client_side_validation && action_name.nil?
    fail ArgumentError, "Missing the required parameter 'action_name' when calling EventStreamsApi.refresh_active_stream_session"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling EventStreamsApi.refresh_active_stream_session"
  end
  # verify the required parameter 'partition' is set
  if @api_client.config.client_side_validation && partition.nil?
    fail ArgumentError, "Missing the required parameter 'partition' when calling EventStreamsApi.refresh_active_stream_session"
  end
  # resource path
  local_var_path = '/sensors/entities/datafeed-actions/v1/{partition}'.sub('{' + 'partition' + '}', CGI.escape(partition.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action_name'] = action_name
  query_params[:'appId'] = app_id

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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