Class: Anthropic::Models::Beta::Environments::WorkHeartbeatParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/beta/environments/work_heartbeat_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(environment_id:, work_id:, desired_ttl_seconds: nil, expected_last_heartbeat: nil, betas: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Anthropic::Models::Beta::Environments::WorkHeartbeatParams for more details.

Parameters:

  • environment_id (String)
  • work_id (String)
  • desired_ttl_seconds (Integer, nil) (defaults to: nil) —

    Desired TTL in seconds

  • expected_last_heartbeat (String, nil) (defaults to: nil) —

    Expected last_heartbeat for conditional update (optimistic concurrency). Use lit

  • betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) (defaults to: nil) —

    Optional header to specify the beta version(s) you want to use.

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



# File 'lib/anthropic/models/beta/environments/work_heartbeat_params.rb', line 43

Instance Attribute Details

#betas ⇒ Array<String, Symbol, Anthropic::Models::AnthropicBeta>?

Optional header to specify the beta version(s) you want to use.

Returns:



41
 
# File 'lib/anthropic/models/beta/environments/work_heartbeat_params.rb', line 41

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#desired_ttl_seconds ⇒ Integer?

Desired TTL in seconds

Returns:

  • (Integer, nil) 


26
 
# File 'lib/anthropic/models/beta/environments/work_heartbeat_params.rb', line 26

optional :desired_ttl_seconds, Integer, nil?: true

#environment_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/anthropic/models/beta/environments/work_heartbeat_params.rb', line 15

required :environment_id, String

#expected_last_heartbeat ⇒ String?

Expected last_heartbeat for conditional update (optimistic concurrency). Use literal ‘NO_HEARTBEAT’ to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server’s previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn’t match.

Returns:

  • (String, nil) 


35
 
# File 'lib/anthropic/models/beta/environments/work_heartbeat_params.rb', line 35

optional :expected_last_heartbeat, String, nil?: true

#work_id ⇒ String

Returns:

  • (String) 


20
 
# File 'lib/anthropic/models/beta/environments/work_heartbeat_params.rb', line 20

required :work_id, String