Camel K API

Packages:

camel.apache.org/v1

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

Resource Types:

Build

Build is the Schema for the builds API

Field Description
apiVersion
string
camel.apache.org/v1
kind
string
Build
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
BuildSpec


tasks
[]Task
timeout
Kubernetes meta/v1.Duration

Timeout defines the Build maximum execution duration. The Build deadline is set to the Build start time plus the Timeout duration. If the Build deadline is exceeded, the Build context is canceled, and its phase set to BuildPhaseFailed.

status
BuildStatus

CamelCatalog

CamelCatalog is the Schema for the camelcatalogs API

Field Description
apiVersion
string
camel.apache.org/v1
kind
string
CamelCatalog
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
status
CamelCatalogStatus
spec
CamelCatalogSpec


Integration

Integration is the Schema for the integrations API

Field Description
apiVersion
string
camel.apache.org/v1
kind
string
Integration
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
IntegrationSpec


replicas
int32
sources
[]SourceSpec
flows
[]Flow
resources
[]ResourceSpec
kit
string

Deprecated: use the IntegrationKit field

integrationKit
Kubernetes core/v1.ObjectReference
dependencies
[]string
profile
TraitProfile
traits
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec
template
PodSpecTemplate
configuration
[]ConfigurationSpec
repositories
[]string
serviceAccountName
string
status
IntegrationStatus

IntegrationKit

IntegrationKit is the Schema for the integrationkits API

Field Description
apiVersion
string
camel.apache.org/v1
kind
string
IntegrationKit
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
IntegrationKitSpec


image
string
dependencies
[]string
profile
TraitProfile
traits
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec
configuration
[]ConfigurationSpec
repositories
[]string
status
IntegrationKitStatus

IntegrationPlatform

IntegrationPlatform is the Schema for the integrationplatforms API

Field Description
apiVersion
string
camel.apache.org/v1
kind
string
IntegrationPlatform
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
IntegrationPlatformSpec


status
IntegrationPlatformStatus

Artifact

(Appears on: BuildStatus, IntegrationKitStatus)

Artifact –

Field Description
id
string
location
string
target
string
checksum
string

BaseTask

(Appears on: BuildahTask, BuilderTask, KanikoTask, S2iTask, SpectrumTask)

BaseTask –

Field Description
name
string

BuildCondition

(Appears on: BuildStatus)

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

Field Description
type
BuildConditionType

Type of integration 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.

BuildConditionType (string alias)

(Appears on: BuildCondition)

BuildConditionType –

BuildPhase (string alias)

(Appears on: BuildStatus)

BuildPhase –

BuildSpec

(Appears on: Build)

BuildSpec defines the Build to be executed

Field Description
tasks
[]Task
timeout
Kubernetes meta/v1.Duration

Timeout defines the Build maximum execution duration. The Build deadline is set to the Build start time plus the Timeout duration. If the Build deadline is exceeded, the Build context is canceled, and its phase set to BuildPhaseFailed.

BuildStatus

(Appears on: Build)

BuildStatus defines the observed state of Build

Field Description
phase
BuildPhase
image
string
digest
string
baseImage
string
artifacts
[]Artifact
error
string
failure
Failure
startedAt
Kubernetes meta/v1.Time
platform
string
conditions
[]BuildCondition
duration
string

Change to Duration / ISO 8601 when CRD uses OpenAPI spec v3 https://github.com/OAI/OpenAPI-Specification/issues/845

BuildahTask

(Appears on: Task)

BuildahTask –

Field Description
BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

PublishTask
PublishTask

(Members of PublishTask are embedded into this type.)

verbose
bool
httpProxySecret
string

BuilderTask

(Appears on: Task)

BuilderTask –

Field Description
BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

baseImage
string
runtime
RuntimeSpec
sources
[]SourceSpec
resources
[]ResourceSpec
dependencies
[]string
steps
[]string
maven
MavenSpec
buildDir
string

CamelArtifact

(Appears on: CamelCatalogSpec)

CamelArtifact –

Field Description
CamelArtifactDependency
CamelArtifactDependency

(Members of CamelArtifactDependency are embedded into this type.)

schemes
[]CamelScheme
languages
[]string
dataformats
[]string
dependencies
[]CamelArtifactDependency
javaTypes
[]string

CamelArtifactDependency

(Appears on: CamelArtifact, CamelSchemeScope)

CamelArtifactDependency represent a maven’s dependency

Field Description
MavenArtifact
MavenArtifact

(Members of MavenArtifact are embedded into this type.)

exclusions
[]CamelArtifactExclusion

