Class NamedTransformationUpdateParams
-
- All Implemented Interfaces:
-
io.imagekit.core.Params
public final class NamedTransformationUpdateParams implements Params
Updates the named transformation identified by
idand returns the updated object. Only the fields present in the request body are updated; other fields stay unchanged.Renaming or disabling a named transformation fails with a
409error if it is still referenced (via then-<name>token) by an upload pre-transformation or post-transformation setting. This check is best-effort and can't detect references in your own application code or in previously generated URLs.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classNamedTransformationUpdateParams.BuilderA builder for NamedTransformationUpdateParams.
public final classNamedTransformationUpdateParams.Body
-
Method Summary
Modifier and Type Method Description final Optional<String>id()Unique identifier for a named transformation. final Optional<Boolean>enabled()Whether the named transformation is enabled. final Optional<String>name()Alias for the transformation string, used in URLs as tr:n-<name>.final Optional<String>transformation()The transformation string this named transformation refers to. final JsonField<Boolean>_enabled()Returns the raw JSON value of enabled. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_transformation()Returns the raw JSON value of transformation. 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 NamedTransformationUpdateParams.BuildertoBuilder()final NamedTransformationUpdateParams.Body_body()final String_pathParam(Integer index)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 NamedTransformationUpdateParamsnone()final static NamedTransformationUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of NamedTransformationUpdateParams. -
-
Method Detail
-
enabled
final Optional<Boolean> enabled()
Whether the named transformation is enabled. Omit to leave the current value unchanged.
-
name
final Optional<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 Optional<String> transformation()
The transformation string this named transformation refers to. Learn more about the transformation string syntax.
-
_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.
-
_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.
-
_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 NamedTransformationUpdateParams.Builder toBuilder()
-
_body
final NamedTransformationUpdateParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_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.
-
none
final static NamedTransformationUpdateParams none()
-
builder
final static NamedTransformationUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of NamedTransformationUpdateParams.
-
-
-
-