diff --git a/Home.md b/Home.md index 93a012c..33fbc0d 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,40 @@ -# Deploy the Project on CamelX Platform +# Google Storage Event-based Source -Deploy on CamelX Platform in three steps +Receive data from Google Pubsub reporting events related to a Google Storage bucket. -## Step 1: Create a release -From the project space, click on **"Create a release"** +Service account key is the basic method for authenticating to the Google Pubsub and Google Storage. -The new version is automatically available in the list +To use this Kamelet you'll need to set up Events notification for your Google Storage Bucket. -## Step 2: Deploy -Click on **"Deploy"** +You must encode the `serviceAccountKey` property before you pass it as a parameter. -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +## Metadata -## Step 3: Expose -Enable **"Expose"** +| Property | Value | +|----------|-------| +| Type | source | +| Group | Google Storage Event-based | +| Namespace | GCP | +| Support Level | Preview | +| Provider | Apache Software Foundation | -Choose an **API Gateway** (Internal, Public, etc.) +## Properties + +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `projectId` | string | ✓ | | The Google Cloud Pub/Sub Project ID. | +| `subscriptionName` | string | ✓ | | The subscription name. | +| `serviceAccountKey` | binary | ✓ | | The service account key to use as credentials for the Pub/Sub publisher/subscriber. You must encode this value in base64. | +| `synchronousPull` | boolean | | `false` | Specifies to synchronously pull batches of messages. | +| `maxMessagesPerPoll` | integer | | `1` | The maximum number of messages to receive from the server in a single API call. | +| `concurrentConsumers` | integer | | `1` | The number of parallel streams to consume from the subscription. | +| `bucketNameOrArn` | string | ✓ | | The Google Cloud Storage bucket name or Bucket Amazon Resource Name (ARN). | +| `getObject` | boolean | | `false` | If getObject is enabled, then the file created in the Bucket will be get and returned as body, if not only the event will be returned as body. | + +## Dependencies + +- `camel:kamelet` +- `camel:google-pubsub` +- `camel:google-storage` +- `camel:jackson` +- `camel:core`