Class: Orb::Models::Plans::MigrationRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/plans/migration_retrieve_response.rb,
sig/orb/models/plans/migration_retrieve_response.rbs

Overview

See Also:

  • Orb::Resources::Plans::Migrations#retrieve

Defined Under Namespace

Modules: EffectiveTime, Status

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id:, effective_time:, plan_id:, status:) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Plans::MigrationRetrieveResponse for more details.

Parameters:




# File 'lib/orb/models/plans/migration_retrieve_response.rb', line 36

Instance Attribute Details

#effective_time ⇒ Date, ...

When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled to be at the end of the current billing period.

Parameters:

  • value (Orb::Models::Plans::MigrationRetrieveResponse::effective_time, nil)

Returns:



19
20
21
 
# File 'lib/orb/models/plans/migration_retrieve_response.rb', line 19

required :effective_time,
union: -> { Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime },
nil?: true

#id ⇒ String

Unique identifier for this plan version change.

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/orb/models/plans/migration_retrieve_response.rb', line 12

required :id, String

#plan_id ⇒ String

The ID of the plan being migrated.

Parameters:

  • value (String)

Returns:

  • (String) 


27
 
# File 'lib/orb/models/plans/migration_retrieve_response.rb', line 27

required :plan_id, String

#status ⇒ Symbol, Orb::Models::Plans::MigrationRetrieveResponse::Status

Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed', or 'canceled'.

Parameters:

  • value (Orb::Models::Plans::MigrationRetrieveResponse::status)

Returns:



34
 
# File 'lib/orb/models/plans/migration_retrieve_response.rb', line 34

required :status, enum: -> { Orb::Models::Plans::MigrationRetrieveResponse::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


28
 
# File 'sig/orb/models/plans/migration_retrieve_response.rbs', line 28

def to_hash: -> {