Class: Phoebe::Models::Data::Observations::Recent::SpecieRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(region_code:, species_code:, back: nil, hotspot: nil, include_provisional: nil, max_results: nil, r: nil, spp_locale: nil, request_options: {}) ⇒ Object

Parameters:

  • region_code (String)
  • species_code (String)
  • back (Integer) (defaults to: nil) —

    The number of days back to fetch observations.

  • hotspot (Boolean) (defaults to: nil) —

    Only fetch observations from hotspots

  • include_provisional (Boolean) (defaults to: nil) —

    Include observations which have not yet been reviewed.

  • max_results (Integer) (defaults to: nil) —

    Only fetch this number of observations

  • r (Array<String>) (defaults to: nil) —

    Fetch observations from up to 10 locations

  • spp_locale (String) (defaults to: nil) —

    Use this language for species common names

  • request_options (Phoebe::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 59

Instance Attribute Details

#back ⇒ Integer?

The number of days back to fetch observations.

Returns:

  • (Integer, nil) 


27
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 27

optional :back, Integer

#hotspot ⇒ Boolean?

Only fetch observations from hotspots

Returns:

  • (Boolean, nil) 


33
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 33

optional :hotspot, Phoebe::Internal::Type::Boolean

#include_provisional ⇒ Boolean?

Include observations which have not yet been reviewed.

Returns:

  • (Boolean, nil) 


39
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 39

optional :include_provisional, Phoebe::Internal::Type::Boolean

#max_results ⇒ Integer?

Only fetch this number of observations

Returns:

  • (Integer, nil) 


45
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 45

optional :max_results, Integer

#r ⇒ Array<String>?

Fetch observations from up to 10 locations

Returns:

  • (Array<String>, nil) 


51
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 51

optional :r, Phoebe::Internal::Type::ArrayOf[String]

#region_code ⇒ String

Returns:

  • (String) 


16
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 16

required :region_code, String

#species_code ⇒ String

Returns:

  • (String) 


21
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 21

required :species_code, String

#spp_locale ⇒ String?

Use this language for species common names

Returns:

  • (String, nil) 


57
 
# File 'lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb', line 57

optional :spp_locale, String