Microsoft Teams Connector 1.0 Reference - Mule 4
Anypoint Connector for Microsoft Teams (Microsoft Teams Connector) gives you access to the Microsoft Teams APIs.
Configurations
Authorization Code Config
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
||
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
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 instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
|||
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. |
60 |
|
Read Timeout Time unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
SECONDS |
OAuth 2.0 Authorization Code
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Proxy configuration |
Proxy configuration for the connector. |
|||
Response Type |
String |
Specifies the method to use to send the resulting token back to your app. It must be |
query |
|
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
|||
Consumer Key |
String |
OAuth consumerKey as registered with the service provider |
x |
|
Consumer Secret |
String |
OAuth consumerSecret as registered with the service provider |
x |
|
Authorization Url |
String |
The service provider’s authorization endpoint URL |
|
|
Access Token Url |
String |
The service provider’s accessToken endpoint URL |
|
|
Scopes |
String |
The OAuth scopes to request during the OAuth dance. If not provided, this value defaults to those in the annotation. |
||
Resource Owner Id |
String |
The resourceOwnerId that each component should use if it is not otherwise referenced. |
||
Before |
String |
Name of a flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of a flow to execute immediately after an accessToken is received. |
||
Listener Config |
String |
A reference to a |
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 |
If the callback endpoint is behind a proxy or must be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback. |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store. |
Client Credentials Config
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The supported connection types for this configuration. |
x |
||
Name |
String |
The identifier of this element that other components use to reference it. |
x |
|
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 instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
|||
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. |
60 |
|
Read Timeout Time unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
SECONDS |
OAuth 2.0 Client Credentials
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Proxy configuration |
Proxy configuration for the connector. |
|||
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
|||
Client Id |
String |
OAuth client ID as registered with the service provider. |
x |
|
Client Secret |
String |
OAuth client secret as registered with the service provider. |
x |
|
Token Url |
String |
The service provider’s token endpoint URL. |
|
|
Scopes |
String |
OAuth scopes to request during the OAuth dance. If not provided, the value defaults to those in the annotation. |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store. |
Add Channel Member
<microsoftTeams:add-channel-member>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team Id |
String |
Team Id that has a channel with the Id specified in Channel Id parameter |
x |
|
Channel Id |
String |
The channel id where the user should be added |
x |
|
User Id |
String |
Corresponding user id to be added as member |
x |
|
Owner |
Boolean |
True if this user should be the owner of the channel. |
false |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Group Members
<microsoftTeams:add-group-members>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group id where the members should be added |
x |
|
Member Ids |
Array of String |
A list of user IDs to add as members in the specified group. |
#[payload] |
|
Read Timeout |
Number |
Read Timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
Time unit value used by the Read Timeout parameter. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Add Team Member
<microsoftTeams:add-team-member>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team Id |
String |
Team Id where the user should be added |
x |
|
User Id |
String |
User ID of the user to add as a member of the specified team. |
x |
|
Owner |
Boolean |
Set to |
false |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Channel
<microsoftTeams:create-channel>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team id |
String |
Team Id where the channel should be created |
x |
|
Attributes |
Object |
Information regarding the channel to be created |
#[payload] |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Message
<microsoftTeams:create-message>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team id |
String |
Team Id where the channel is present |
x |
|
Channel id |
String |
Channel Id where the message should be published |
x |
|
Message |
Object |
The message to be published |
#[payload] |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Team
<microsoftTeams:create-team>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Attributes |
Object |
Information regarding the team to be created |
#[payload] |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Channel
<microsoftTeams:delete-channel>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team id |
String |
Team Id where the channel is present |
x |
|
Channel id |
String |
Channel id to be deleted |
x |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Team
<microsoftTeams:delete-team>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team Id |
String |
Team id to be removed |
x |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the read timeout. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Channel
<microsoftTeams:get-channel>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team id |
String |
Team Id where the channel is present |
x |
|
Channel id |
String |
Channel Id to be retrieved |
x |
|
Select |
String |
Properties to be retrieved in the response |
||
Expand |
String |
The response will include information regarding the specified relationship |
||
Filter |
String |
Use the filter query parameter to retrieve just a subset of a collection. |
||
Advanced Query Params |
Object |
|||
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Team
<microsoftTeams:get-team>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team id |
String |
Team Id to be retrieved |
x |
|
Select |
String |
Properties to be retrieved in the response |
||
Expand |
String |
The response will include information regarding the specified relationship |
||
Advanced Query Params |
Object |
|||
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
List Channel Members
<microsoftTeams:list-channel-members>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team Id |
String |
Team Id where the channel is present |
x |
|
Channel Id |
String |
Channel Id to list its members |
x |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List Channels
<microsoftTeams:list-channels>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team Id |
String |
Team Id to list its channels |
x |
|
Select |
String |
Properties to be retrieved in the response |
||
Filter |
String |
Use the filter query parameter to retrieve just a subset of a collection. |
||
Advanced Query Params |
Object |
|||
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List Group Members
<microsoftTeams:list-group-members>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group id to list its members |
x |
|
Select |
String |
Properties to be retrieved in the response |
||
Expand |
String |
The response will include information regarding the specified relationship |
||
Filter |
String |
Use the filter query parameter to retrieve just a subset of a collection. |
||
Order By |
String |
Use the orderby parameter to specify the sort order of the items returned |
||
Search |
String |
Use the search parameter to restrict the results of a request to match a search criterion |
||
Skip |
Number |
Use the skip parameter to set the number of items to skip at the start of a collection. |
||
Top |
Number |
Use the top query parameter to specify the page size of the result set. |
||
Count |
Boolean |
Retrieves the total count of matching resources. |
false |
|
Advanced Query Params |
Object |
|||
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List Team Members
<microsoftTeams:list-team-members>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team id |
String |
Team Id to list its members |
x |
|
Select |
String |
Properties to be retrieved in the response |
||
Filter |
String |
|||
Advanced Query Params |
Object |
|||
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
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. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Channel Member
<microsoftTeams:remove-channel-member>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team Id |
String |
Team Id where the channel is present |
x |
|
Channel Id |
String |
Channel Id that contains the member to be removed |
x |
|
Membership Id |
String |
The id of the member to be deleted |
x |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Group Member
<microsoftTeams:remove-group-member>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group id where the member to be removed is present |
x |
|
Member Id |
String |
User id that is member in this group |
x |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Team Member
<microsoftTeams:remove-team-member>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team id |
String |
Team Id that contains the member to be removed |
x |
|
Membership Id |
String |
The id of the member to be removed |
x |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Unauthorize
<microsoftTeams:unauthorize>
Deletes all the access token information of a given resource owner id so that it’s impossible to execute any operation for that user without doing the authorization dance again
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Resource Owner Id |
String |
The ID of the resource owner for whom to invalidate access. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
Update Channel
<microsoftTeams:update-channel>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Team Id |
String |
Team ID where the channel is present |
x |
|
Channel Id |
String |
Channel Id to be updated |
x |
|
Attributes |
Object |
Information regarding the channel to be updated |
#[payload] |
|
Read Timeout |
Number |
Read timeout value. |
||
Read Timeout Time Unit |
Enumeration, one of:
|
The time unit value used by the Read Timeout parameter. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Team
<microsoftTeams:update-team>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
Name of the configuration to use |
x |
|
Team id |
String |
ID of the team to update |
x |
|
Attributes |
Object |
Information to update |
#[payload] |
|
Read Timeout |
Number |
Read timeout value |
||
Read Timeout Time Unit |
Enumeration, one of:
|
Time unit value used by the Read Timeout parameter |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component |
x |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors |
Types
Proxy Configuration
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host |
String |
Host where the proxy requests will be sent. |
x |
|
Port |
Number |
Port where the proxy requests will be sent. |
x |
|
Username |
String |
The username to authenticate against the proxy. |
||
Password |
String |
The password to authenticate against the proxy. |
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 |
||||
Key Store |
||||
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. |
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 ms) 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 ms) 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:
|
A time unit that qualifies the maxIdleTime attribute |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |