Class: Mindee::V2::Search::Models::ModelSearchParameters

Inherits:
ClientOptions::BaseSearchParameters show all
Defined in:
lib/mindee/v2/search/models/model_search_parameters.rb,
sig/mindee/v2/search/models/model_search_parameters.rbs

Overview

Search parameters for models.

Instance Attribute Summary collapse

Attributes inherited from ClientOptions::BaseSearchParameters

#page, #per_page

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ClientOptions::BaseSearchParameters

#slug

Constructor Details

#initialize(name: nil, model_type: nil, page: nil, per_page: nil) ⇒ ModelSearchParameters

Returns a new instance of ModelSearchParameters.

Parameters:

  • name (String, nil) (defaults to: nil) —

    Case-insensitive search term for the model name.

  • model_type (String, nil) (defaults to: nil) —

    Case-insensitive search term for the model type.

  • page (Integer, nil) (defaults to: nil) —

    1-based page index.

  • per_page (Integer, nil) (defaults to: nil) —

    Number of items per page.

  • name: (String, nil) (defaults to: nil)
  • model_type: (String, nil) (defaults to: nil)
  • page: (Integer, nil) (defaults to: nil)
  • per_page: (Integer, nil) (defaults to: nil) 


19
20
21
22
23
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 19

def initialize(name: nil, model_type: nil, page: nil, per_page: nil)
  super(page: page, per_page: per_page)
  @name = name
  @model_type = model_type
end

Instance Attribute Details

#model_type ⇒ String? (readonly)

Returns Case-insensitive search term for the model type.

Returns:

  • (String, nil) —

    Case-insensitive search term for the model type.



13
14
15
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 13

def model_type
  @model_type
end

#name ⇒ String? (readonly)

Returns Case-insensitive search term for the model name.

Returns:

  • (String, nil) —

    Case-insensitive search term for the model name.



10
11
12
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 10

def name
  @name
end

Class Method Details

.response_class ⇒ Class<Mindee::V2::Search::Models::ModelSearchResponse>

Returns Response class for the search.

Returns:



31
32
33
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 31

def self.response_class
  ModelSearchResponse
end

.slug ⇒ String

Returns Slug of searchable resources.

Returns:

  • (String) —

    Slug of searchable resources.



26
27
28
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 26

def self.slug
  'models'
end

Instance Method Details

#request_parameters ⇒ Hash{String => String, Array<String>}

Gets the request parameters for the search request.

Returns:

  • (Hash{String => String, Array<String>}) 


37
38
39
40
41
42
43
44
45
46
 
# File 'lib/mindee/v2/search/models/model_search_parameters.rb', line 37

def request_parameters
  params = super

  name = @name
  model_type = @model_type
  params['name'] = name unless name.nil?
  params['model_type'] = model_type unless model_type.nil?

  params
end

#response_class ⇒ singleton(ModelSearchResponse)

Returns:



15
 
# File 'sig/mindee/v2/search/models/model_search_parameters.rbs', line 15

def response_class: -> singleton(ModelSearchResponse)