ConsumeGCPubSubLite

Description:

Consumes message from the configured Google Cloud PubSub Lite subscription. 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'.

Tags:

google, google-cloud, gcp, message, pubsub, consume, lite

Properties:

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
Subscriptiongcp-pubsub-subscriptionName of the Google Cloud Pub/Sub Subscription. Example: projects/8476107443/locations/europe-west1-d/subscriptions/my-lite-subscription
Supports Expression Language: true (will be evaluated using variable registry only)
GCP Credentials Provider ServiceGCP Credentials Provider ServiceController Service API:
GCPCredentialsService
Implementation: GCPCredentialsControllerService
The Controller Service used to obtain Google Cloud Platform credentials.
Bytes Outstandinggcp-bytes-outstanding10 MBThe number of quota bytes that may be outstanding to the client.
Supports Expression Language: true (will be evaluated using variable registry only)
Messages Outstandinggcp-messages-outstanding1000The number of messages that may be outstanding to the client.
Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

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

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
gcp.pubsub.messageIdID of the pubsub message published to the configured Google Cloud PubSub topic
gcp.pubsub.ordering.keyIf non-empty, identifies related messages for which publish order should be respected. If a 'Subscription' has 'enable_message_ordering' set to 'true', messages published with the same non-empty 'ordering_key' value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All 'PubsubMessage's published in a given 'PublishRequest' must specify the same 'ordering_key' value.
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.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also:

PublishGCPubSubLite