| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PublishGCPubSubLite</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PublishGCPubSubLite</h1><h2>Description: </h2><p>Publishes the content of the incoming flowfile to the configured Google Cloud PubSub Lite 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'. In its current state, this processor will only work if running on a Google Cloud Compute Engine instance and if using the GCP Credentials Controller Service with 'Use Application Default Credentials' or 'Use Compute Engine Credentials'.</p><h3>Tags: </h3><p>google, google-cloud, gcp, message, pubsub, publish, lite</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Topic Name</strong></td><td>gcp-pubsub-topic</td><td></td><td id="allowable-values"></td><td id="description">Name of the Google Cloud PubSub Topic. Example: projects/8476107443/locations/europe-west1-d/topics/my-lite-topic<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>GCP Credentials Provider Service</strong></td><td>GCP Credentials Provider Service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>GCPCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService/index.html">GCPCredentialsControllerService</a></td><td id="description">The Controller Service used to obtain Google Cloud Platform credentials.</td></tr><tr><td id="name">Ordering Key</td><td>gcp-ordering-key</td><td></td><td id="allowable-values"></td><td id="description">Messages with the same ordering key will always get published to the same partition. When this property is not set, messages can get published to different partitions if more than one partition exists for the topic.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Batch Size</strong></td><td>gcp-pubsub-publish-batch-size</td><td id="default-value">15</td><td id="allowable-values"></td><td id="description">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</td></tr><tr><td id="name"><strong>Batch Bytes Threshold</strong></td><td>gcp-batch-bytes</td><td id="default-value">3 MB</td><td id="allowable-values"></td><td id="description">Publish request gets triggered based on this Batch Bytes Threshold property and the Batch Size property, whichever condition is met first.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>No</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">Attribute name</td><td id="value">Value to be set to the attribute</td><td>Attributes to be set for the outgoing Google Cloud PubSub Lite message<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to this relationship after a successful Google Cloud Pub/Sub operation.</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship if the Google Cloud Pub/Sub operation fails.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>gcp.pubsub.messageId</td><td>ID of the pubsub message published to the configured Google Cloud PubSub topic</td></tr><tr><td>gcp.pubsub.topic</td><td>Name of the Google Cloud PubSub topic the message was published to</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>The entirety of the FlowFile's content will be read into memory to be sent as a PubSub message.</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.gcp.pubsub.lite.ConsumeGCPubSubLite/index.html">ConsumeGCPubSubLite</a></p></body></html> |