Class: Cadenya::Models::ObjectiveListEventsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cadenya::Models::ObjectiveListEventsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cadenya/models/objective_list_events_params.rb,
sig/cadenya/models/objective_list_events_params.rbs

Overview

See Also:

• Cadenya::Resources::Objectives#list_events

Instance Attribute Summary

• #cursor ⇒ String^?

  Pagination cursor from previous response.

• #include_info ⇒ Boolean^?

  When set to true you may use more of your alloted API rate-limit.

• #labels ⇒ String^?

  Filters by metadata labels.

• #limit ⇒ Integer^?

  Maximum number of results to return.

• #objective_id ⇒ String
• #since_event_id ⇒ String^?

  Optional string to fetch events since an ID.

• #sort_order ⇒ String^?

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

• #window_id ⇒ String^?

  Optional context window ID to filter events by.

• #workspace_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(workspace_id:, objective_id:, cursor: nil, include_info: nil, labels: nil, limit: nil, since_event_id: nil, sort_order: nil, window_id: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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:, objective_id:, cursor: nil, include_info: nil, labels: nil, limit: nil, since_event_id: nil, sort_order: nil, window_id: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Pagination cursor from previous response

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

  When set to true you may use more of your alloted API rate-limit

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

  Filters by metadata labels. Comma-separated key=value pairs,

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

  Maximum number of results to return

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

  Optional string to fetch events since an ID

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

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

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

  Optional context window ID to filter events by

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

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

Instance Attribute Details

#cursor ⇒ String^?

Pagination cursor from previous response

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/cadenya/models/objective_list_events_params.rb', line 24

optional :cursor, String

#include_info ⇒ Boolean^?

When set to true you may use more of your alloted API rate-limit

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/cadenya/models/objective_list_events_params.rb', line 30

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

#labels ⇒ String^?

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :labels, String

#limit ⇒ Integer^?

Maximum number of results to return

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :limit, Integer

#objective_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/cadenya/models/objective_list_events_params.rb', line 18

required :objective_id, String

#since_event_id ⇒ String^?

Optional string to fetch events since an ID

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :since_event_id, String

#sort_order ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :sort_order, String

#window_id ⇒ String^?

Optional context window ID to filter events by

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :window_id, String

#workspace_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/cadenya/models/objective_list_events_params.rb', line 13

required :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/cadenya/models/objective_list_events_params.rbs', line 66

def to_hash: -> {