Package ai.extend.types

Class WebhookEndpointCreate.Builder

java.lang.Object

ai.extend.types.WebhookEndpointCreate.Builder

All Implemented Interfaces:

WebhookEndpointCreate._FinalStage, WebhookEndpointCreate.ApiVersionStage, WebhookEndpointCreate.CreatedAtStage, WebhookEndpointCreate.IdStage, WebhookEndpointCreate.NameStage, WebhookEndpointCreate.SigningSecretStage, WebhookEndpointCreate.StatusStage, WebhookEndpointCreate.UrlStage

Enclosing class:

WebhookEndpointCreate

public static final class WebhookEndpointCreate.Builder
extends java.lang.Object
implements WebhookEndpointCreate.IdStage, WebhookEndpointCreate.UrlStage, WebhookEndpointCreate.NameStage, WebhookEndpointCreate.StatusStage, WebhookEndpointCreate.ApiVersionStage, WebhookEndpointCreate.SigningSecretStage, WebhookEndpointCreate.CreatedAtStage, WebhookEndpointCreate._FinalStage

Method Summary

Modifier and Type	Method	Description
WebhookEndpointCreate._FinalStage	addAllEnabledEvents(java.util.List<WebhookEndpointEventType> enabledEvents)	The list of event types this endpoint is subscribed to at the global level.
WebhookEndpointCreate._FinalStage	addEnabledEvents(WebhookEndpointEventType enabledEvents)	The list of event types this endpoint is subscribed to at the global level.
WebhookEndpointCreate._FinalStage	advancedOptions(Nullable<WebhookAdvancedOptions> advancedOptions)	Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.
WebhookEndpointCreate._FinalStage	advancedOptions(WebhookAdvancedOptions advancedOptions)	Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.
WebhookEndpointCreate._FinalStage	advancedOptions(java.util.Optional<WebhookAdvancedOptions> advancedOptions)	Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.
WebhookEndpointCreate.SigningSecretStage	apiVersion(ApiVersionEnum apiVersion)
WebhookEndpointCreate	build()
WebhookEndpointCreate._FinalStage	createdAt(java.time.OffsetDateTime createdAt)	The date and time the webhook endpoint was created.
WebhookEndpointCreate._FinalStage	enabledEvents(java.util.List<WebhookEndpointEventType> enabledEvents)	The list of event types this endpoint is subscribed to at the global level.
WebhookEndpointCreate.Builder	from(WebhookEndpointCreate other)
WebhookEndpointCreate.UrlStage	id(java.lang.String id)	Unique identifier for the webhook endpoint.
WebhookEndpointCreate.StatusStage	name(java.lang.String name)	A human-readable name for the webhook endpoint.
WebhookEndpointCreate.CreatedAtStage	signingSecret(java.lang.String signingSecret)	The signing secret used to verify webhook payloads.
WebhookEndpointCreate.ApiVersionStage	status(WebhookEndpointStatus status)
WebhookEndpointCreate.NameStage	url(java.lang.String url)	The URL that webhook events are sent to.

Methods inherited from class java.lang.Object

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

Method Detail

from

public WebhookEndpointCreate.Builder from(WebhookEndpointCreate other)

Specified by:

from in interface WebhookEndpointCreate.IdStage

id

public WebhookEndpointCreate.UrlStage id(@NotNull
                                         java.lang.String id)

Unique identifier for the webhook endpoint.

Unique identifier for the webhook endpoint.

Specified by:

id in interface WebhookEndpointCreate.IdStage

Returns:

Reference to this so that method calls can be chained together.

url

public WebhookEndpointCreate.NameStage url(@NotNull
                                           java.lang.String url)

The URL that webhook events are sent to.

The URL that webhook events are sent to.

Specified by:

url in interface WebhookEndpointCreate.UrlStage

Returns:

Reference to this so that method calls can be chained together.

name

public WebhookEndpointCreate.StatusStage name(@NotNull
                                              java.lang.String name)

A human-readable name for the webhook endpoint.

A human-readable name for the webhook endpoint.

Specified by:

name in interface WebhookEndpointCreate.NameStage

Returns:

Reference to this so that method calls can be chained together.

status

public WebhookEndpointCreate.ApiVersionStage status(@NotNull
                                                    WebhookEndpointStatus status)

Specified by:

status in interface WebhookEndpointCreate.StatusStage

apiVersion

public WebhookEndpointCreate.SigningSecretStage apiVersion(@NotNull
                                                           ApiVersionEnum apiVersion)

Specified by:

apiVersion in interface WebhookEndpointCreate.ApiVersionStage

signingSecret

public WebhookEndpointCreate.CreatedAtStage signingSecret(@NotNull
                                                          java.lang.String signingSecret)

The signing secret used to verify webhook payloads. This is only returned when creating the endpoint and cannot be retrieved again.

Store it securely — you will need it to verify webhook signatures.

The signing secret used to verify webhook payloads. This is only returned when creating the endpoint and cannot be retrieved again.

Store it securely — you will need it to verify webhook signatures.

Specified by:

signingSecret in interface WebhookEndpointCreate.SigningSecretStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public WebhookEndpointCreate._FinalStage createdAt(@NotNull
                                                   java.time.OffsetDateTime createdAt)

The date and time the webhook endpoint was created.

The date and time the webhook endpoint was created.

Specified by:

createdAt in interface WebhookEndpointCreate.CreatedAtStage

Returns:

Reference to this so that method calls can be chained together.

advancedOptions

public WebhookEndpointCreate._FinalStage advancedOptions(Nullable<WebhookAdvancedOptions> advancedOptions)

Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.

Specified by:

advancedOptions in interface WebhookEndpointCreate._FinalStage

Returns:

Reference to this so that method calls can be chained together.

advancedOptions

public WebhookEndpointCreate._FinalStage advancedOptions(WebhookAdvancedOptions advancedOptions)

Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.

Specified by:

advancedOptions in interface WebhookEndpointCreate._FinalStage

Returns:

Reference to this so that method calls can be chained together.

advancedOptions

public WebhookEndpointCreate._FinalStage advancedOptions(java.util.Optional<WebhookAdvancedOptions> advancedOptions)

Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.

Specified by:

advancedOptions in interface WebhookEndpointCreate._FinalStage

addAllEnabledEvents

public WebhookEndpointCreate._FinalStage addAllEnabledEvents(java.util.List<WebhookEndpointEventType> enabledEvents)

The list of event types this endpoint is subscribed to at the global level. These are events that are not scoped to a specific resource.

Specified by:

addAllEnabledEvents in interface WebhookEndpointCreate._FinalStage

Returns:

Reference to this so that method calls can be chained together.

addEnabledEvents

public WebhookEndpointCreate._FinalStage addEnabledEvents(WebhookEndpointEventType enabledEvents)

The list of event types this endpoint is subscribed to at the global level. These are events that are not scoped to a specific resource.

Specified by:

addEnabledEvents in interface WebhookEndpointCreate._FinalStage

Returns:

Reference to this so that method calls can be chained together.

enabledEvents

public WebhookEndpointCreate._FinalStage enabledEvents(java.util.List<WebhookEndpointEventType> enabledEvents)

The list of event types this endpoint is subscribed to at the global level. These are events that are not scoped to a specific resource.

Specified by:

enabledEvents in interface WebhookEndpointCreate._FinalStage

build

public WebhookEndpointCreate build()

Specified by:

build in interface WebhookEndpointCreate._FinalStage