Package com.google.genai.types
Class WebhookConfig
-
- All Implemented Interfaces:
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 public abstract classWebhookConfig.BuilderBuilder for WebhookConfig.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description WebhookConfig()
-
Method Summary
Modifier and Type Method Description 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. static WebhookConfig.Builderbuilder()Instantiates a builder for WebhookConfig. abstract WebhookConfig.BuildertoBuilder()Creates a builder with the same values as this instance. static WebhookConfigfromJson(String jsonString)Deserializes a JSON string to a WebhookConfig object. -
Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
uris
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
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
static WebhookConfig.Builder builder()
Instantiates a builder for WebhookConfig.
-
toBuilder
abstract WebhookConfig.Builder toBuilder()
Creates a builder with the same values as this instance.
-
fromJson
static WebhookConfig fromJson(String jsonString)
Deserializes a JSON string to a WebhookConfig object.
-
-
-
-