Class: Falcon::FederatedConnections

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FederatedConnections

Returns a new instance of FederatedConnections.



35
36
37
 
# File 'lib/crimson-falcon/api/federated_connections.rb', line 35

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/federated_connections.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#delete_federated_connections_config(connection_id, opts = {}) ⇒ nil

Delete configuration for a federated connection

Parameters:

  • connection_id (String) —

    Connection ID to delete configuration for

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

    the optional parameters

Returns:

  • (nil) 


42
43
44
45
 
# File 'lib/crimson-falcon/api/federated_connections.rb', line 42

def delete_federated_connections_config(connection_id, opts = {})
  delete_federated_connections_config_with_http_info(connection_id, opts)
  nil
end

#delete_federated_connections_config_with_http_info(connection_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete configuration for a federated connection

Parameters:

  • connection_id (String) —

    Connection ID to delete configuration for

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_federated_connections_config_with_http_info(connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FederatedConnections.delete_federated_connections_config ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling FederatedConnections.delete_federated_connections_config"
  end
  # resource path
  local_var_path = '/ngsiem/entities/federated-connections-config/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'connection_id'] = connection_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]

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

  new_options = opts.merge(
    :operation => :"FederatedConnections.delete_federated_connections_config",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FederatedConnections#delete_federated_connections_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_federated_connections_config(connection_id, body, opts = {}) ⇒ ClientFederatedConnectionConfigResponseV1

Update configuration for a federated connection

Parameters:

Returns:



105
106
107
108
 
# File 'lib/crimson-falcon/api/federated_connections.rb', line 105

def patch_federated_connections_config(connection_id, body, opts = {})
  data, _status_code, _headers = patch_federated_connections_config_with_http_info(connection_id, body, opts)
  data
end

#patch_federated_connections_config_with_http_info(connection_id, body, opts = {}) ⇒ Array<(ClientFederatedConnectionConfigResponseV1, Integer, Hash)>

Update configuration for a federated connection

Parameters:

Returns:



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
167
168
169
170
171
 
# File 'lib/crimson-falcon/api/federated_connections.rb', line 115

def patch_federated_connections_config_with_http_info(connection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FederatedConnections.patch_federated_connections_config ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling FederatedConnections.patch_federated_connections_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 FederatedConnections.patch_federated_connections_config"
  end
  # resource path
  local_var_path = '/ngsiem/entities/federated-connections-config/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'connection_id'] = connection_id

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  new_options = opts.merge(
    :operation => :"FederatedConnections.patch_federated_connections_config",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FederatedConnections#patch_federated_connections_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_federated_connections_config(body, opts = {}) ⇒ ClientFederatedConnectionConfigResponseV1

Create configuration for a federated connection

Parameters:

Returns:



177
178
179
180
 
# File 'lib/crimson-falcon/api/federated_connections.rb', line 177

def post_federated_connections_config(body, opts = {})
  data, _status_code, _headers = post_federated_connections_config_with_http_info(body, opts)
  data
end

#post_federated_connections_config_with_http_info(body, opts = {}) ⇒ Array<(ClientFederatedConnectionConfigResponseV1, Integer, Hash)>

Create configuration for a federated connection

Parameters:

Returns:



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

def post_federated_connections_config_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FederatedConnections.post_federated_connections_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 FederatedConnections.post_federated_connections_config"
  end
  # resource path
  local_var_path = '/ngsiem/entities/federated-connections-config/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

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