Class: Cadenya::Models::AgentListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cadenya/models/agent_list_params.rb

Overview

See Also:

• Resources::Agents#list

Defined Under Namespace

Modules: Status, VariationSelectionMode

Instance Attribute Summary

• #bundle_key ⇒ String^?

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

• #cursor ⇒ String^?

  Pagination cursor from previous response.

• #include_info ⇒ Boolean^?

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

• #limit ⇒ Integer^?

  Maximum number of results to return.

• #prefix ⇒ String^?

  Filter expression (query param: prefix).

• #query ⇒ String^?

  Free-form search query.

• #sort_order ⇒ String^?

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

• #status ⇒ Symbol, ...

  Filter by agent publication status.

• #variation_selection_mode ⇒ Symbol, ...

  Filter by variation selection mode.

• #workspace_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(workspace_id:, bundle_key: nil, cursor: nil, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, status: nil, variation_selection_mode: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AgentListParams 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(workspace_id:, bundle_key: nil, cursor: nil, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, status: nil, variation_selection_mode: nil, request_options: {}) ⇒ Object

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

Parameters:

• workspace_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 agent is populated. Requests

• 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)

• status (Symbol, Cadenya::Models::AgentListParams::Status) (defaults to: nil) —

  Filter by agent publication status

• variation_selection_mode (Symbol, Cadenya::Models::AgentListParams::VariationSelectionMode) (defaults to: nil) —

  Filter by variation selection mode

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

# File 'lib/cadenya/models/agent_list_params.rb', line 70

Instance Attribute Details

#bundle_key ⇒ String^?

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

Returns:

• (String, nil)

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

optional :bundle_key, String

#cursor ⇒ String^?

Pagination cursor from previous response

Returns:

• (String, nil)

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

optional :cursor, String

#include_info ⇒ Boolean^?

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

Returns:

• (Boolean, nil)

# File 'lib/cadenya/models/agent_list_params.rb', line 32

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

#limit ⇒ Integer^?

Maximum number of results to return

Returns:

• (Integer, nil)

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

optional :limit, Integer

#prefix ⇒ String^?

Filter expression (query param: prefix)

Returns:

• (String, nil)

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

optional :prefix, String

#query ⇒ String^?

Free-form search query

Returns:

• (String, nil)

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

optional :query, String

#sort_order ⇒ String^?

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

Returns:

• (String, nil)

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

optional :sort_order, String

#status ⇒ Symbol, ...

Filter by agent publication status

Returns:

• (Symbol, Cadenya::Models::AgentListParams::Status, nil)

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

optional :status, enum: -> { Cadenya::AgentListParams::Status }

#variation_selection_mode ⇒ Symbol, ...

Filter by variation selection mode

Returns:

• (Symbol, Cadenya::Models::AgentListParams::VariationSelectionMode, nil)

# File 'lib/cadenya/models/agent_list_params.rb', line 68

optional :variation_selection_mode, enum: -> { Cadenya::AgentListParams::VariationSelectionMode }

#workspace_id ⇒ String

Returns:

• (String)

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

required :workspace_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/cadenya/models/agent_list_params.rb', line 105