Package com.google.genai.types

Class WebhookConfig

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebhookConfig.Builder	Builder for WebhookConfig.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WebhookConfig()

Method Summary

Modifier and Type	Method	Description
static WebhookConfig.Builder	builder()	Instantiates a builder for WebhookConfig.
static WebhookConfig	fromJson(String jsonString)	Deserializes a JSON string to a WebhookConfig object.
abstract WebhookConfig.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<List<String>>	uris()	The webhook URIs to receive notifications.
abstract Optional<Map<String,Object>>	userMetadata()	User metadata that will be included in each webhook event notification.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebhookConfig

public WebhookConfig()

Method Details

uris

public abstract Optional<List<String>> uris()

The webhook URIs to receive notifications. If set, these webhook URIs will be used instead of the registered webhooks.

userMetadata

public abstract Optional<Map<String,Object>> userMetadata()

User metadata that will be included in each webhook event notification. Use this to attach custom key-value data to correlate webhook events with your internal systems.

builder

public static WebhookConfig.Builder builder()

Instantiates a builder for WebhookConfig.

toBuilder

public abstract WebhookConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static WebhookConfig fromJson(String jsonString)

Deserializes a JSON string to a WebhookConfig object.