Class: Imagekitio::Models::SelectedFieldsSchemaItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/imagekitio/models/selected_fields_schema.rb

Defined Under Namespace

Modules: DefaultValue, MaxValue, MinValue, SelectOption, Type

Instance Attribute Summary collapse

Class Method 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(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) ⇒ Object

Some parameter documentations has been truncated, see Imagekitio::Models::SelectedFieldsSchemaItem for more details.

Parameters:

  • type (Symbol, Imagekitio::Models::SelectedFieldsSchemaItem::Type) —

    Type of the custom metadata field.

  • default_value (String, Float, Boolean, Array<String, Float, Boolean>) (defaults to: nil) —

    The default value for this custom metadata field. The value should match the ‘ty

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

    Specifies if the custom metadata field is required or not.

  • max_length (Float) (defaults to: nil) —

    Maximum length of string. Only set if ‘type` is set to `Text` or `Textarea`.

  • max_value (String, Float) (defaults to: nil) —

    Maximum value of the field. Only set if field type is ‘Date` or `Number`. For `D

  • min_length (Float) (defaults to: nil) —

    Minimum length of string. Only set if ‘type` is set to `Text` or `Textarea`.

  • min_value (String, Float) (defaults to: nil) —

    Minimum value of the field. Only set if field type is ‘Date` or `Number`. For `D

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

    Indicates whether the custom metadata field is read only. A read only field cann

  • select_options (Array<String, Float, Boolean>) (defaults to: nil) —

    An array of allowed values when field type is ‘SingleSelect` or `MultiSelect`.

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

    Specifies if the selectOptions array is truncated. It is truncated when number o




# File 'lib/imagekitio/models/selected_fields_schema.rb', line 82

Instance Attribute Details

#default_value ⇒ String, ...

The default value for this custom metadata field. The value should match the ‘type` of custom metadata field.

Returns:

  • (String, Float, Boolean, Array<String, Float, Boolean>, nil) 


17
18
19
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 17

optional :default_value,
union: -> { Imagekitio::SelectedFieldsSchemaItem::DefaultValue },
api_name: :defaultValue

#is_value_required ⇒ Boolean?

Specifies if the custom metadata field is required or not.

Returns:

  • (Boolean, nil) 


25
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 25

optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired

#max_length ⇒ Float?

Maximum length of string. Only set if ‘type` is set to `Text` or `Textarea`.

Returns:

  • (Float, nil) 


31
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 31

optional :max_length, Float, api_name: :maxLength

#max_value ⇒ String, ...

Maximum value of the field. Only set if field type is ‘Date` or `Number`. For `Date` type field, the value will be in ISO8601 string format. For `Number` type field, it will be a numeric value.

Returns:

  • (String, Float, nil) 


39
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 39

optional :max_value, union: -> { Imagekitio::SelectedFieldsSchemaItem::MaxValue }, api_name: :maxValue

#min_length ⇒ Float?

Minimum length of string. Only set if ‘type` is set to `Text` or `Textarea`.

Returns:

  • (Float, nil) 


45
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 45

optional :min_length, Float, api_name: :minLength

#min_value ⇒ String, ...

Minimum value of the field. Only set if field type is ‘Date` or `Number`. For `Date` type field, the value will be in ISO8601 string format. For `Number` type field, it will be a numeric value.

Returns:

  • (String, Float, nil) 


53
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 53

optional :min_value, union: -> { Imagekitio::SelectedFieldsSchemaItem::MinValue }, api_name: :minValue

#read_only ⇒ Boolean?

Indicates whether the custom metadata field is read only. A read only field cannot be modified after being set. This field is configurable only via the **Path policy** feature.

Returns:

  • (Boolean, nil) 


61
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 61

optional :read_only, Imagekitio::Internal::Type::Boolean, api_name: :readOnly

#select_options ⇒ Array<String, Float, Boolean>?

An array of allowed values when field type is ‘SingleSelect` or `MultiSelect`.

Returns:

  • (Array<String, Float, Boolean>, nil) 


67
68
69
70
71
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 67

optional :select_options,
-> {
  Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::SelectedFieldsSchemaItem::SelectOption]
},
api_name: :selectOptions

#select_options_truncated ⇒ Boolean?

Specifies if the selectOptions array is truncated. It is truncated when number of options are > 100.

Returns:

  • (Boolean, nil) 


78
79
80
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 78

optional :select_options_truncated,
Imagekitio::Internal::Type::Boolean,
api_name: :selectOptionsTruncated

#type ⇒ Symbol, Imagekitio::Models::SelectedFieldsSchemaItem::Type

Type of the custom metadata field.

Returns:



10
 
# File 'lib/imagekitio/models/selected_fields_schema.rb', line 10

required :type, enum: -> { Imagekitio::SelectedFieldsSchemaItem::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/imagekitio/models/selected_fields_schema.rb', line 120

.variants ⇒ Array(String, Float)

Returns:

  • (Array(String, Float)) 



# File 'lib/imagekitio/models/selected_fields_schema.rb', line 175