writeToGoogleStorage

Processor that writes payloads to a Google Cloud Storage bucket.

The name of the object is set to the internal message ID by default. This behaviour can be overridden by using the standard fileName exchange property.

See the JavaDoc on the RetrySettings 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 name to a list of exchange properties that are stored as metadata alongside the payload.
`bucketName`	The Google Cloud Storage bucket name under which the payload is stored. Required.
`authenticationConfigKey`	A secret key that the server uses to look up the credentials needed to perform the Google authentication. Required.
`retainPayload`	Whether to retain the payload after writing it to Google Storage, making it available for processing in downstream processors. Defaults to `false` (i.e., the payload is removed after it is written to Google).
`defaultContentType`	Default content MIME type (e.g., `application/json; charset=utf-8`) to associate with the payload. Content type can also be defined dynamically by setting the standard `contentType` exchange property. Optional.
`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 the `retryDelayMultiplier` property. 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 requests. Overrides the value calculated by applying the `retryTimeoutMultiplier` property. 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 name to a list of exchange properties that are stored as metadata alongside the payload.

bucketName

The Google Cloud Storage bucket name under which the payload is stored. Required.

authenticationConfigKey

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

retainPayload

Whether to retain the payload after writing it to Google Storage, making it available for processing in downstream processors. Defaults to false (i.e., the payload is removed after it is written to Google).

defaultContentType

Default content MIME type (e.g., application/json; charset=utf-8) to associate with the payload. Content type can also be defined dynamically by setting the standard contentType exchange property. Optional.

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 the retryDelayMultiplier property. 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 requests. Overrides the value calculated by applying the retryTimeoutMultiplier property. 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

Name	Summary
externalSystemDetails	Strategy for describing the external system integration. Optional.
processingStrategy	Strategy for providing message processing hints to the server. The `concurrencyMaxNo` property should be set, because the underlying Google writer client is blocking.
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.

externalSystemDetails

Strategy for describing the external system integration. Optional.

processingStrategy

Strategy for providing message processing hints to the server. The concurrencyMaxNo property should be set, because the underlying Google writer client is blocking.

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?