CamelArtifactExclusion

(Appears on: CamelArtifactDependency)

CamelArtifactExclusion –

Field Description
groupId
string
artifactId
string

CamelCatalogSpec

(Appears on: CamelCatalog)

CamelCatalogSpec defines the desired state of CamelCatalog

CamelCatalogStatus

(Appears on: CamelCatalog)

CamelCatalogStatus defines the observed state of CamelCatalog

CamelLoader

(Appears on: CamelCatalogSpec)

CamelLoader –

Field Description
MavenArtifact
MavenArtifact

(Members of MavenArtifact are embedded into this type.)

languages
[]string
dependencies
[]MavenArtifact

CamelScheme

(Appears on: CamelArtifact)

CamelScheme –

Field Description
id
string
passive
bool
http
bool
consumer
CamelSchemeScope
producer
CamelSchemeScope

CamelSchemeScope

(Appears on: CamelScheme)

CamelSchemeScope contains scoped information about a scheme

Field Description
dependencies
[]CamelArtifactDependency

Capability

(Appears on: RuntimeSpec)

Capability –

Field Description
dependencies
[]MavenArtifact
metadata
map[string]string

Configurable

Configurable –

ConfigurationSpec

(Appears on: IntegrationKitSpec, IntegrationPlatformSpec, IntegrationSpec, IntegrationStatus)

ConfigurationSpec –

Field Description
type
string
value
string
resourceType
string
resourceMountPoint
string
resourceKey
string

DataSpec

(Appears on: ResourceSpec, SourceSpec)

DataSpec –

Field Description
name
string
path
string
content
string
rawContent
[]byte
contentRef
string
contentKey
string
contentType
string
compression
bool

Failure

(Appears on: BuildStatus, IntegrationKitStatus, IntegrationStatus)

Failure –

Field Description
reason
string
time
Kubernetes meta/v1.Time
recovery
FailureRecovery

FailureRecovery

(Appears on: Failure)

FailureRecovery –

Field Description
attempt
int
attemptMax
int
attemptTime
Kubernetes meta/v1.Time
(Optional)

Flow

(Appears on: IntegrationSpec, KameletSpec)

Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL

Field Description
RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

IntegrationCondition

(Appears on: IntegrationStatus)

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

Field Description
type
IntegrationConditionType

Type of integration 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.

firstTruthyTime
Kubernetes meta/v1.Time

First time the condition status transitioned to True.

reason
string

The reason for the condition’s last transition.

message
string

A human readable message indicating details about the transition.

IntegrationConditionType (string alias)

(Appears on: IntegrationCondition)

IntegrationConditionType –

IntegrationKitCondition

(Appears on: IntegrationKitStatus)

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

Field Description
type
IntegrationKitConditionType

Type of integration 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.

IntegrationKitConditionType (string alias)

(Appears on: IntegrationKitCondition)

IntegrationKitConditionType –

IntegrationKitPhase (string alias)

(Appears on: IntegrationKitStatus)

IntegrationKitPhase –

IntegrationKitSpec

(Appears on: IntegrationKit)

IntegrationKitSpec defines the desired state of IntegrationKit

Field Description
image
string
dependencies
[]string
profile
TraitProfile
traits
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec
configuration
[]ConfigurationSpec
repositories
[]string

IntegrationKitStatus

(Appears on: IntegrationKit)

IntegrationKitStatus defines the observed state of IntegrationKit

Field Description
phase
IntegrationKitPhase
baseImage
string
image
string
digest
string
artifacts
[]Artifact
failure
Failure
runtimeVersion
string
runtimeProvider
RuntimeProvider
platform
string
conditions
[]IntegrationKitCondition
version
string

IntegrationPhase (string alias)

(Appears on: IntegrationStatus)

IntegrationPhase –

IntegrationPlatformBuildPublishStrategy (string alias)

(Appears on: IntegrationPlatformBuildSpec)

IntegrationPlatformBuildPublishStrategy enumerates all implemented publish strategies

IntegrationPlatformBuildSpec

(Appears on: IntegrationPlatformSpec)

IntegrationPlatformBuildSpec contains platform related build information

Field Description
buildStrategy
IntegrationPlatformBuildStrategy
publishStrategy
IntegrationPlatformBuildPublishStrategy
runtimeVersion
string
runtimeProvider
RuntimeProvider
baseImage
string
registry
IntegrationPlatformRegistrySpec
timeout
Kubernetes meta/v1.Duration
persistentVolumeClaim
string
maven
MavenSpec
httpProxySecret
string
kanikoBuildCache
bool

