Class: Cadenya::Models::ObjectiveCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cadenya/models/objective_create_params.rb

Overview

See Also:

• Resources::Objectives#create

Instance Attribute Summary

• #agent_id ⇒ String
• #data ⇒ Cadenya::Models::ObjectiveData
• #metadata ⇒ Cadenya::Models::CreateOperationMetadata

  CreateOperationMetadata contains the user-provided fields for creating an operation.

• #variation_id ⇒ String^?

  Optional explicit variation selection.

• #workspace_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(workspace_id:, agent_id:, data:, metadata:, variation_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ObjectiveCreateParams 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:, agent_id:, data:, metadata:, variation_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• workspace_id (String)
• agent_id (String)
• data (Cadenya::Models::ObjectiveData)
• metadata (Cadenya::Models::CreateOperationMetadata) —

  CreateOperationMetadata contains the user-provided fields for creating

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

  Optional explicit variation selection. Overrides the agent’s variation_selection

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

# File 'lib/cadenya/models/objective_create_params.rb', line 40

Instance Attribute Details

#agent_id ⇒ String

Returns:

• (String)

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

required :agent_id, String, api_name: :agentId

#data ⇒ Cadenya::Models::ObjectiveData

Returns:

• (Cadenya::Models::ObjectiveData)

# File 'lib/cadenya/models/objective_create_params.rb', line 23

required :data, -> { Cadenya::ObjectiveData }

#metadata ⇒ Cadenya::Models::CreateOperationMetadata

CreateOperationMetadata contains the user-provided fields for creating an operation. Read-only fields (id, account_id, workspace_id, created_at, profile_id) are excluded since they are set by the server.

Returns:

• (Cadenya::Models::CreateOperationMetadata)

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

required :metadata, -> { Cadenya::CreateOperationMetadata }

#variation_id ⇒ String^?

Optional explicit variation selection. Overrides the agent’s variation_selection_mode.

Returns:

• (String, nil)

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

optional :variation_id, String, api_name: :variationId

#workspace_id ⇒ String

Returns:

• (String)

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

required :workspace_id, String