Huawei FunctionGraph

Since Camel 3.11

Only producer is supported

Huawei Cloud FunctionGraph component allows you to integrate with FunctionGraph provided by Huawei Cloud.

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

<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

hwcloud-functiongraph:operation[?options]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The Huawei FunctionGraph component supports 2 options, which are listed below.

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.

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.

boolean

Endpoint Options

The Huawei FunctionGraph endpoint is configured using URI syntax:

hwcloud-functiongraph:operation

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

operation (producer)

Required Operation to be performed.

String

Query Parameters (14 parameters)

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.

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.

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

accessKey (security)

Required Access key for the cloud user.

String

ignoreSslVerification (security)

Ignore SSL verification.

boolean

secretKey (security)

Required Secret key for the cloud user.

String

Usage

Message properties evaluated by the FunctionGraph producer

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

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

Access 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:

<bean id="myServiceKeyConfig" class="org.apache.camel.component.huaweicloud.functiongraph.models.ServiceKeys">
   <property name="accessKey" value="your_access_key" />
   <property name="secretKey" value="your_secret_key" />
</bean>
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")

Spring Boot Auto-Configuration

When using hwcloud-functiongraph with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-huaweicloud-functiongraph-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 3 options, which are listed below.

Name Description Default Type

camel.component.hwcloud-functiongraph.autowired-enabled

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

camel.component.hwcloud-functiongraph.enabled

Whether to enable auto configuration of the hwcloud-functiongraph component. This is enabled by default.

Boolean

camel.component.hwcloud-functiongraph.lazy-start-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