IntegrationPlatformBuildStrategy (string alias)

(Appears on: IntegrationPlatformBuildSpec)

IntegrationPlatformBuildStrategy enumerates all implemented build strategies

IntegrationPlatformCluster (string alias)

(Appears on: IntegrationPlatformSpec)

IntegrationPlatformCluster is the kind of orchestration cluster the platform is installed into

IntegrationPlatformCondition

(Appears on: IntegrationPlatformStatus)

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

Field Description
type
IntegrationPlatformConditionType

Type of integration 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.

IntegrationPlatformConditionType (string alias)

(Appears on: IntegrationPlatformCondition)

IntegrationPlatformConditionType –

IntegrationPlatformKameletRepositorySpec

(Appears on: IntegrationPlatformKameletSpec)

IntegrationPlatformKameletRepositorySpec –

Field Description
uri
string

IntegrationPlatformKameletSpec

(Appears on: IntegrationPlatformSpec)

IntegrationPlatformKameletSpec –

Field Description
repositories
[]IntegrationPlatformKameletRepositorySpec

IntegrationPlatformPhase (string alias)

(Appears on: IntegrationPlatformStatus)

IntegrationPlatformPhase –

IntegrationPlatformRegistrySpec

(Appears on: IntegrationPlatformBuildSpec, PublishTask)

IntegrationPlatformRegistrySpec –

Field Description
insecure
bool
address
string
secret
string
ca
string
organization
string

IntegrationPlatformResourcesSpec

(Appears on: IntegrationPlatformSpec)

IntegrationPlatformResourcesSpec contains platform related resources

IntegrationPlatformSpec

(Appears on: IntegrationPlatform, IntegrationPlatformStatus)

IntegrationPlatformSpec defines the desired state of IntegrationPlatform

IntegrationPlatformStatus

(Appears on: IntegrationPlatform)

IntegrationPlatformStatus defines the observed state of IntegrationPlatform

Field Description
IntegrationPlatformSpec
IntegrationPlatformSpec

(Members of IntegrationPlatformSpec are embedded into this type.)

phase
IntegrationPlatformPhase
conditions
[]IntegrationPlatformCondition
version
string

IntegrationSpec

(Appears on: Integration, KameletBindingSpec)

IntegrationSpec defines the desired state of Integration

Field Description
replicas
int32
sources
[]SourceSpec
flows
[]Flow
resources
[]ResourceSpec
kit
string

Deprecated: use the IntegrationKit field

integrationKit
Kubernetes core/v1.ObjectReference
dependencies
[]string
profile
TraitProfile
traits
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec
template
PodSpecTemplate
configuration
[]ConfigurationSpec
repositories
[]string
serviceAccountName
string

IntegrationStatus

(Appears on: Integration)

IntegrationStatus defines the observed state of Integration

Field Description
phase
IntegrationPhase
digest
string
image
string
dependencies
[]string
profile
TraitProfile
kit
string

Deprecated: use the IntegrationKit field

integrationKit
Kubernetes core/v1.ObjectReference
platform
string
generatedSources
[]SourceSpec
generatedResources
[]ResourceSpec
failure
Failure
runtimeVersion
string
runtimeProvider
RuntimeProvider
configuration
[]ConfigurationSpec
conditions
[]IntegrationCondition
version
string
replicas
int32
selector
string
capabilities
[]string
lastInitTimestamp
Kubernetes meta/v1.Time

The timestamp representing the last time when this integration was initialized.

KanikoTask

(Appears on: Task)

KanikoTask –

Field Description
BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

PublishTask
PublishTask

(Members of PublishTask are embedded into this type.)

verbose
bool
httpProxySecret
string
cache
KanikoTaskCache

KanikoTaskCache

(Appears on: KanikoTask)

KanikoTaskCache –

Field Description
enabled
bool
persistentVolumeClaim
string

Language (string alias)

(Appears on: SourceSpec)

Language –

MavenArtifact

(Appears on: CamelArtifactDependency, CamelLoader, Capability, RuntimeSpec)

MavenArtifact –

Field Description
groupId
string
artifactId
string
version
string

MavenSpec

(Appears on: BuilderTask, IntegrationPlatformBuildSpec)

MavenSpec –

Field Description
localRepository
string

The path of the local Maven repository.

properties
map[string]string

The Maven properties.

settings
ValueSource

A reference to the ConfigMap or Secret key that contains the Maven settings.

caSecret
Kubernetes core/v1.SecretKeySelector

