6.5. 利用可能な Camel コンポーネントのリスト
Camel には、すぐに使える次のような多くのアーティファクトが付属しています。
- コンポーネント
- データ形式
- 表現言語
- その他のコンポーネント
- Kamelets
Camel CLI を使用すると、camel catalog
コマンドを使用して Camel が提供するものをリストできます。たとえば、すべてのコンポーネントをリストするには、次のようにします。
camel catalog components
camel catalog components
利用可能な Kamelet を確認するには以下を実行します。
camel catalog kamelets
camel catalog kamelets
使用可能なすべてのコマンドを表示するには、camel catalog --help
を使用します。
6.5.1. コンポーネントのドキュメントの表示 リンクのコピーリンクがクリップボードにコピーされました!
doc
のゴールでは、すべてのコンポーネント、データ形式、Kamelet の簡単なドキュメントを表示できます。たとえば、kafka コンポーネントを確認するには、次を実行します。
camel doc kafka
camel doc kafka
Camel CLI はこの情報に直接アクセスできず、コンポーネントの基本的な説明しか表示できませんが、すべての設定オプションの表が含まれているため、このドキュメントは Web サイトに表示されているような完全なドキュメントではありません。
jackson データ形式のドキュメントを参照するには:
camel doc jackson
camel doc jackson
まれに、同じ名前のコンポーネントとデータ形式が存在し、doc
の目標によってコンポーネントが優先されることがあります。このような状況では、次のように名前の前にデータ形式を付けることができます。
camel doc dataformat:thrift
camel doc dataformat:thrift
次のような kamelet ドキュメントも参照できます。
camel doc aws-kinesis-sink
camel doc aws-kinesis-sink
サポートされている Kamelet のリストは、サポートされている Kamelet を参照してください。
6.5.1.1. Camel Web サイトからのオンラインドキュメントの参照 リンクのコピーリンクがクリップボードにコピーされました!
doc
コマンドを使用すると、オンラインドキュメントの Web ブラウザーで url をすばやく開くことができます。たとえば、kafka コンポーネントを参照するには、--open-url
を使用します。
camel doc kafka --open-url
camel doc kafka --open-url
これはデータ形式、言語、kamelet にも機能します。
camel doc aws-kinesis-sink --open-url
camel doc aws-kinesis-sink --open-url
オンラインドキュメントへのリンクだけを取得するには、camel doc kafka --url
を使用します。
6.5.1.2. 表にリストされているフィルタリングオプション リンクのコピーリンクがクリップボードにコピーされました!
一部のコンポーネントには多くのオプションがある場合があり、そのような場合は --filter
オプションを使用して、名前、説明、またはグループ (producer, security, advanced) のいずれかでフィルターに一致するオプションのみをリスト表示できます。
たとえば、セキュリティー関連のオプションのみをリストするには、次のようにします。
camel doc kafka --filter=security
camel doc kafka --filter=security
timeout
に関するものだけをリストするには以下を実行します。
camel doc kafka --filter=timeout
camel doc kafka --filter=timeout