[[hwcloud-functiongraph-component]]
= Huawei Cloud FunctionGraph Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-huawei/camel-huaweicloud-functiongraph/src/main/docs/hwcloud-functiongraph-component.adoc
:docTitle: Huawei Cloud FunctionGraph
:artifactId: camel-huaweicloud-functiongraph
:description: To call serverless functions on Huawei Cloud
:since: 3.11
:supportLevel: Preview
:component-header: Only producer is supported
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/hwcloud-functiongraph.adoc[opts=optional]
//Manually maintained attributes
:group: Huawei Cloud

*Since Camel {since}*

*{component-header}*

Huawei Cloud FunctionGraph component allows you to integrate with https://www.huaweicloud.com/intl/en-us/product/functiongraph.html[FunctionGraph] provided by Huawei Cloud.

Maven users will need to add the following dependency to their `pom.xml` for this component:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-huaweicloud-functiongraph</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
----

== URI Format

[source,text]
----
hwcloud-functiongraph:operation[?options]
----

== URI Options

// component options: START
The Huawei Cloud FunctionGraph component supports 2 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
|===
// component options: END


// endpoint options: START
The Huawei Cloud FunctionGraph endpoint is configured using URI syntax:

----
hwcloud-functiongraph:operation
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *operation* | *Required* Operation to be performed |  | String
|===


=== Query Parameters (14 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *endpoint* (producer) | FunctionGraph url. Carries higher precedence than region parameter based client initialization |  | String
| *functionName* (producer) | Name of the function to invoke |  | String
| *functionPackage* (producer) | Functions that can be logically grouped together | default | String
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *projectId* (producer) | *Required* Cloud project ID |  | String
| *region* (producer) | *Required* FunctionGraph service region. This is lower precedence than endpoint based configuration |  | String
| *serviceKeys* (producer) | Configuration object for cloud service authentication |  | ServiceKeys
| *proxyHost* (proxy) | Proxy server ip/hostname |  | String
| *proxyPassword* (proxy) | Proxy authentication password |  | String
| *proxyPort* (proxy) | Proxy server port |  | int
| *proxyUser* (proxy) | Proxy authentication user |  | String
| *authenticationKey* (security) | *Required* Authentication key for the cloud user |  | String
| *ignoreSslVerification* (security) | Ignore SSL verification | false | boolean
| *secretKey* (security) | *Required* Secret key for the cloud user |  | String
|===
// endpoint options: END


== Usage

=== Message properties evaluated by the FunctionGraph producer

[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|Header |Type |Description

|`CamelHwCloudFgOperation` |`String` | Name of operation to invoke

|`CamelHwCloudFgFunction` |`String` | Name of function to invoke operation on

|`CamelHwCloudFgPackage` |`String` | Name of the function package

|`CamelHwCloudFgXCffLogType` | `String` | Type of log to be returned by FunctionGraph operation

|=======================================================================

If the operation, function name, or function package are set, they will override their corresponding query parameter.

=== Message properties set by the FunctionGraph producer

[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|Header |Type |Description

|`CamelHwCloudFgXCffLogs` |`String` | Unique log returned by FunctionGraph after processing the request if `CamelHwCloudFgXCffLogType` is set

|=======================================================================


== List of Supported FunctionGraph Operations

- invokeFunction - to invoke a serverless function

== Using ServiceKey Configuration Bean

Authentication key and secret keys are required to authenticate against cloud FunctionGraph service. You can avoid having them being exposed
and scattered over in your endpoint uri by wrapping them inside a bean of class `org.apache.camel.component.huaweicloud.functiongraph.models.ServiceKeys`.
Add it to the registry and let Camel look it up by referring the object via endpoint query parameter `serviceKeys`.

Check the following code snippets:

[source,xml]
----
<bean id="myServiceKeyConfig" class="org.apache.camel.component.huaweicloud.functiongraph.models.ServiceKeys">
   <property name="authenticationKey" value="your_authentication_key" />
   <property name="secretKey" value="your_secret_key" />
</bean>
----
[source,java]
----
from("direct:triggerRoute")
 .setProperty(FunctionGraphProperties.OPERATION, constant("invokeFunction"))
 .setProperty(FunctionGraphProperties.FUNCTION_NAME ,constant("your_function_name"))
 .setProperty(FunctionGraphProperties.FUNCTION_PACKAGE, constant("your_function_package"))
 .to("hwcloud-functiongraph:invokeFunction?projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&region=cn-north-4&serviceKeys=#myServiceKeyConfig")
----
