Kamelets API

camel.apache.org/v1alpha1

Package v1alpha1 contains API Schema definitions for the camel v1alpha1 API group

Resource Types

Kamelet

Kamelet is the Schema for the kamelets API

Field Description

apiVersion
string

camel.apache.org/v1alpha1

kind
string

Kamelet

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
KameletSpec

the desired specification

status
KameletStatus

the actual status of the resource

KameletBinding

KameletBinding is the Schema for the kamelets binding API

Field Description

apiVersion
string

camel.apache.org/v1alpha1

kind
string

KameletBinding

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
KameletBindingSpec

the specification of a KameletBinding

status
KameletBindingStatus

the status of a KameletBinding

Internal Types

BeanProperties

BeanProperties represent an unstructured object properties to be set on a bean

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

Endpoint

Appears on:

Endpoint represents a source/sink external entity (could be any Kubernetes resource or Camel URI)

Field Description

ref
Kubernetes core/v1.ObjectReference

Ref can be used to declare a Kubernetes resource as source/sink endpoint

uri
string

URI can be used to specify the (Camel) endpoint explicitly

properties
EndpointProperties

Properties are a key value representation of endpoint properties

types
map[github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventSlot]github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventTypeSpec

Types defines the schema of the data produced/consumed by the endpoint

EndpointProperties

Appears on:

EndpointProperties is a key/value struct represented as JSON raw to allow numeric/boolean values

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

EndpointType(string alias)

EndpointType represents the type (ie, source or sink)

ErrorHandler

ErrorHandler is a generic interface that represent any type of error handler specification

ErrorHandlerLog

Appears on:

ErrorHandlerLog represent a default (log) error handler type

Field Description

ErrorHandlerNone
ErrorHandlerNone

parameters
ErrorHandlerParameters

ErrorHandlerNone

Appears on:

ErrorHandlerNone — 

Field Description

ErrorHandlerParameters

Appears on:

ErrorHandlerParameters represent an unstructured object for error handler parameters

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

ErrorHandlerSink

ErrorHandlerSink represents a sink error handler type which behave like a dead letter channel

Field Description

ErrorHandlerLog
ErrorHandlerLog

endpoint
Endpoint

ErrorHandlerSpec

Appears on:

ErrorHandlerSpec represents an unstructured object for an error handler

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

ErrorHandlerType(string alias)

ErrorHandlerType a type of error handler (ie, sink)

EventSlot(string alias)

EventSlot represent a kind of data (ie, input, output, …​)

EventTypeSpec

Appears on:

EventTypeSpec represents a specification for an event type

Field Description

mediaType
string

media type as expected for HTTP media types (ie, application/json)

schema
JSONSchemaProps

the expected schema for the event

ExternalDocumentation

Appears on:

ExternalDocumentation allows referencing an external resource for extended documentation.

Field Description

description
string

url
string

JSON

Appears on:

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

JSONSchemaProp

Appears on:

Field Description

id
string

description
string

type
string

format
string

format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:

  • bsonobjectid: a bson object ID, i.e. a 24 characters hex string

  • uri: an URI as parsed by Golang net/url.ParseRequestURI

  • email: an email address as parsed by Golang net/mail.ParseAddress

  • hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].

  • ipv4: an IPv4 IP as parsed by Golang net.ParseIP

  • ipv6: an IPv6 IP as parsed by Golang net.ParseIP

  • cidr: a CIDR as parsed by Golang net.ParseCIDR

  • mac: a MAC address as parsed by Golang net.ParseMAC

  • uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

  • uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$

  • uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$

  • uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$

  • isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"

  • isbn10: an ISBN10 number string like "0321751043"

  • isbn13: an ISBN13 number string like "978-0321751041"

  • creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in

  • ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$

  • hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

  • rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"

  • byte: base64 encoded binary data

  • password: any kind of string

  • date: a date string like "2006-01-02" as defined by full-date in RFC3339

  • duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format

  • datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.

title
string

default
JSON

default is a default value for undefined object fields.

maximum
encoding/json.Number

exclusiveMaximum
bool

minimum
encoding/json.Number

exclusiveMinimum
bool

maxLength
int64

minLength
int64

pattern
string

maxItems
int64

minItems
int64

uniqueItems
bool

maxProperties
int64

minProperties
int64

multipleOf
encoding/json.Number

enum
[]JSON

