google-genai/com.google.genai.types/WebhookConfig

WebhookConfig

public abstract class WebhookConfig extends JsonSerializable

Configuration for webhook notifications.

Used to configure webhook endpoints that will receive notifications when long-running operations (e.g., batch jobs, video generation) complete.

Constructors

Link copied to clipboard
public void WebhookConfig()

Types

Link copied to clipboard
public abstract class Builder
Builder for WebhookConfig.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public static WebhookConfig.Builder builder()
Instantiates a builder for WebhookConfig.
Link copied to clipboard
public static WebhookConfig fromJson(String jsonString)
Deserializes a JSON string to a WebhookConfig object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract WebhookConfig.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<List<String>> uris()
The webhook URIs to receive notifications.
Link copied to clipboard
public abstract Optional<Map<String, Object>> userMetadata()
User metadata that will be included in each webhook event notification.