Class: Cadenya::Models::Agents::ScheduleListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cadenya/models/agents/schedule_list_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(workspace_id:, agent_id:, bundle_key: nil, cursor: nil, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::Agents::ScheduleListParams for more details.

Parameters:

  • workspace_id (String)
  • agent_id (String)
  • bundle_key (String) (defaults to: nil) —

    Filter by bundle_key — return only resources owned by this bundle.

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

    Pagination cursor from previous response.

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

    When true, the ‘info` field on each returned schedule is populated.

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

    Maximum number of results to return.

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

    Filter expression (query param: prefix).

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

    Free-form search query.

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

    Sort order for results (asc or desc by creation time).

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



# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 64

Instance Attribute Details

#agent_id ⇒ String

Returns:

  • (String) 


19
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 19

required :agent_id, String

#bundle_key ⇒ String?

Filter by bundle_key — return only resources owned by this bundle.

Returns:

  • (String, nil) 


25
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 25

optional :bundle_key, String

#cursor ⇒ String?

Pagination cursor from previous response.

Returns:

  • (String, nil) 


31
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 31

optional :cursor, String

#include_info ⇒ Boolean?

When true, the ‘info` field on each returned schedule is populated. Requests with this flag count more against your rate limit.

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 38

optional :include_info, Cadenya::Internal::Type::Boolean

#limit ⇒ Integer?

Maximum number of results to return.

Returns:

  • (Integer, nil) 


44
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 44

optional :limit, Integer

#prefix ⇒ String?

Filter expression (query param: prefix).

Returns:

  • (String, nil) 


50
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 50

optional :prefix, String

#query ⇒ String?

Free-form search query.

Returns:

  • (String, nil) 


56
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 56

optional :query, String

#sort_order ⇒ String?

Sort order for results (asc or desc by creation time).

Returns:

  • (String, nil) 


62
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 62

optional :sort_order, String

#workspace_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/cadenya/models/agents/schedule_list_params.rb', line 14

required :workspace_id, String