Class: Imagekitio::Models::CustomMetadataField::Schema

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/imagekitio/models/custom_metadata_field.rb,
sig/imagekitio/models/custom_metadata_field.rbs

Overview

See Also:

  • Imagekitio::Models::CustomMetadataField#schema

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, select_options: nil) ⇒ Object

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

An object that describes the rules for the custom metadata field value.

Parameters:

  • type (Symbol, Imagekitio::Models::CustomMetadataField::Schema::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. Data type of default value dep

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

    Specifies if the this 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

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

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




# File 'lib/imagekitio/models/custom_metadata_field.rb', line 127

Instance Attribute Details

#default_value ⇒ String, ...

The default value for this custom metadata field. Data type of default value depends on the field type.

Returns:

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


71
72
73
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 71

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

#is_value_required ⇒ Boolean?

Specifies if the this custom metadata field is required or not.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


79
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 79

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.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


85
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 85

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) 


93
94
95
96
97
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 93

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

#min_length ⇒ Float?

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

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


103
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 103

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) 


111
112
113
114
115
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 111

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

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

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

Returns:

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


121
122
123
124
125
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 121

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

#type ⇒ Symbol, Imagekitio::Models::CustomMetadataField::Schema::Type

Type of the custom metadata field.

Parameters:

  • value (Imagekitio::Models::CustomMetadataField::Schema::type_)

Returns:



64
 
# File 'lib/imagekitio/models/custom_metadata_field.rb', line 64

required :type, enum: -> { Imagekitio::CustomMetadataField::Schema::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/imagekitio/models/custom_metadata_field.rb', line 163

.variants ⇒ Array(String, Float)

Returns:

  • (Array(String, Float)) 



# File 'lib/imagekitio/models/custom_metadata_field.rb', line 218

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


103
 
# File 'sig/imagekitio/models/custom_metadata_field.rbs', line 103

def to_hash: -> {