Class: Falcon::FieldSchema

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FieldSchema

Returns a new instance of FieldSchema.



36
37
38
 
# File 'lib/crimson-falcon/api/field_schema.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/field_schema.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#fdrschema_entities_field_get(opts = {}) ⇒ SchemaSensorFieldResponseV1

Fetch field schema by ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Specify feed IDs to fetch

Returns:



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

def fdrschema_entities_field_get(opts = {})
  data, _status_code, _headers = fdrschema_entities_field_get_with_http_info(opts)
  data
end

#fdrschema_entities_field_get_with_http_info(opts = {}) ⇒ Array<(SchemaSensorFieldResponseV1, Integer, Hash)>

Fetch field schema by ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Specify feed IDs to fetch

Returns:

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

    SchemaSensorFieldResponseV1 data, response status code and response headers



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

def fdrschema_entities_field_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldSchema.fdrschema_entities_field_get ...'
  end
  # resource path
  local_var_path = '/fdr/entities/schema-fields/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].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] || 'SchemaSensorFieldResponseV1'

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

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

#fdrschema_queries_field_get(opts = {}) ⇒ MsaspecQueryResponse

Get list of field IDs given a particular query.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limit of the data

  • :offset (Integer) —

    Offset into the data

  • :filter (String) —

    FQL filter of the data

  • :sort (String) —

    Sort the data

Returns:



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

def fdrschema_queries_field_get(opts = {})
  data, _status_code, _headers = fdrschema_queries_field_get_with_http_info(opts)
  data
end

#fdrschema_queries_field_get_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Get list of field IDs given a particular query.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limit of the data

  • :offset (Integer) —

    Offset into the data

  • :filter (String) —

    FQL filter of the data

  • :sort (String) —

    Sort the data

Returns:

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

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

def fdrschema_queries_field_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldSchema.fdrschema_queries_field_get ...'
  end
  # resource path
  local_var_path = '/fdr/queries/schema-fields/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'MsaspecQueryResponse'

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

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