lookupFromGoogleStorage

Processor that looks up an object from a Google Cloud Storage bucket.

If found, the object becomes the payload, with any desired metadata as the message exchange properties. If the object is not found, processing will stop with an error saying that no object was found in the bucket with the given key.

See the JavaDoc on the RetrySettings class from the Google API Extensions for Java project for a more in-depth explanation of the retry configuration properties.

Properties

Name Summary

Name	Summary
`forwardProperty()`	Adds a property from the object’s metadata to a list to convert into message exchange properties. If an exchange property with the same name already exists, it will be replaced.
`bucketName`	The Google Cloud Storage bucket name the object will be read from. Required.
`objectKeyExpr`	Optional expression used to determine the key of the object to obtain from storage. If this is not set, the payload will be converted to a string and used as the key.
`authenticationConfigKey`	A secret key that the server uses to look up the credentials needed to perform the Google authentication. Required.
`connectionTimeoutMillis`	The timeout of the HTTP client socket connection. Optional.
`receiveTimeoutMillis`	The socket timeout to wait for the first byte of response from the server. Optional.
`retryTotalTimeoutMillis`	The total amount of time the channel can spend on a request (including retries) before failing the request. Required.
`retryMaxAttempts`	The maximum number of retry attempts the channel can perform before failing the request. Required.
`retryInitialDelayMillis`	The delay before performing the first retry after the original request has failed. Required.
`retryDelayMultiplier`	The multiplier to apply to the previous retry delay when calculating the next retry delay. `1.0` means the same amount of time between all retries. Required.
`retryMaxDelayMillis`	The maximum time to wait between retries. Overrides the value calculated by applying `retryDelayMultiplier`. Required.
`retryInitialTimeoutMillis`	The initial time to allow before timing out a request. Required.
`retryTimeoutMultiplier`	The multiplier to apply to the previous timeout when calculating the timeout to apply to the next retry. `1.0` means that the same timeout is applied to all requests. Required.
`retryMaxTimeout`	The maximum timeout to apply to retry. Overrides the value calculated by applying `retryTimeoutMultiplier`. Required.
`name`	Optional, descriptive name for the processor.
`id`	Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern `[a-zA-Z][a-zA-Z0-9_-]{2,29}`.
`exchangeProperties`	Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.
`retainPayloadOnFailure`	Whether the incoming payload is available for error processing on failure. Defaults to `false`.

forwardProperty()

Adds a property from the object’s metadata to a list to convert into message exchange properties. If an exchange property with the same name already exists, it will be replaced.

bucketName

The Google Cloud Storage bucket name the object will be read from. Required.

objectKeyExpr

Optional expression used to determine the key of the object to obtain from storage. If this is not set, the payload will be converted to a string and used as the key.

authenticationConfigKey

A secret key that the server uses to look up the credentials needed to perform the Google authentication. Required.

connectionTimeoutMillis

The timeout of the HTTP client socket connection. Optional.

receiveTimeoutMillis

The socket timeout to wait for the first byte of response from the server. Optional.

retryTotalTimeoutMillis

The total amount of time the channel can spend on a request (including retries) before failing the request. Required.

retryMaxAttempts

The maximum number of retry attempts the channel can perform before failing the request. Required.

retryInitialDelayMillis

The delay before performing the first retry after the original request has failed. Required.

retryDelayMultiplier

The multiplier to apply to the previous retry delay when calculating the next retry delay. 1.0 means the same amount of time between all retries. Required.

retryMaxDelayMillis

The maximum time to wait between retries. Overrides the value calculated by applying retryDelayMultiplier. Required.

retryInitialTimeoutMillis

The initial time to allow before timing out a request. Required.

retryTimeoutMultiplier

The multiplier to apply to the previous timeout when calculating the timeout to apply to the next retry. 1.0 means that the same timeout is applied to all requests. Required.

retryMaxTimeout

The maximum timeout to apply to retry. Overrides the value calculated by applying retryTimeoutMultiplier. Required.

name

Optional, descriptive name for the processor.

id

Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern [a-zA-Z][a-zA-Z0-9_-]{2,29}.

exchangeProperties

Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.

retainPayloadOnFailure

Whether the incoming payload is available for error processing on failure. Defaults to false.

Sub-builders

Name	Summary
externalSystemDetails	Strategy for describing the external system integration. Optional.
circuitBreakerStrategy	Strategy for configuring the processor’s circuit breaker. Optional.
messageLoggingStrategy	Strategy for describing how a processor’s message is logged on the server.
payloadArchivingStrategy	Strategy for archiving payloads.
inboundTransformationStrategy	Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Name

Summary

externalSystemDetails

Strategy for describing the external system integration. Optional.

circuitBreakerStrategy

Strategy for configuring the processor’s circuit breaker. Optional.

messageLoggingStrategy

Strategy for describing how a processor’s message is logged on the server.

payloadArchivingStrategy

Strategy for archiving payloads.

inboundTransformationStrategy

Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Details

Authentication

The authenticationConfigKey property supports secrets of type GoogleServiceAccountCredentials. See the Secret Types documentation for formatting details.

Was this page helpful?