The Secret name and key, containing the CA certificate(s) used to connect to remote Maven repositories. It can contain X.509 certificates, and PKCS#7 formatted certificate chains. A JKS formatted keystore is automatically created to store the CA certificate(s), and configured to be used as a trusted certificate(s) by the Maven commands. Note that the root CA certificates are also imported into the created keystore.

timeout
Kubernetes meta/v1.Duration

Deprecated: use IntegrationPlatform.Spec.Build.Timeout instead

repositories
[]Repository

PlatformInjectable

PlatformInjectable –

PodSpec

(Appears on: PodSpecTemplate)

Field Description
volumes
[]Kubernetes core/v1.Volume
initContainers
[]Kubernetes core/v1.Container
containers
[]Kubernetes core/v1.Container
ephemeralContainers
[]Kubernetes core/v1.EphemeralContainer
restartPolicy
Kubernetes core/v1.RestartPolicy
terminationGracePeriodSeconds
int64
activeDeadlineSeconds
int64
dnsPolicy
Kubernetes core/v1.DNSPolicy
nodeSelector
map[string]string
topologySpreadConstraints
[]Kubernetes core/v1.TopologySpreadConstraint

PodSpecTemplate

(Appears on: IntegrationSpec)

Field Description
spec
PodSpec


volumes
[]Kubernetes core/v1.Volume
initContainers
[]Kubernetes core/v1.Container
containers
[]Kubernetes core/v1.Container
ephemeralContainers
[]Kubernetes core/v1.EphemeralContainer
restartPolicy
Kubernetes core/v1.RestartPolicy
terminationGracePeriodSeconds
int64
activeDeadlineSeconds
int64
dnsPolicy
Kubernetes core/v1.DNSPolicy
nodeSelector
map[string]string
topologySpreadConstraints
[]Kubernetes core/v1.TopologySpreadConstraint

PublishTask

(Appears on: BuildahTask, KanikoTask, SpectrumTask)

PublishTask –

Field Description
contextDir
string
baseImage
string
image
string
registry
IntegrationPlatformRegistrySpec

RawMessage ([]byte alias)

(Appears on: BeanProperties, EndpointProperties, ErrorHandlerParameters, ErrorHandlerRef, ErrorHandlerSpec, Flow, TraitConfiguration)

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.

Repository

(Appears on: MavenSpec)

Repository –

Field Description
id
string
name
string
url
string
snapshots
RepositoryPolicy
releases
RepositoryPolicy

RepositoryPolicy

(Appears on: Repository)

RepositoryPolicy –

Field Description
enabled
bool
updatePolicy
string
checksumPolicy
string

ResourceCondition

ResourceCondition is a common type for all conditions

ResourceSpec

(Appears on: BuilderTask, IntegrationSpec, IntegrationStatus)

ResourceSpec –

Field Description
DataSpec
DataSpec

(Members of DataSpec are embedded into this type.)

type
ResourceType
mountPath
string

ResourceType (string alias)

(Appears on: ResourceSpec)

ResourceType –

RuntimeProvider (string alias)

(Appears on: IntegrationKitStatus, IntegrationPlatformBuildSpec, IntegrationStatus, RuntimeSpec)

RuntimeProvider –

RuntimeSpec

(Appears on: BuilderTask, CamelCatalogSpec)

RuntimeSpec –

Field Description
version
string
provider
RuntimeProvider
applicationClass
string
dependencies
[]MavenArtifact
metadata
map[string]string
capabilities
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.Capability

S2iTask

(Appears on: Task)

S2iTask –

Field Description
BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

contextDir
string
tag
string

SourceSpec

(Appears on: BuilderTask, IntegrationSpec, IntegrationStatus, KameletSpec)

SourceSpec –

Field Description
DataSpec
DataSpec

(Members of DataSpec are embedded into this type.)

language
Language
loader
string

Loader is an optional id of the org.apache.camel.k.RoutesLoader that will interpret this source at runtime

interceptors
[]string

Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader uses to pre/post process sources

type
SourceType

Type defines the kind of source described by this object

property-names
[]string

List of property names defined in the source (e.g. if type is “template”)

SourceType (string alias)

(Appears on: SourceSpec)

SpectrumTask

(Appears on: Task)

SpectrumTask –

Field Description
BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

PublishTask
PublishTask

(Members of PublishTask are embedded into this type.)

Task

(Appears on: BuildSpec)

Task –

Field Description
builder
BuilderTask
buildah
BuildahTask
kaniko
KanikoTask
spectrum
SpectrumTask
s2i
S2iTask

TraitConfiguration

(Appears on: TraitSpec)

Field Description
RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

