EventGatewayModifyHeaderAction

An action that modifies a header.

One Of
opstringrequired

Allowed values:remove

keystringrequired

The key of the header to remove.

Example

EventGatewayModifyHeaderRemoveAction

object

An action that removes a header by key.

opstringrequired

Allowed values:remove

keystringrequired

The key of the header to remove.

Example

EventGatewayModifyHeaderSetAction

object

An action that sets a header key and value.

opstringrequired

Allowed values:set

keystringrequired

The key of the header to set.

valuestringrequired

The value of the header to set.

Example

Schema Validation

object

A policy that validates consume messages against a schema registry.

typestringrequired

The type name of the policy.

Allowed values:schema_validation

>= 1 characters<= 255 characters

namestring

A unique user-defined name of the policy.

<= 255 characters

descriptionstring

A human-readable description of the policy.

Default:

<= 512 characters

enabledboolean

Whether the policy is enabled.

Default:true

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the schema validation policy.

Show Child Parameters
conditionstring

A string containing the boolean expression that determines whether the policy is applied.

Default:

<= 1000 characters

Example:context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] == "a-value"

Example

Schema Validation

object

A policy that validates produce messages against a schema registry.

typestringrequired

The type name of the policy.

Allowed values:schema_validation

>= 1 characters<= 255 characters

namestring

A unique user-defined name of the policy.

<= 255 characters

descriptionstring

A human-readable description of the policy.

Default:

<= 512 characters

enabledboolean

Whether the policy is enabled.

Default:true

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configOne Of
objectrequired

The configuration of the policy.

EventGatewayProduceSchemaValidationPolicySchemaRegistryConfigobject

The configuration of the produce schema validation policy when using a schema registry.

Show Child Parameters
conditionstring

A string containing the boolean expression that determines whether the policy is applied.

Default:

<= 1000 characters

Example:context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] == "a-value"

Example