Class: Imagekitio::Models::Accounts::URLEndpointRequest

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

Defined Under Namespace

Modules: URLRewriter

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(description: , origins: nil, url_prefix: nil, url_rewriter: nil) ⇒ Object

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

Schema for URL endpoint resource.

Parameters:



# File 'lib/imagekitio/models/accounts/url_endpoint_request.rb', line 36

Instance Attribute Details

#descriptionString

Description of the URL endpoint.

Returns:

  • (String)


11
# File 'lib/imagekitio/models/accounts/url_endpoint_request.rb', line 11

required :description, String

#originsArray<String>?

Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint.

Returns:

  • (Array<String>, nil)


19
# File 'lib/imagekitio/models/accounts/url_endpoint_request.rb', line 19

optional :origins, Imagekitio::Internal::Type::ArrayOf[String]

#url_prefixString?

Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint).

Returns:

  • (String, nil)


26
# File 'lib/imagekitio/models/accounts/url_endpoint_request.rb', line 26

optional :url_prefix, String, api_name: :urlPrefix

#url_rewriterImagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, ...

Configuration for third-party URL rewriting.



32
33
34
# File 'lib/imagekitio/models/accounts/url_endpoint_request.rb', line 32

optional :url_rewriter,
union: -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter },
api_name: :urlRewriter