TraitProfile (string alias)

(Appears on: IntegrationKitSpec, IntegrationPlatformSpec, IntegrationSpec, IntegrationStatus)

TraitProfile represents lists of traits that are enabled for the specific installation/integration

TraitSpec

(Appears on: IntegrationKitSpec, IntegrationPlatformSpec, IntegrationSpec)

A TraitSpec contains the configuration of a trait

Field Description
configuration
TraitConfiguration

TraitConfiguration –

ValueSource

(Appears on: MavenSpec)

ValueSource –

Field Description
configMapKeyRef
Kubernetes core/v1.ConfigMapKeySelector

Selects a key of a ConfigMap.

secretKeyRef
Kubernetes core/v1.SecretKeySelector

Selects a key of a secret.

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


status
KameletStatus

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


integration
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

status
KameletBindingStatus

AuthorizationSpec

(Appears on: KameletSpec)

AuthorizationSpec is TODO (oauth information)

BeanProperties

(Appears on: ErrorHandlerBean)

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

Field Description
RawMessage
RawMessage

Endpoint

(Appears on: ErrorHandlerDeadLetterChannel, KameletBindingSpec)

Endpoint represents a source/sink external entity

Field Description
ref
Kubernetes core/v1.ObjectReference

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

uri
string

URI can alternatively 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: Endpoint)

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)

ErrorHandler

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

ErrorHandlerBean

ErrorHandlerBean represents a bean error handler type

Field Description
ErrorHandlerNone
ErrorHandlerNone
type
string
properties
BeanProperties

ErrorHandlerDeadLetterChannel

ErrorHandlerDeadLetterChannel represents a dead letter channel error handler type

Field Description
ErrorHandlerLog
ErrorHandlerLog
endpoint
Endpoint

ErrorHandlerLog

(Appears on: ErrorHandlerDeadLetterChannel)

ErrorHandlerLog represent a default (log) error handler type

Field Description
ErrorHandlerNone
ErrorHandlerNone
parameters
ErrorHandlerParameters

ErrorHandlerNone

(Appears on: ErrorHandlerBean, ErrorHandlerLog)

ErrorHandlerNone –

Field Description

ErrorHandlerParameters

(Appears on: ErrorHandlerLog)

ErrorHandlerParameters represent an unstructured object for error handler parameters

Field Description
RawMessage
RawMessage

ErrorHandlerRef

ErrorHandlerRef represents a reference to an error handler builder available in the registry

Field Description
RawMessage
RawMessage

ErrorHandlerSpec

(Appears on: KameletBindingSpec)

ErrorHandlerSpec represents an unstructured object for an error handler

Field Description
RawMessage
RawMessage

ErrorHandlerType (string alias)

ErrorHandlerType –

EventSlot (string alias)

EventTypeSpec

(Appears on: Endpoint, KameletSpec)

Field Description
mediaType
string
schema
JSONSchemaProps

ExternalDocumentation

(Appears on: JSONSchemaProps)

ExternalDocumentation allows referencing an external resource for extended documentation.

Field Description
description
string
url
string

JSON

(Appears on: JSONSchemaProp, JSONSchemaProps)

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: JSONSchemaProps)

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,2559”
  • 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

The list of descriptors that determine which UI components to use on different views

JSONSchemaProps

(Appears on: EventTypeSpec, KameletSpec)

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: JSONSchemaProps)

JSONSchemaURL represents a schema url.

KameletBindingCondition

(Appears on: KameletBindingStatus)

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.

KameletBindingConditionType (string alias)

(Appears on: KameletBindingCondition)

KameletBindingPhase (string alias)

(Appears on: KameletBindingStatus)

KameletBindingSpec

(Appears on: KameletBinding)

KameletBindingSpec –

Field Description
integration
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

KameletBindingStatus

(Appears on: KameletBinding)

KameletBindingStatus –

Field Description
phase
KameletBindingPhase

Phase –

conditions
[]KameletBindingCondition

Conditions –

KameletCondition

(Appears on: KameletStatus)

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: KameletCondition)

KameletPhase (string alias)

(Appears on: KameletStatus)

KameletProperty

(Appears on: KameletStatus)

Field Description
name
string
default
string

KameletSpec

(Appears on: Kamelet)

KameletSpec defines the desired state of Kamelet

KameletStatus

(Appears on: Kamelet)

KameletStatus defines the observed state of Kamelet

Field Description
phase
KameletPhase
conditions
[]KameletCondition
properties
[]KameletProperty

RawMessage ([]byte alias)

(Appears on: JSON)

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.