Class: Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice

Defined in:

lib/moonbase/models/collections/field_update_params.rb

Defined Under Namespace

Modules: Cardinality Classes: Option

Instance Attribute Summary

• #cardinality ⇒ Symbol, ...

  Updated cardinality: ‘one` or `many`.

• #default_values ⇒ Array<Moonbase::Models::ChoiceValueParam>^?
• #description ⇒ String^?

  An updated description, or ‘null` to clear it.

• #name ⇒ String^?

  The new name for the field.

• #options ⇒ Array<Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice::Option>^?

  The complete set of options for this field.

• #required ⇒ Boolean^?

  If ‘true`, items must have a value for this field.

• #type ⇒ Symbol, :"field/choice"

  The field type.

• #unique ⇒ Boolean^?

  If ‘true`, values must be unique across all items.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(cardinality: nil, default_values: nil, description: nil, name: nil, options: nil, required: nil, unique: nil, type: :"field/choice") ⇒ Object constructor

  Some parameter documentations has been truncated, see FieldChoice for more details.

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(cardinality: nil, default_values: nil, description: nil, name: nil, options: nil, required: nil, unique: nil, type: :"field/choice") ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice for more details.

Parameters for updating a choice field.

Parameters:

• cardinality (Symbol, Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice::Cardinality) (defaults to: nil) —

  Updated cardinality: ‘one` or `many`.

• default_values (Array<Moonbase::Models::ChoiceValueParam>, nil) (defaults to: nil)
• description (String, nil) (defaults to: nil) —

  An updated description, or ‘null` to clear it.

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

  The new name for the field.

• options (Array<Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice::Option>) (defaults to: nil) —

  The complete set of options for this field. Omit to leave unchanged. Array order

• required (Boolean) (defaults to: nil) —

  If ‘true`, items must have a value for this field.

• unique (Boolean) (defaults to: nil) —

  If ‘true`, values must be unique across all items.

• type (Symbol, :"field/choice") (defaults to: :"field/choice") —

  The field type. Must be ‘field/choice`.

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1468

Instance Attribute Details

#cardinality ⇒ Symbol, ...

Updated cardinality: ‘one` or `many`.

Returns:

• (Symbol, Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice::Cardinality, nil)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1424

optional :cardinality,
enum: -> { Moonbase::Collections::FieldUpdateParams::Field::FieldChoice::Cardinality }

#default_values ⇒ Array<Moonbase::Models::ChoiceValueParam>^?

Returns:

• (Array<Moonbase::Models::ChoiceValueParam>, nil)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1430

optional :default_values,
-> {
  Moonbase::Internal::Type::ArrayOf[Moonbase::ChoiceValueParam]
},
nil?: true

#description ⇒ String^?

An updated description, or ‘null` to clear it.

Returns:

• (String, nil)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1440

optional :description, String, nil?: true

#name ⇒ String^?

The new name for the field.

Returns:

• (String, nil)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1446

optional :name, String

#options ⇒ Array<Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice::Option>^?

The complete set of options for this field. Omit to leave unchanged. Array order determines display order.

Returns:

• (Array<Moonbase::Models::Collections::FieldUpdateParams::Field::FieldChoice::Option>, nil)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1453

optional :options,
-> { Moonbase::Internal::Type::ArrayOf[Moonbase::Collections::FieldUpdateParams::Field::FieldChoice::Option] }

#required ⇒ Boolean^?

If ‘true`, items must have a value for this field.

Returns:

• (Boolean, nil)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1460

optional :required, Moonbase::Internal::Type::Boolean

#type ⇒ Symbol, :"field/choice"

The field type. Must be ‘field/choice`.

Returns:

• (Symbol, :"field/choice")

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1418

required :type, const: :"field/choice"

#unique ⇒ Boolean^?

If ‘true`, values must be unique across all items.

Returns:

• (Boolean, nil)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1466

optional :unique, Moonbase::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/moonbase/models/collections/field_update_params.rb', line 1500