example
JSON

nullable
bool

x-descriptors
[]string

XDescriptors is a list of extended properties that trigger a custom behavior in external systems

JSONSchemaProps

Appears on:

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

Field Description

id
string

description
string

title
string

properties
map[string]github.com/apache/camel-k/pkg/apis/camel/v1alpha1.JSONSchemaProp

required
[]string

example
JSON

externalDocs
ExternalDocumentation

$schema
JSONSchemaURL

type
string

JSONSchemaURL(string alias)

Appears on:

JSONSchemaURL represents a schema url.

KameletBindingCondition

Appears on:

KameletBindingCondition describes the state of a resource at a certain point.

Field Description

type
KameletBindingConditionType

Type of kameletBinding condition.

status
Kubernetes core/v1.ConditionStatus

Status of the condition, one of True, False, Unknown.

lastUpdateTime
Kubernetes meta/v1.Time

The last time this condition was updated.

lastTransitionTime
Kubernetes meta/v1.Time

Last time the condition transitioned from one status to another.

reason
string

The reason for the condition’s last transition.

message
string

A human readable message indicating details about the transition.

pods
[]github.com/apache/camel-k/pkg/apis/camel/v1.PodCondition

Pods collect health and conditions information from the owned PODs

KameletBindingConditionType(string alias)

Appears on:

KameletBindingConditionType — 

KameletBindingPhase(string alias)

Appears on:

KameletBindingPhase — 

KameletBindingSpec

Appears on:

KameletBindingSpec defines the binding between a source and a sink. It can include custom parameters and additional intermediate steps and error handling.

Field Description

integration
github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec

Integration is an optional integration used to specify custom parameters

source
Endpoint

Source is the starting point of the integration defined by this binding

sink
Endpoint

Sink is the destination of the integration defined by this binding

errorHandler
ErrorHandlerSpec

ErrorHandler is an optional handler called upon an error occuring in the integration

steps
[]Endpoint

Steps contains an optional list of intermediate steps that are executed between the Source and the Sink

replicas
int32

Replicas is the number of desired replicas for the binding

KameletBindingStatus

Appears on:

KameletBindingStatus specify the status of a binding

Field Description

observedGeneration
int64

ObservedGeneration is the most recent generation observed for this KameletBinding.

phase
KameletBindingPhase

Phase — 

conditions
[]KameletBindingCondition

Conditions — 

replicas
int32

Replicas is the number of actual replicas of the binding

selector
string

Selector allows to identify pods belonging to the binding

KameletCondition

Appears on:

KameletCondition describes the state of a resource at a certain point.

Field Description

type
KameletConditionType

Type of kamelet condition.

status
Kubernetes core/v1.ConditionStatus

Status of the condition, one of True, False, Unknown.

lastUpdateTime
Kubernetes meta/v1.Time

The last time this condition was updated.

lastTransitionTime
Kubernetes meta/v1.Time

Last time the condition transitioned from one status to another.

reason
string

The reason for the condition’s last transition.

message
string

A human-readable message indicating details about the transition.

KameletConditionType(string alias)

Appears on:

KameletConditionType — 

KameletPhase(string alias)

Appears on:

KameletPhase — 

KameletProperty

Appears on:

KameletProperty specify the behavior of a property in a Kamelet

Field Description

name
string

the name of the property

default
string

the default value of the property (if any)

KameletSpec

Appears on:

KameletSpec specifies the configuration required to execute a Kamelet

Field Description

definition
JSONSchemaProps

defines the formal configuration of the Kamelet

sources
[]github.com/apache/camel-k/pkg/apis/camel/v1.SourceSpec

sources in any Camel DSL supported

template
Template

the main source in YAML DSL

types
map[github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventSlot]github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventTypeSpec

data specification types for the events consumed/produced by the Kamelet

dependencies
[]string

Camel dependencies needed by the Kamelet

KameletStatus

Appears on:

KameletStatus defines the observed state of Kamelet

Field Description

observedGeneration
int64

ObservedGeneration is the most recent generation observed for this Kamelet.

phase
KameletPhase

Phase — 

conditions
[]KameletCondition

Conditions — 

properties
[]KameletProperty

Properties — 

RawMessage([]byte alias)

Appears on:

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

Template

Appears on:

Template is an unstructured object representing a Kamelet template in YAML/JSON DSL

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

an unstructured raw message