Class: Falcon::NetworkScanGlobalConfigs

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NetworkScanGlobalConfigs

Returns a new instance of NetworkScanGlobalConfigs.



35
36
37
 
# File 'lib/crimson-falcon/api/network_scan_global_configs.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/network_scan_global_configs.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#get_global_configs(opts = {}) ⇒ DomainGlobalConfigEntitiesResponse

Get "global-configs" for the CID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User UUID

Returns:



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

def get_global_configs(opts = {})
  data, _status_code, _headers = get_global_configs_with_http_info(opts)
  data
end

#get_global_configs_with_http_info(opts = {}) ⇒ Array<(DomainGlobalConfigEntitiesResponse, Integer, Hash)>

Get &quot;global-configs&quot; for the CID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User UUID

Returns:



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

def get_global_configs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkScanGlobalConfigs.get_global_configs ...'
  end
  # resource path
  local_var_path = '/netscan/entities/global-configs/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'])
  header_params[:'X-CS-USERUUID'] = opts[:'x_cs_useruuid'] if !opts[:'x_cs_useruuid'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DomainGlobalConfigEntitiesResponse'

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

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

#update_global_configs(body, opts = {}) ⇒ DomainGlobalConfigEntitiesResponse

Update "global-configs" using provided specifications

Parameters:

  • body (DomainGlobalConfigUpdateRequest) —

    &quot;global-configs&quot; specifications for updating

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User UUID

Returns:



101
102
103
104
 
# File 'lib/crimson-falcon/api/network_scan_global_configs.rb', line 101

def update_global_configs(body, opts = {})
  data, _status_code, _headers = update_global_configs_with_http_info(body, opts)
  data
end

#update_global_configs_with_http_info(body, opts = {}) ⇒ Array<(DomainGlobalConfigEntitiesResponse, Integer, Hash)>

Update &quot;global-configs&quot; using provided specifications

Parameters:

  • body (DomainGlobalConfigUpdateRequest) —

    &quot;global-configs&quot; specifications for updating

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User UUID

Returns:



111
112
113
114
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
 
# File 'lib/crimson-falcon/api/network_scan_global_configs.rb', line 111

def update_global_configs_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkScanGlobalConfigs.update_global_configs ...'
  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 NetworkScanGlobalConfigs.update_global_configs"
  end
  # resource path
  local_var_path = '/netscan/entities/global-configs/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
  header_params[:'X-CS-USERUUID'] = opts[:'x_cs_useruuid'] if !opts[:'x_cs_useruuid'].nil?

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

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

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