Contact Us 1-800-596-4880
  1. Homepage
  2. Coda Connector (0.1)

  3. Coda Connector Reference

All Connectors

Coda Connector 0.1.0 Reference

Configurations

Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Bearer

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components.

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. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Bearer
Parameters
Name Type Description Default Value Required

baseUri

String

The base URI for the Coda API endpoint.

x

token

String

The authentication token for accessing the Coda API.

x

TLS Configuration

Tls

TLS configuration for secure connections.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

addPermission

<coda:add-permission>

Adds a permission to a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

createDoc

<coda:create-doc>

Creates a new Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

createPage

<coda:create-page>

Creates a new page in a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

deleteDoc

<coda:delete-doc>

Deletes a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

deletePage

<coda:delete-page>

Deletes a page from a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

pageIdOrName

String

The ID or name of the page.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

deletePermission

<coda:delete-permission>

Deletes a permission from a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

permissionId

String

The ID of the permission.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

deleteRow

<coda:delete-row>

Deletes a row from a table in a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

tableIdOrName

String

The ID or name of the table.

x

rowIdOrName

String

The ID or name of the row.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

deleteRows

<coda:delete-rows>

Deletes multiple rows from a table in a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

tableIdOrName

String

The ID or name of the table.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

getAclSettings

<coda:get-acl-settings>

Retrieves the ACL settings for a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

getDoc

<coda:get-doc>

Retrieves a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

getFolder

<coda:get-folder>

Retrieves a Coda folder.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

folderId

String

The ID of the folder.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

getPage

<coda:get-page>

Retrieves a page from a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

pageIdOrName

String

The ID or name of the page.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:GONE

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

getPermissions

<coda:get-permissions>

Retrieves permissions for a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

getSharingMetadata

<coda:get-sharing-metadata>

Retrieves sharing metadata for a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

listCategories

<coda:list-categories>

Lists all available categories in Coda.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

listDocs

<coda:list-docs>

Lists Coda documents.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

isOwner

Boolean

Filter to documents owned by the current user.

false

isPublished

Boolean

Filter to published documents.

false

query

String

Search query string.

sourceDoc

String

Filter to documents copied from the specified source document.

isStarred

Boolean

Filter to starred documents.

false

inGallery

Boolean

Filter to documents in the gallery.

false

workspaceId

String

The ID of the workspace.

folderId

String

The ID of the folder.

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

listPages

<coda:list-pages>

Lists pages in a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

publishDoc

<coda:publish-doc>

Publishes a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

searchPrincipals

<coda:search-principals>

Searches for principals in a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

query

String

Search query string.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

unpublishDoc

<coda:unpublish-doc>

Unpublishes a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

updateAclSettings

<coda:update-acl-settings>

Updates the ACL settings for a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

updateDoc

<coda:update-doc>

Updates a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

updatePage

<coda:update-page>

Updates a page in a Coda document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

docId

String

The ID of the Coda document.

x

pageIdOrName

String

The ID or name of the page.

x

body

Any

The request body payload.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:BAD_REQUEST

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:NOT_FOUND

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

whoami

<coda:whoami>

Retrieves information about the current user.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • CODA:CLIENT_ERROR

  • CODA:CONNECTIVITY

  • CODA:FORBIDDEN

  • CODA:SECURITY

  • CODA:SERVER_ERROR

  • CODA:TIMEOUT

  • CODA:TOO_MANY_REQUESTS

  • CODA:UNAUTHORIZED

Types

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Configuration for the trust store.

Key Store

Key Store

Configuration for the key store.

Revocation Check

Configuration for the revocation check.

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

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

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

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

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

The source error type.

Target

String

The target error type to map to.

x
Back to top
View on GitHub