Description and usage of ConsumeGCPubSub Processor:

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 Expression Language Guide.


Default Value

Allowable Values


Project ID Google Cloud Project ID

Supports Expression Language: true (will be evaluated using variable registry only)

GCP Credentials Provider Service

Controller Service API: 




The Controller Service used to obtain Google Cloud Platform credentials.


Name of the Google Cloud Pub/Sub Subscription

Supports Expression Language: true (will be evaluated using variable registry only)

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




success FlowFiles are routed to this relationship after a successful Google Cloud Pub/Sub operation.

Reads Attributes:

None specified.

Writes Attributes:



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

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.