Contact Us 1-800-596-4880
  1. Homepage
  2. Google BigQuery Connector (1.1)

  3. Google BigQuery Connector Reference

All Connectors

Google BigQuery Connector 1.1 Reference - Mule 4

Configurations

Configuration

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

30

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

JWT Connection
Parameters
Name Type Description Default Value Required

Project Id

String

Project ID.

Base Uri

String

Parameter base URI. Each instance or tenant gets its own base URI.

https://bigquery.googleapis.com/bigquery/v2

Default Headers

Object

Default headers to include in the request.

Query Parameters

Object

Query parameters to include in the request.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Proxy

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Name app

String

Parameter app name.

appName1

Private Key Id

String

Private key ID for the Google connected app.

x

Private Key

String

Private key for the Google connected app.

x

Issuer

String

Client email.

x

Audience Url

String

The audience identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token. Use the authorization server’s URL for the audience value: https://bigquery.googleapis.com/.

https://bigquery.googleapis.com/

Token Timeout

Number

Timeout for the token.

3600

Token Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Token Timeout field.

SECONDS

Protocol

Enumeration, one of: HTTP HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

TLS configuration.

Reconnection

Reconnection

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.
Oauth2 Connection

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

Parameters
Name Type Description Default Value Required

Project Id

String

Project ID.

Base Uri

String

Parameter base URI. Each instance or tenant gets its own parameter base URI.

https://bigquery.googleapis.com/bigquery/v2

Default Headers

Object

Default headers to include in the request.

Query Parameters

Object

Query parameters to include in the request.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Proxy

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Name app

String

Parameter app name.

appName1

Access_type

String

Indicates whether to refresh access tokens when the user is not present at the browser.

  • online

    Retrieves an access token.

  • offline

    Retrieves a refresh token and an access token.

offline

Prompt

String

Prompt.

consent

Refresh Token Condition

String

Refresh condition.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint.

https://accounts.google.com/o/oauth2/auth

Access Token Url

String

URL of the service provider’s access token endpoint.

https://oauth2.googleapis.com/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

https://www.googleapis.com/auth/bigquery

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Supported Operations

Associated Sources

Operations

Cancel Job

<bigquery:cancel-job>

Cancels a job. This operation makes an HTTP POST request to the /project/{projectId}/jobs/{jobId}/cancel endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Job Id

String

Job ID.

x

Content Type

String

Content type.

application/json

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • BIGQUERY:BAD_REQUEST

  • BIGQUERY:CLIENT_ERROR

  • BIGQUERY:CONNECTIVITY

  • BIGQUERY:INTERNAL_SERVER_ERROR

  • BIGQUERY:NOT_FOUND

  • BIGQUERY:PROJECT_NOT_FOUND

  • BIGQUERY:RETRY_EXHAUSTED

  • BIGQUERY:SERVER_ERROR

  • BIGQUERY:TIMEOUT

  • BIGQUERY:UNAUTHORIZED

Delete Job

<bigquery:delete-job>

Deletes a job. This operation makes an HTTP DELETE request to the /project/{projectId}/job/{jobId} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Job Id

String

Job ID.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • BIGQUERY:BAD_REQUEST

  • BIGQUERY:CLIENT_ERROR

  • BIGQUERY:CONNECTIVITY

  • BIGQUERY:INTERNAL_SERVER_ERROR

  • BIGQUERY:NOT_FOUND

  • BIGQUERY:PROJECT_NOT_FOUND

  • BIGQUERY:RETRY_EXHAUSTED

  • BIGQUERY:SERVER_ERROR

  • BIGQUERY:TIMEOUT

  • BIGQUERY:UNAUTHORIZED

Get Job

<bigquery:get-job>

Gets a job. This operation makes an HTTP GET request to the /project/{projectId}/jobs/{jobId} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Job Id

String

Job ID.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • BIGQUERY:BAD_REQUEST

  • BIGQUERY:CLIENT_ERROR

  • BIGQUERY:CONNECTIVITY

  • BIGQUERY:INTERNAL_SERVER_ERROR

  • BIGQUERY:NOT_FOUND

  • BIGQUERY:PROJECT_NOT_FOUND

  • BIGQUERY:RETRY_EXHAUSTED

  • BIGQUERY:SERVER_ERROR

  • BIGQUERY:TIMEOUT

  • BIGQUERY:UNAUTHORIZED

Get Query Results

<bigquery:get-query-results>

Get results of a query. This operation makes an HTTP GET request to the /projects/{projectId}/queries/{jobId} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Job Id

String

Job ID.

Start Index

Number

Zero-based index of the starting row.

0

Max Results

Number

Maximum number of comments to return per page.

