Package com.stripe.param.v2.core

Class EventDestinationCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.v2.core.EventDestinationCreateParams

public class EventDestinationCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventDestinationCreateParams.AmazonEventbridge
static class	EventDestinationCreateParams.AzureEventGrid	Add all map key/value pairs to `extraParams` map.
static class	EventDestinationCreateParams.Builder
static enum	EventDestinationCreateParams.EventPayload	Required. The URL where Stripe sends matching events.
static enum	EventDestinationCreateParams.Include
static enum	EventDestinationCreateParams.Type
static class	EventDestinationCreateParams.WebhookEndpoint	Add all map key/value pairs to `extraParams` map.

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static EventDestinationCreateParams.Builder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
EventDestinationCreateParams.AmazonEventbridge	getAmazonEventbridge()	AWS account and region where Stripe creates the EventBridge partner event source.
EventDestinationCreateParams.AzureEventGrid	getAzureEventGrid()	Azure subscription, resource group, and region where Stripe creates the partner topic.
String	getDescription()	An optional user-defined description of the destination's purpose.
List<String>	getEnabledEvents()	Required. The list of event types enabled for delivery to this destination.
EventDestinationCreateParams.EventPayload	getEventPayload()	Required. Whether to deliver as snapshot or thin events.
List<String>	getEventsFrom()	The account or organization scopes that can supply events.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
List<EventDestinationCreateParams.Include>	getInclude()	Include normally redacted webhook fields in the create response.
Map<String,String>	getMetadata()	User-defined key/value data for the destination.
String	getName()	Required. A user-defined label for identifying the destination.
String	getSnapshotApiVersion()	For snapshot events only, the Stripe API version used to render event objects; do not provide this for thin events.
EventDestinationCreateParams.Type	getType()	Required. The delivery transport.
EventDestinationCreateParams.WebhookEndpoint	getWebhookEndpoint()	Delivery target for the webhook endpoint.
int	hashCode()

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static EventDestinationCreateParams.Builder builder()

getAmazonEventbridge

public EventDestinationCreateParams.AmazonEventbridge getAmazonEventbridge()

AWS account and region where Stripe creates the EventBridge partner event source.

getAzureEventGrid

public EventDestinationCreateParams.AzureEventGrid getAzureEventGrid()

Azure subscription, resource group, and region where Stripe creates the partner topic.

getDescription

public String getDescription()

An optional user-defined description of the destination's purpose.

getEnabledEvents

public List<String> getEnabledEvents()

Required. The list of event types enabled for delivery to this destination.

getEventPayload

public EventDestinationCreateParams.EventPayload getEventPayload()

Required. Whether to deliver as snapshot or thin events.

getEventsFrom

public List<String> getEventsFrom()

The account or organization scopes that can supply events. Use this with enabled_events to define the subscription. @self: Receive events from the account that owns the event destination. @accounts: Receive events emitted from other accounts you manage, including your v1 and v2 accounts. @organization_members: Receive events from accounts directly linked to the organization. @organization_members/@accounts: Receive events from all accounts connected to any platform accounts in the organization.

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getInclude

public List<EventDestinationCreateParams.Include> getInclude()

Include normally redacted webhook fields in the create response. Public API clients must include webhook_endpoint.signing_secret to receive the signing secret.

getMetadata

public Map<String,String> getMetadata()

User-defined key/value data for the destination.

getName

public String getName()

Required. A user-defined label for identifying the destination.

getSnapshotApiVersion

public String getSnapshotApiVersion()

For snapshot events only, the Stripe API version used to render event objects; do not provide this for thin events.

getType

public EventDestinationCreateParams.Type getType()

Required. The delivery transport. Chosen when the destination is created and cannot be changed by update.

getWebhookEndpoint

public EventDestinationCreateParams.WebhookEndpoint getWebhookEndpoint()

Delivery target for the webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object