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 NameAPI NameDefault ValueAllowable ValuesDescription
Project IDgcp-project-idGoogle Cloud Project ID
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Configuration Serviceproxy-configuration-serviceController Service API:
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 ServiceGCP Credentials Provider ServiceController Service API:
Implementation: GCPCredentialsControllerService
The Controller Service used to obtain Google Cloud Platform credentials.
Subscriptiongcp-pubsub-subscriptionName of the Google Cloud Pub/Sub Subscription
Supports Expression Language: true (will be evaluated using variable registry only)
Batch Size Thresholdgcp-pubsub-publish-batch-size15Indicates 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 the gRPC endpoint in the form of [host:port]
Supports Expression Language: true (will be evaluated using variable registry only)


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

Reads Attributes:

None specified.

Writes Attributes:

gcp.pubsub.ackIdAcknowledgement Id of the consumed Google Cloud PubSub message
gcp.pubsub.messageSizeSerialized size of the consumed Google Cloud PubSub message
gcp.pubsub.attributesCountNumber of attributes the consumed PubSub message has, if any
gcp.pubsub.publishTimeTimestamp value when the message was published
Dynamic AttributesOther 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 does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also: