PublishGCPubSub 2025.10.9.21

Bundle

org.apache.nifi | nifi-gcp-nar

Description

Publishes the content of the incoming flowfile to the configured Google Cloud PubSub topic. The processor supports dynamic properties. If any dynamic properties are present, they will be sent along with the message in the form of ‘attributes’.

Tags

gcp, google, google-cloud, message, publish, pubsub

Input Requirement

REQUIRED

Supports Sensitive Dynamic Properties

false

Properties

PropertyDescription
GCP Credentials Provider ServiceThe Controller Service used to obtain Google Cloud Platform credentials.
Input Batch SizeMaximum number of FlowFiles processed for each Processor invocation
Maximum Message SizeThe maximum size of a Google PubSub message in bytes. Defaults to 1 MB (1048576 bytes)
Message Derivation StrategyThe strategy used to publish the incoming FlowFile to the Google Cloud PubSub endpoint.
Record ReaderThe Record Reader to use for incoming FlowFiles
Record WriterThe Record Writer to use in order to serialize the data before sending to GCPubSub endpoint
api-endpointOverride the gRPC endpoint in the form of [host:port]
gcp-batch-bytesPublish request gets triggered based on this Batch Bytes Threshold property and the Batch Size Threshold property, whichever condition is met first.
gcp-project-idGoogle Cloud Project ID
gcp-pubsub-publish-batch-delayIndicates the delay threshold to use for batching. After this amount of time has elapsed (counting from the first element added), the elements will be wrapped up in a batch and sent. This value should not be set too high, usually on the order of milliseconds. Otherwise, calls might appear to never complete.
gcp-pubsub-publish-batch-sizeIndicates 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
gcp-pubsub-topicName of the Google Cloud PubSub Topic
proxy-configuration-serviceSpecifies the Proxy Configuration Controller Service to proxy network requests.

Relationships

NameDescription
failureFlowFiles are routed to this relationship if the Google Cloud Pub/Sub operation fails.
retryFlowFiles are routed to this relationship if the Google Cloud Pub/Sub operation fails but attempting the operation again may succeed.
successFlowFiles are routed to this relationship after a successful Google Cloud Pub/Sub operation.

Writes attributes

NameDescription
gcp.pubsub.messageIdID of the pubsub message published to the configured Google Cloud PubSub topic
gcp.pubsub.count.recordsCount of pubsub messages published to the configured Google Cloud PubSub topic
gcp.pubsub.topicName of the Google Cloud PubSub topic the message was published to

See also