30

Page Token

String

Token for continuing a previous list request on the next page. Set this parameter to the value of nextPageToken from the previous response. This field takes precedence over Start Index and Max Results.

Location

String

Geographic location of the job.

Time out

String

Specifies the maximum amount of time, in milliseconds, to wait for the query to complete.

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

Array of Any

For Configurations

Throws

  • BIGQUERY:BAD_REQUEST

  • BIGQUERY:CLIENT_ERROR

  • BIGQUERY:CONNECTIVITY

  • BIGQUERY:INTERNAL_SERVER_ERROR

  • BIGQUERY:NOT_FOUND

  • BIGQUERY:PROJECT_NOT_FOUND

  • BIGQUERY:SERVER_ERROR

  • BIGQUERY:TIMEOUT

  • BIGQUERY:UNAUTHORIZED

Insert Job

<bigquery:insert-job>

Inserts a job. This operation makes an HTTP POST request to the /project/{projectId}/jobs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Job Values Content

Any

Job values content.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • BIGQUERY:BAD_REQUEST

  • BIGQUERY:CLIENT_ERROR

  • BIGQUERY:CONNECTIVITY

  • BIGQUERY:INTERNAL_SERVER_ERROR

  • BIGQUERY:NOT_FOUND

  • BIGQUERY:PROJECT_NOT_FOUND

  • BIGQUERY:RETRY_EXHAUSTED

  • BIGQUERY:SERVER_ERROR

  • BIGQUERY:TIMEOUT

  • BIGQUERY:UNAUTHORIZED

List Jobs

<bigquery:list-jobs>

Lists jobs. This operation makes an HTTP GET request to the /projects/{projectId}/jobs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Content Type

String

Content type.

application/json

Max Results

Number

Maximum number of comments to return per page.

30

Pretty Print

Boolean

Returns the response with indentations and line breaks.

false

Page Token

String

Token for continuing a previous list request on the next page. Set this parameter to the value of nextPageToken from the previous response.

Quota User

String

Opaque string that represents a user for quota purposes. Must not exceed 40 characters.

User Ip

String

Deprecated. Use Quota User instead.

fields

String

Selector specifying which fields to include in a partial response.

Min Created Time

String

Minimum value of modifiedTime for the result comments (RFC 3339 date-time).

Max Created Time

String

Maximum value of modifiedTime for the result comments (RFC 3339 date-time).

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • BIGQUERY:BAD_REQUEST

  • BIGQUERY:CLIENT_ERROR

  • BIGQUERY:CONNECTIVITY

  • BIGQUERY:INTERNAL_SERVER_ERROR

  • BIGQUERY:NOT_FOUND

  • BIGQUERY:PROJECT_NOT_FOUND

  • BIGQUERY:SERVER_ERROR

  • BIGQUERY:TIMEOUT

  • BIGQUERY:UNAUTHORIZED

Query

<bigquery:query>

Executes a query. This operation makes an HTTP POST query request to the /projects/{projectId}/queries endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Query Values Content

Any

Query values content.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

Array of Any

For Configurations

Throws

  • BIGQUERY:BAD_REQUEST

  • BIGQUERY:CLIENT_ERROR

  • BIGQUERY:CONNECTIVITY

  • BIGQUERY:INTERNAL_SERVER_ERROR

  • BIGQUERY:NOT_FOUND

  • BIGQUERY:PROJECT_NOT_FOUND

  • BIGQUERY:SERVER_ERROR

  • BIGQUERY:TIMEOUT

  • BIGQUERY:UNAUTHORIZED

Unauthorize

<bigquery:unauthorize>

Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

For Configurations

Sources

On Table Row

<bigquery:on-table-row>

Returns all rows of a table based on a watermark.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Dataset Name

String

Name of the table to select from.

x

Table Name

String

Name of the table to select from.

x

Watermark Column

String

Name of the column to use for the watermark. Values taken from this column are used to filter the contents of the next poll, so that rows only with a greater watermark value are processed.

Since

String

Value to use as watermarking.

Column Id

String

Name of the column to consider as the row ID. If provided, this parameter ensures that the same row is not processed twice by concurrent polls.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Types

Proxy

Configures a proxy for outbound connections.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

Comma-separated list of hosts that the proxy must not be used against.

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

HTTP Response Attributes

Configures HTTP response attributes for the configuration.

Field Type Description Default Value Required

Status Code

Number

HTTP status code of the response.

x

Headers

Object

Map of HTTP headers in the message.

x

Reason Phrase

String

HTTP reason phrase of the response.

x

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Redelivery Policy Message Identifier

One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field Type Description Default Value Required

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

See Also

Back to top
View on GitHub