This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit d250b95d0d7a30531992ae1d539f27163015fb9d Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 10:19:40 2022 -0400 doc-config-descriptions-edit google --- kamelets/google-bigquery-sink.kamelet.yaml | 12 +++++------- kamelets/google-calendar-source.kamelet.yaml | 22 +++++++++++----------- kamelets/google-functions-sink.kamelet.yaml | 12 +++++------- kamelets/google-pubsub-sink.kamelet.yaml | 10 +++++----- kamelets/google-pubsub-source.kamelet.yaml | 16 +++++++--------- kamelets/google-storage-sink.kamelet.yaml | 20 ++++++++++---------- kamelets/google-storage-source.kamelet.yaml | 12 ++++++------ 7 files changed, 49 insertions(+), 55 deletions(-) diff --git a/kamelets/google-bigquery-sink.kamelet.yaml b/kamelets/google-bigquery-sink.kamelet.yaml index ead10e48..30b3593b 100644 --- a/kamelets/google-bigquery-sink.kamelet.yaml +++ b/kamelets/google-bigquery-sink.kamelet.yaml @@ -32,9 +32,7 @@ spec: description: |- Send data to a Google Big Query table. - It is expected the body is in Json format representing an object or an array of objects. - - The credentialsFileLocation property needs to be a path to a service account key file. + The data must be JSON format to represent an object or an array of objects. required: - projectId - dataset @@ -44,19 +42,19 @@ spec: properties: projectId: title: Google Cloud Project Id - description: Google Cloud Project id + description: The Google Cloud Project ID. type: string dataset: title: Big Query Dataset Id - description: The Big Query Dataset Id + description: The Big Query Dataset ID. type: string table: title: Big Query Table Id - description: The Big Query Table Id + description: The Big Query Table ID. type: string credentialsFileLocation: title: Google Cloud Platform Credential File - description: The credential to access Google Cloud Platform api services + description: The credential for accessing Google Cloud Platform API services. This value must be a path to a service account key file. type: string x-descriptors: - urn:camel:group:credentials diff --git a/kamelets/google-calendar-source.kamelet.yaml b/kamelets/google-calendar-source.kamelet.yaml index 95811326..5630cd3f 100644 --- a/kamelets/google-calendar-source.kamelet.yaml +++ b/kamelets/google-calendar-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "Google Calendar Source" description: |- - Receive data from Google Calendar. + Receive event data from Google Calendar. required: - index - calendarId @@ -43,15 +43,15 @@ spec: properties: index: title: Index - description: An index for the google calendar endpoint + description: An index for the Google Calendar endpoint. type: string calendarId: title: Calendar ID - description: The calendar ID to be used as events source + description: The calendar ID to use as the source of event data. type: string clientId: title: Client Id - description: Client ID of the calendar application + description: The Client ID of the Google Calendar application. type: string format: password x-descriptors: @@ -59,7 +59,7 @@ spec: - urn:camel:group:credentials clientSecret: title: Client Secret - description: Client Secret of the calendar application + description: The Client secret of the Google Calendar application. type: string format: password x-descriptors: @@ -67,7 +67,7 @@ spec: - urn:camel:group:credentials accessToken: title: Access Token - description: OAuth 2 access token for google calendar application. This typically expires after an hour so refreshToken is recommended for long term usage. + description: The OAuth 2 access token for the Google Calendar application. This token typically expires after an hour. For long term usage, set the `refreshToken` property. type: string format: password x-descriptors: @@ -75,7 +75,7 @@ spec: - urn:camel:group:credentials refreshToken: title: Refresh Token - description: OAuth 2 refresh token for google calendar application. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. + description: The OAuth 2 refresh token for the Google Calendar application. The Google Calendar component can obtain a new `accessToken` whenever the current one expires. Set this value for long term usage. type: string format: password x-descriptors: @@ -83,23 +83,23 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll. type: integer default: 500 applicationName: title: Application name - description: Google Calendar application name + description: The Google Calendar application name. type: string syncFlow: title: Sync Flow - description: Sync events for incremental synchronization + description: Specifies to sync events for incremental synchronization. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false consumeFromNow: title: Consume from now - description: Consume events in the selected calendar from now on + description: Specfies to consume events in the calendar from now on. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/google-functions-sink.kamelet.yaml b/kamelets/google-functions-sink.kamelet.yaml index 0056e2fa..61ee44e3 100644 --- a/kamelets/google-functions-sink.kamelet.yaml +++ b/kamelets/google-functions-sink.kamelet.yaml @@ -30,9 +30,7 @@ spec: definition: title: "Google Functions Sink" description: |- - Send messages to Google Functions. - - The serviceAccountKey property needs to be a path to a service account key file. + Send data to Google Functions. required: - projectId - functionName @@ -42,19 +40,19 @@ spec: properties: projectId: title: Project Id - description: The Google Cloud Functions Project Id + description: The Google Cloud Functions Project ID. type: string region: title: Region - description: The Region where the Google Cloud Functions has been deployed + description: The region where Google Cloud Functions has been deployed. type: string functionName: title: Function Name - description: The Function Name + description: The Function name. type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the Google Cloud Functions platform + description: The path to the service account key file that provides credentials for the Google Cloud Functions platform. type: string x-descriptors: - urn:camel:group:credentials diff --git a/kamelets/google-pubsub-sink.kamelet.yaml b/kamelets/google-pubsub-sink.kamelet.yaml index 0e06527d..51371e68 100644 --- a/kamelets/google-pubsub-sink.kamelet.yaml +++ b/kamelets/google-pubsub-sink.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Google Pubsub Sink" description: |- - Send messages to Google Pubsub. + Send messages to Google Cloud Pub/Sub. - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. + You must encode the `serviceAccountKey` property before you pass it as a parameter. required: - projectId - destinationName @@ -41,15 +41,15 @@ spec: properties: projectId: title: Project Id - description: The Google Cloud PubSub Project Id + description: The Google Cloud Pub/Sub Project ID. type: string destinationName: title: Destination Name - description: The Destination Name + description: The destination name. type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the PubSub publisher/subscriber + description: The service account key to use as credentials for the Pub/Sub publisher/subscriber. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials diff --git a/kamelets/google-pubsub-source.kamelet.yaml b/kamelets/google-pubsub-source.kamelet.yaml index 53e04abe..6f2a6a07 100644 --- a/kamelets/google-pubsub-source.kamelet.yaml +++ b/kamelets/google-pubsub-source.kamelet.yaml @@ -30,9 +30,7 @@ spec: definition: title: "Google Pubsub Source" description: |- - Consume messages from Google Pubsub. - - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. + Consume messages from Google Cloud Pub/Sub. required: - projectId - subscriptionName @@ -41,33 +39,33 @@ spec: properties: projectId: title: Project Id - description: The Google Cloud PubSub Project Id + description: The Google Cloud Pub/Sub Project ID. type: string subscriptionName: title: Subscription Name - description: The Subscription Name + description: The subscription name. type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the PubSub publisher/subscriber + description: The service account key to use as credentials for the Pub/Sub publisher/subscriber. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials synchronousPull: title: Synchronous Pull - description: If Synchronously pull batches of messages is enabled or not + description: Specifies to synchronously pull batches of messages. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false maxMessagesPerPoll: title: Max Messages Per Poll - description: The max number of messages to receive from the server in a single API call + description: The maximum number of messages to receive from the server in a single API call. type: integer default: 1 concurrentConsumers: title: Concurrent Consumers - description: The number of parallel streams consuming from the subscription + description: The number of parallel streams to consume from the subscription. type: integer default: 1 dependencies: diff --git a/kamelets/google-storage-sink.kamelet.yaml b/kamelets/google-storage-sink.kamelet.yaml index d448838d..d4ab0169 100644 --- a/kamelets/google-storage-sink.kamelet.yaml +++ b/kamelets/google-storage-sink.kamelet.yaml @@ -30,13 +30,13 @@ spec: definition: title: "Google Storage Sink" description: |- - Upload Objects to Google Storage. - - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. - - - `file` / `ce-file`: as the file name to upload - - If the header won't be set the exchange ID will be used as file name. + Upload objects to Google Cloud Storage. + + You must encode the `serviceAccountKey` property before you pass it as a parameter. + + The Kamelet checks for the `file` / `ce-file` header got the name of the file to upload. + + A header is optional. If the header is not set, the exchange ID value is used as the file name. required: - bucketNameOrArn - serviceAccountKey @@ -44,17 +44,17 @@ spec: properties: bucketNameOrArn: title: Bucket Name Or ARN - description: The Bucket Name or Bucket ARN + description: The Google Cloud Storage bucket name or Bucket Amazon Resource Name (ARN). type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the Google Cloud Storage access. + description: The service account key to use as credentials for Google Cloud Storage access. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the Google Cloud Storage bucket bucketNameOrArn. + description: Specifies to automatically create the Google Cloud Storage bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/google-storage-source.kamelet.yaml b/kamelets/google-storage-source.kamelet.yaml index b9455ca0..fb42a761 100644 --- a/kamelets/google-storage-source.kamelet.yaml +++ b/kamelets/google-storage-source.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Google Storage Source" description: |- - Consume Objects from Google Storage. + Consume objects from Google Cloud Storage. - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. + You must encode the `serviceAccountKey` property before you pass it as a parameter. required: - bucketNameOrArn - serviceAccountKey @@ -40,24 +40,24 @@ spec: properties: bucketNameOrArn: title: Bucket Name Or ARN - description: The Bucket Name or Bucket ARN + description: The Google Cloud Storage bucket name or Bucket Amazon Resource Name (ARN). type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the Google Cloud Storage access. + description: TThe service account key to use as credentials for Google Cloud Storage access. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials deleteAfterRead: title: Auto-delete Objects - description: Delete objects after consuming them + description: Specifies to delete objects after consuming them. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: true autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the Google Cloud Storage bucket bucketNameOrArn. + description: Specifies to automatically create the Google Cloud Storage bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox'
