Class WebhookEventType
-
- All Implemented Interfaces:
-
io.imagekit.core.Enum
public final class WebhookEventType implements EnumA webhook event type. Learn more about the payload of each webhook event.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumWebhookEventType.KnownAn enum containing WebhookEventType's known values.
public enumWebhookEventType.ValueAn enum containing WebhookEventType's known values, as well as an _UNKNOWN member.
An instance of WebhookEventType can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static WebhookEventTypeVIDEO_TRANSFORMATION_ACCEPTEDpublic final static WebhookEventTypeVIDEO_TRANSFORMATION_READYpublic final static WebhookEventTypeVIDEO_TRANSFORMATION_ERRORpublic final static WebhookEventTypeUPLOAD_PRE_TRANSFORM_SUCCESSpublic final static WebhookEventTypeUPLOAD_PRE_TRANSFORM_ERRORpublic final static WebhookEventTypeUPLOAD_POST_TRANSFORM_SUCCESSpublic final static WebhookEventTypeUPLOAD_POST_TRANSFORM_ERRORpublic final static WebhookEventTypeFILE_CREATEDpublic final static WebhookEventTypeFILE_UPDATEDpublic final static WebhookEventTypeFILE_DELETEDpublic final static WebhookEventTypeFILE_VERSION_CREATEDpublic final static WebhookEventTypeFILE_VERSION_DELETEDpublic final static WebhookEventTypeFOLDER_CREATEDpublic final static WebhookEventTypeFOLDER_UPDATEDpublic final static WebhookEventTypeFOLDER_DELETED
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final WebhookEventType.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final WebhookEventType.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Returns this class instance's primitive wire representation. final WebhookEventTypevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static WebhookEventTypeof(String value)-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final WebhookEventType.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final WebhookEventType.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final WebhookEventType validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
of
final static WebhookEventType of(String value)
-
-
-
-