ConsumeGCPubSub
Description
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.
Tags
consume, gcp, google, google-cloud, message, pubsub
Properties
In the list below required Properties are shown with an asterisk (*). Other properties 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 |
|---|---|---|---|---|
| GCP Credentials Provider Service * | GCP Credentials Provider Service | Controller Service: GCPCredentialsService Implementations: GCPCredentialsControllerService | The Controller Service used to obtain Google Cloud Platform credentials. | |
| Project ID | gcp-project-id | Google Cloud Project ID Supports Expression Language, using Environment variables. | ||
| Subscription * | gcp-pubsub-subscription | Name of the Google Cloud Pub/Sub Subscription Supports Expression Language, using Environment variables. | ||
| 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, using Environment variables. | |
| Proxy Configuration Service | proxy-configuration-service | Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| success | FlowFiles are routed to this relationship after a successful Google Cloud Pub/Sub operation. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| 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 |
| gcp.pubsub.ackId | Acknowledgement Id of the consumed Google Cloud PubSub message |
| gcp.pubsub.attributesCount | Number of attributes the consumed PubSub message has, if any |
| gcp.pubsub.messageSize | Serialized size of the consumed Google Cloud PubSub message |
| gcp.pubsub.publishTime | Timestamp value when the message was published |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component does not allow an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.