Class NamedTransformationCreateParams
-
- All Implemented Interfaces:
-
io.imagekit.core.Params
public final class NamedTransformationCreateParams implements Params
Creates a new named transformation and returns the created object.
A named transformation is a short, reusable name for a transformation string. Use it in image and video URLs as
tr:n-<name>, and update the underlying transformation later without changing existing URLs. Learn more about named transformations.You can create up to 250 named transformations per account.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classNamedTransformationCreateParams.BuilderA builder for NamedTransformationCreateParams.
public final classNamedTransformationCreateParams.Body
-
Method Summary
Modifier and Type Method Description final Stringname()Alias for the transformation string, used in URLs as tr:n-<name>.final Stringtransformation()The transformation string this named transformation refers to. final Optional<Boolean>enabled()Whether the named transformation is currently enabled. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_transformation()Returns the raw JSON value of transformation. final JsonField<Boolean>_enabled()Returns the raw JSON value of enabled. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final NamedTransformationCreateParams.BuildertoBuilder()final NamedTransformationCreateParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static NamedTransformationCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of NamedTransformationCreateParams. -
-
Method Detail
-
name
final String name()
Alias for the transformation string, used in URLs as
tr:n-<name>. This is case-sensitive, contains only alphanumeric characters or_(underscore), and is unique across all named transformations for your account.
-
transformation
final String transformation()
The transformation string this named transformation refers to. Learn more about the transformation string syntax.
-
enabled
final Optional<Boolean> enabled()
Whether the named transformation is currently enabled. When set to
false, requests using this named transformation fail at delivery time.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_transformation
final JsonField<String> _transformation()
Returns the raw JSON value of transformation.
Unlike transformation, this method doesn't throw if the JSON field has an unexpected type.
-
_enabled
final JsonField<Boolean> _enabled()
Returns the raw JSON value of enabled.
Unlike enabled, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final NamedTransformationCreateParams.Builder toBuilder()
-
_body
final NamedTransformationCreateParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static NamedTransformationCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of NamedTransformationCreateParams.
The following fields are required:
.name() .transformation()
-
-
-
-