Class: Telnyx::Models::AI::ClusterRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/ai/cluster_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(task_id:, show_subclusters: nil, top_n_nodes: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::ClusterRetrieveParams for more details.

Parameters:

  • task_id (String)
  • show_subclusters (Boolean) (defaults to: nil) —

    Whether or not to include subclusters and their nodes in the response.

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

    The number of nodes in the cluster to return in the response. Nodes will be sort

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



# File 'lib/telnyx/models/ai/cluster_retrieve_params.rb', line 29

Instance Attribute Details

#show_subclusters ⇒ Boolean?

Whether or not to include subclusters and their nodes in the response.

Returns:

  • (Boolean, nil) 


20
 
# File 'lib/telnyx/models/ai/cluster_retrieve_params.rb', line 20

optional :show_subclusters, Telnyx::Internal::Type::Boolean

#task_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/ai/cluster_retrieve_params.rb', line 14

required :task_id, String

#top_n_nodes ⇒ Integer?

The number of nodes in the cluster to return in the response. Nodes will be sorted by their centrality within the cluster.

Returns:

  • (Integer, nil) 


27
 
# File 'lib/telnyx/models/ai/cluster_retrieve_params.rb', line 27

optional :top_n_nodes, Integer