Consumes message from the configured Google Cloud PubSub subscription. If the 'Batch Size' is set, the configured number of messages will be pulled in a single request, else only one message will be pulled.
google, google-cloud, gcp, message, pubsub, consume
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Project ID | gcp-project-id | Google Cloud Project ID Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Proxy Configuration Service | proxy-configuration-service | Controller Service API: ProxyConfigurationService Implementation: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN | |
| GCP Credentials Provider Service | GCP Credentials Provider Service | Controller Service API: GCPCredentialsService Implementation: GCPCredentialsControllerService | The Controller Service used to obtain Google Cloud Platform credentials. | |
| Subscription | gcp-pubsub-subscription | Name of the Google Cloud Pub/Sub Subscription Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Batch Size Threshold | gcp-pubsub-publish-batch-size | 15 | Indicates the number of messages the cloud service should bundle together in a batch. If not set and left empty, only one message will be used in a batch | |
| API Endpoint | api-endpoint | pubsub.googleapis.com:443 | Override the gRPC endpoint in the form of [host:port] Supports Expression Language: true (will be evaluated using variable registry only) |
| Name | Description |
|---|---|
| success | FlowFiles are routed to this relationship after a successful Google Cloud Pub/Sub operation. |
| Name | Description |
|---|---|
| gcp.pubsub.ackId | Acknowledgement Id of the consumed Google Cloud PubSub message |
| gcp.pubsub.messageSize | Serialized size of the consumed Google Cloud PubSub message |
| gcp.pubsub.attributesCount | Number of attributes the consumed PubSub message has, if any |
| gcp.pubsub.publishTime | Timestamp value when the message was published |
| Dynamic Attributes | Other than the listed attributes, this processor may write zero or more attributes, if the original Google Cloud Publisher client added any attributes to the message while sending |