Class: Openlayer::Models::Projects::TestListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Openlayer::Models::Projects::TestListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openlayer/models/projects/test_list_params.rb

Overview

See Also:

• Resources::Projects::Tests#list

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #include_archived ⇒ Boolean^?

  Filter for archived tests.

• #origin_version_id ⇒ String^?

  Retrive tests created by a specific project version.

• #page ⇒ Integer^?

  The page to return in a paginated query.

• #per_page ⇒ Integer^?

  Maximum number of items to return per page.

• #project_id ⇒ String
• #suggested ⇒ Boolean^?

  Filter for suggested tests.

• #type ⇒ Symbol, ...

  Filter objects by test type.

• #uses_production_data ⇒ Boolean^?

  Retrive tests with usesProductionData (monitoring).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(project_id:, include_archived: nil, origin_version_id: nil, page: nil, per_page: nil, suggested: nil, type: nil, uses_production_data: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see TestListParams for more details.

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(project_id:, include_archived: nil, origin_version_id: nil, page: nil, per_page: nil, suggested: nil, type: nil, uses_production_data: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Openlayer::Models::Projects::TestListParams for more details.

Parameters:

• project_id (String)
• include_archived (Boolean) (defaults to: nil) —

  Filter for archived tests.

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

  Retrive tests created by a specific project version.

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

  The page to return in a paginated query.

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

  Maximum number of items to return per page.

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

  Filter for suggested tests.

• type (Symbol, Openlayer::Models::Projects::TestListParams::Type) (defaults to: nil) —

  Filter objects by test type. Available types are ‘integrity`, `consistency`, `pe

• uses_production_data (Boolean, nil) (defaults to: nil) —

  Retrive tests with usesProductionData (monitoring).

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

# File 'lib/openlayer/models/projects/test_list_params.rb', line 59

Instance Attribute Details

#include_archived ⇒ Boolean^?

Filter for archived tests.

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 20

optional :include_archived, Openlayer::Internal::Type::Boolean

#origin_version_id ⇒ String^?

Retrive tests created by a specific project version.

Returns:

• (String, nil)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 26

optional :origin_version_id, String, nil?: true

#page ⇒ Integer^?

The page to return in a paginated query.

Returns:

• (Integer, nil)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 32

optional :page, Integer

#per_page ⇒ Integer^?

Maximum number of items to return per page.

Returns:

• (Integer, nil)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 38

optional :per_page, Integer

#project_id ⇒ String

Returns:

• (String)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 14

required :project_id, String

#suggested ⇒ Boolean^?

Filter for suggested tests.

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 44

optional :suggested, Openlayer::Internal::Type::Boolean

#type ⇒ Symbol, ...

Filter objects by test type. Available types are ‘integrity`, `consistency`, `performance`, `fairness`, and `robustness`.

Returns:

• (Symbol, Openlayer::Models::Projects::TestListParams::Type, nil)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 51

optional :type, enum: -> { Openlayer::Projects::TestListParams::Type }

#uses_production_data ⇒ Boolean^?

Retrive tests with usesProductionData (monitoring).

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_list_params.rb', line 57

optional :uses_production_data, Openlayer::Internal::Type::Boolean, nil?: true