ConsumeGCPubSub

ConsumeGCPubSub 2.0.0

Bundle: org.apache.nifi | nifi-gcp-nar
Description: 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.
Tags: consume, gcp, google, google-cloud, message, pubsub
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

API Endpoint
Override the gRPC endpoint in the form of [host:port]

Display Name

API Endpoint

Description

Override the gRPC endpoint in the form of [host:port]

API Name

api-endpoint

Default Value

pubsub.googleapis.com:443

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
GCP Credentials Provider Service
The Controller Service used to obtain Google Cloud Platform credentials.

Display Name

GCP Credentials Provider Service

Description

The Controller Service used to obtain Google Cloud Platform credentials.

API Name

GCP Credentials Provider Service

Service Interface

org.apache.nifi.gcp.credentials.service.GCPCredentialsService

Service Implementations

org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Project ID
Google Cloud Project ID

Display Name

Project ID

Description

Google Cloud Project ID

API Name

gcp-project-id

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Batch Size Threshold
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

Display Name

Batch Size Threshold

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

API Name

gcp-pubsub-publish-batch-size

Default Value

15

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Subscription
Name of the Google Cloud Pub/Sub Subscription

Display Name

Subscription

Description

Name of the Google Cloud Pub/Sub Subscription

API Name

gcp-pubsub-subscription

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Proxy Configuration Service
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Relationships

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

Writes Attributes

Name	Description
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