org.springframework.cloud.gcp.bigquery.integration.outbound

Class BigQueryFileMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.cloud.gcp.bigquery.integration.outbound.BigQueryFileMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<org.springframework.messaging.Message<?>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.integration.context.ExpressionCapable, org.springframework.integration.context.Orderable, org.springframework.integration.core.MessageProducer, org.springframework.integration.handler.HeaderPropagationAware, org.springframework.integration.IntegrationPattern, org.springframework.integration.support.context.NamedComponent, org.springframework.integration.support.management.BaseHandlerMetrics, org.springframework.integration.support.management.ConfigurableMetricsAware<org.springframework.integration.support.management.AbstractMessageHandlerMetrics>, org.springframework.integration.support.management.IntegrationManagement, org.springframework.integration.support.management.IntegrationStatsManagement, org.springframework.integration.support.management.MessageHandlerMetrics, org.springframework.integration.support.management.TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>

public class BigQueryFileMessageHandler
extends org.springframework.integration.handler.AbstractReplyProducingMessageHandler

A MessageHandler which handles sending and loading files to a BigQuery table.

Since:

1.2

Author:

Daniel Zou

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

org.springframework.integration.support.management.IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
BigQueryFileMessageHandler(BigQueryTemplate bigQueryTemplate)

Method Summary

Modifier and Type	Method and Description
protected void	doInit()
protected Object	handleRequestMessage(org.springframework.messaging.Message<?> message)
void	setFormatOptions(FormatOptions formatOptions) Sets the handler's FormatOptions which describe the type/format of data files being loaded.
void	setFormatOptionsExpression(org.springframework.expression.Expression formatOptionsExpression) Sets the SpEL Expression used to determine the FormatOptions for the handler.
void	setSync(boolean sync) A boolean indicating if the BigQueryFileMessageHandler should synchronously wait for each file to be successfully loaded to BigQuery.
void	setTableName(String tableName) Sets the BigQuery table name to use.
void	setTableNameExpression(org.springframework.expression.Expression tableNameExpression) Sets the SpEL Expression to evaluate to determine the table name.
void	setTimeout(Duration timeout) Sets the Duration to wait for a file to be loaded into BigQuery before timing out when waiting synchronously.

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, configureMetrics, destroy, getActiveCount, getActiveCountLong, getComponentType, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getHandlerMetrics, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMetricsCaptor, getMinDuration, getOrder, getOverrides, getStandardDeviationDuration, isCountsEnabled, isLoggingEnabled, isStatsEnabled, registerMetricsCaptor, reset, sendTimer, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled, shouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.MessageHandlerMetrics

errorCount, handleCount

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Detail

BigQueryFileMessageHandler

public BigQueryFileMessageHandler(BigQueryTemplate bigQueryTemplate)

Method Detail

doInit

protected void doInit()

Overrides:

doInit in class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

setTableNameExpression

public void setTableNameExpression(org.springframework.expression.Expression tableNameExpression)

Sets the SpEL Expression to evaluate to determine the table name.

Parameters:

tableNameExpression - the SpEL expression used to evaluate the table name

setTableName

public void setTableName(String tableName)

Sets the BigQuery table name to use. This overwrites any previous settings made by setTableNameExpression(org.springframework.expression.Expression).

Parameters:

tableName - name of the BigQuery table

setFormatOptionsExpression

public void setFormatOptionsExpression(org.springframework.expression.Expression formatOptionsExpression)

Sets the SpEL Expression used to determine the FormatOptions for the handler.

Parameters:

formatOptionsExpression - the SpEL expression used to evaluate the FormatOptions

setFormatOptions

public void setFormatOptions(FormatOptions formatOptions)

Sets the handler's FormatOptions which describe the type/format of data files being loaded. This overwrites any previous settings made by setFormatOptionsExpression(org.springframework.expression.Expression).

Parameters:

formatOptions - the format of the data file being loaded

setTimeout

public void setTimeout(Duration timeout)

Sets the Duration to wait for a file to be loaded into BigQuery before timing out when waiting synchronously.

Parameters:

timeout - the Duration timeout to wait for a file to load

setSync

public void setSync(boolean sync)

A boolean indicating if the BigQueryFileMessageHandler should synchronously wait for each file to be successfully loaded to BigQuery.

If set to true, the handler runs synchronously and returns Job for message responses. If set to false, the handler will return ListenableFuture of the Job as the response for each message.

Parameters:

sync - whether BigQueryFileMessageHandler should wait synchronously for jobs to complete. Default is false (async).

handleRequestMessage

protected Object handleRequestMessage(org.springframework.messaging.Message<?> message)

Specified by:

handleRequestMessage in class org.springframework.integration.handler.AbstractReplyProducingMessageHandler