google-bigquery-sql/component.json

{
  "component": {
    "kind": "component",
    "name": "google-bigquery-sql",
    "title": "Google BigQuery Standard SQL",
    "description": "Access Google Cloud BigQuery service using SQL queries.",
    "deprecated": false,
    "firstVersion": "1.0.0",
    "label": "cloud,messaging",
    "javaType": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLComponent",
    "supportLevel": "Stable",
    "nativeSupported": true,
    "metadata": {
      "quarkusVersion": "3.36.0",
      "camelArtifact": "org.apache.camel:camel-google-bigquery",
      "camelVersion": "4.20.0"
    },
    "groupId": "org.apache.camel.quarkus",
    "artifactId": "camel-quarkus-google-bigquery",
    "version": "4.20.0 (CEQ 3.36.0)",
    "scheme": "google-bigquery-sql",
    "extendsScheme": "",
    "syntax": "google-bigquery-sql:projectId:queryString",
    "async": false,
    "api": false,
    "consumerOnly": false,
    "producerOnly": true,
    "lenientProperties": false,
    "browsable": false,
    "remote": true
  },
  "componentProperties": {
    "connectionFactory": {
      "index": 0,
      "kind": "property",
      "displayName": "Connection Factory",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "object",
      "javaType": "org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory",
      "deprecated": false,
      "autowired": true,
      "secret": false,
      "description": "ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used"
    },
    "lazyStartProducer": {
      "index": 1,
      "kind": "property",
      "displayName": "Lazy Start Producer",
      "group": "producer",
      "label": "producer",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "description": "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."
    },
    "projectId": {
      "index": 2,
      "kind": "property",
      "displayName": "Project Id",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "Google Cloud Project Id"
    },
    "autowiredEnabled": {
      "index": 3,
      "kind": "property",
      "displayName": "Autowired Enabled",
      "group": "advanced",
      "label": "advanced",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": true,
      "description": "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."
    }
  },
  "headers": {
    "CamelGoogleBigQueryTranslatedQuery": {
      "index": 0,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "Preprocessed query text",
      "constantName": "org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#TRANSLATED_QUERY"
    },
    "CamelGoogleBigQueryJobId": {
      "index": 1,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "com.google.cloud.bigquery.JobId",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "A custom JobId to use",
      "constantName": "org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#JOB_ID"
    },
    "CamelGoogleBigQueryPageToken": {
      "index": 2,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The page token to retrieve a specific page of results from BigQuery. If not set, the first page is returned",
      "constantName": "org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#PAGE_TOKEN"
    },
    "CamelGoogleBigQueryNextPageToken": {
      "index": 3,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The next page token returned by BigQuery. Use this token in the CamelGoogleBigQueryPageToken header of a subsequent request to retrieve the next page of results",
      "constantName": "org.apache.camel.component.google.bigquery.GoogleBigQueryConstants#NEXT_PAGE_TOKEN"
    }
  },
  "properties": {
    "projectId": {
      "index": 0,
      "kind": "path",
      "displayName": "Project Id",
      "group": "common",
      "label": "common",
      "required": true,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration",
      "configurationField": "configuration",
      "description": "Google Cloud Project Id"
    },
    "queryString": {
      "index": 1,
      "kind": "path",
      "displayName": "Query String",
      "group": "common",
      "label": "common",
      "required": true,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "supportFileReference": true,
      "largeInput": true,
      "configurationClass": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration",
      "configurationField": "configuration",
      "description": "BigQuery standard SQL query"
    },
    "connectionFactory": {
      "index": 2,
      "kind": "parameter",
      "displayName": "Connection Factory",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "object",
      "javaType": "org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": true,
      "secret": false,
      "configurationClass": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration",
      "configurationField": "configuration",
      "description": "ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used"
    },
    "outputType": {
      "index": 3,
      "kind": "parameter",
      "displayName": "Output Type",
      "group": "producer",
      "label": "producer",
      "required": false,
      "type": "enum",
      "javaType": "org.apache.camel.component.google.bigquery.sql.OutputType",
      "enum": [
        "SELECT_LIST",
        "STREAM_LIST"
      ],
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": "SELECT_LIST",
      "configurationClass": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration",
      "configurationField": "configuration",
      "description": "Output mode type for select queries"
    },
    "pageSize": {
      "index": 4,
      "kind": "parameter",
      "displayName": "Page Size",
      "group": "producer",
      "label": "producer",
      "required": false,
      "type": "integer",
      "javaType": "long",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": 0,
      "configurationClass": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration",
      "configurationField": "configuration",
      "description": "Size of a page to request. Unset by default"
    },
    "pageToken": {
      "index": 5,
      "kind": "parameter",
      "displayName": "Page Token",
      "group": "producer",
      "label": "producer",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration",
      "configurationField": "configuration",
      "description": "Page token, returned by a previous call, to request the next page of results"
    },
    "lazyStartProducer": {
      "index": 6,
      "kind": "parameter",
      "displayName": "Lazy Start Producer",
      "group": "producer (advanced)",
      "label": "producer,advanced",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "description": "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."
    },
    "serviceAccountKey": {
      "index": 7,
      "kind": "parameter",
      "displayName": "Service Account Key",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLConfiguration",
      "configurationField": "configuration",
      "description": "Service account key in json format to authenticate an application as a service account to google cloud platform"
    }
  },
  "propertiesSchema": {
    "properties": {
      "projectId": {
        "title": "Project Id",
        "description": "Google Cloud Project Id",
        "type": "string",
        "$comment": "group:common"
      },
      "queryString": {
        "title": "Query String",
        "description": "BigQuery standard SQL query",
        "type": "string",
        "$comment": "group:common"
      },
      "connectionFactory": {
        "title": "Connection Factory",
        "description": "ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used",
        "type": "string",
        "$comment": "group:producer",
        "format": "bean:org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory"
      },
      "outputType": {
        "title": "Output Type",
        "description": "Output mode type for select queries",
        "type": "string",
        "enum": [
          "SELECT_LIST",
          "STREAM_LIST"
        ],
        "$comment": "group:producer",
        "default": "SELECT_LIST"
      },
      "pageSize": {
        "title": "Page Size",
        "description": "Size of a page to request. Unset by default",
        "type": "integer",
        "$comment": "group:producer",
        "default": 0
      },
      "pageToken": {
        "title": "Page Token",
        "description": "Page token, returned by a previous call, to request the next page of results",
        "type": "string",
        "$comment": "group:producer"
      },
      "lazyStartProducer": {
        "title": "Lazy Start Producer",
        "description": "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.",
        "type": "boolean",
        "$comment": "group:producer (advanced)",
        "default": false
      },
      "serviceAccountKey": {
        "title": "Service Account Key",
        "description": "Service account key in json format to authenticate an application as a service account to google cloud platform",
        "type": "string",
        "$comment": "group:security"
      }
    },
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "required": [
      "projectId",
      "queryString"
    ]
  }
}