Class: Imagekitio::Models::CustomMetadataFieldUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Imagekitio::Models::CustomMetadataFieldUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/imagekitio/models/custom_metadata_field_update_params.rb,
sig/imagekitio/models/custom_metadata_field_update_params.rbs

Overview

See Also:

• Imagekitio::Resources::CustomMetadataFields#update

Defined Under Namespace

Classes: Schema

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Imagekitio

Instance Attribute Summary

• #description ⇒ String^?

  Optional description for the custom metadata field.

• #id ⇒ String
• #label ⇒ String^?

  Human readable name of the custom metadata field.

• #schema ⇒ Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema^?

  An object that describes the rules for the custom metadata key.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/imagekitio/models/custom_metadata_field_update_params.rbs', line 32

def initialize: (

Instance Attribute Details

#description ⇒ String^?

Optional description for the custom metadata field. Can be up to 500 characters. Send an empty string to clear an existing description. This is shown as a hint to the users while setting the field's value on an asset in the media library UI.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/imagekitio/models/custom_metadata_field_update_params.rb', line 22

optional :description, String

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/imagekitio/models/custom_metadata_field_update_params.rb', line 13

required :id, String

#label ⇒ String^?

Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. This parameter is required if schema is not provided.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :label, String

#schema ⇒ Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema^?

An object that describes the rules for the custom metadata key. This parameter is required if label is not provided. Note: type cannot be updated and will be ignored if sent with the schema. The schema will be validated as per the existing type.

Returns:

• (Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema, nil)

# File 'lib/imagekitio/models/custom_metadata_field_update_params.rb', line 40

optional :schema, -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/imagekitio/models/custom_metadata_field_update_params.rbs', line 40

def to_hash: -> {