Microsoft OneDrive Connector 1.0 Reference - Mule 4

Microsoft OneDrive Config

Parameters

Name	Type	Description	Default Value	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.		x
Connection	OAuth v2.0 Authorization Code OAuth v2.0 Client Credentials	The connection types to provide to this configuration.		x
Drive ID	String	Drive ID to use across all operations unless overwritten by the operation parameter.
Name	String	Identifier of the element used by other components for reference.		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.
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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout Time Unit field.	SECONDS

Name

Type

Description

Default Value

Required

Name

String

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

x

Connection

OAuth v2.0 Authorization Code
OAuth v2.0 Client Credentials

The connection types to provide to this configuration.

x

Drive ID

String

Drive ID to use across all operations unless overwritten by the operation parameter.

Name

String

Identifier of the element used by other components for reference.

x

Expiration Policy

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

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout Time Unit field.

SECONDS

Connection Types

OAuth v2.0 Authorization Code

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

Name	Type	Description	Default Value	Required
Proxy configuration	Proxy Configuration	Proxy configuration for the connector.
Response Type	String	Specifies the method to use to send the resulting token back to your app. This must be `query`.	query
TLS configuration	Tls	Configures TLS. If using the HTTPS protocol, you must configure TLS.
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.
Consumer Key	String	The OAuth consumerKey as registered with the service provider.		x
Consumer Secret	String	The OAuth consumerSecret as registered with the service provider		x
Authorization Url	String	The service provider’s authorization endpoint URL.	`https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize`
Access Token Url	String	The service provider’s accessToken endpoint URL.	`https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token`
Scopes	String	The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation.
Resource Owner Id	String	The resource owner ID for each component to use if it is not otherwise referenced.
Before	String	Name of the flow to execute immediately before starting the OAuth dance.
After	String	Name of the flow to execute immediately after an access token is received.
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.

Proxy configuration

Proxy Configuration

Proxy configuration for the connector.

Response Type

String

Specifies the method to use to send the resulting token back to your app. This must be query.

query

TLS configuration

Tls

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

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.

Consumer Key

String

The OAuth consumerKey as registered with the service provider.

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize

Access Token Url

String

The service provider’s accessToken endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation.

Resource Owner Id

String

The resource owner ID for each component to use if it is not otherwise referenced.

Before

String

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

After

String

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

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.

OAuth v2.0 Client Credentials

Access web-hosted resources by using the identity of the application.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Proxy configuration	Proxy Configuration	Proxy configuration for the connector.
TLS configuration	Tls	Configures TLS. If using the HTTPS protocol, you must configure TLS.
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.
Client Id	String	The OAuth client ID as registered with the service provider.		x
Client Secret	String	The OAuth client secret as registered with the service provider.		x
Token Url	String	The service provider’s token endpoint URL.	`https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token`
Scopes	String	The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation.
Object Store	String	Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Proxy configuration

Proxy Configuration

Proxy configuration for the connector.

TLS configuration

Tls

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

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.

Client Id

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret as registered with the service provider.

x

Token Url

String

The service provider’s token endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation.

Object Store

String

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

Add Permission

<microsoftOneDrive:add-permission>

Gives read or write access to a specified file for users that are specified in the Permissions Info field.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

ID of the drive driveItem to which to add this permission.

x

Permissions Info

Any

Information about the permission to add.

#[payload]

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve a list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Copy Drive Item

<microsoftOneDrive:copy-drive-item>

Executes a copy request to Microsoft OneDrive.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

ID of the driveItem to copy.

x

Parent DriveItem ID

String

ID of the folder to copy the selected driveItem to. If unspecified, the selected file is copied to the same folder in which it resides.

Conflict name

String

In case of conflict, specifies a new name for the drive item after the copy operation is completed.

Read Timeout

Number

Read timeout value. Used to override the Read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Create Drive Item

<microsoftOneDrive:create-drive-item>

Creates a new driveItem entity type in the specified OneDrive.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

Parent DriveItem ID

String

ID of the folder to copy the selected driveItem to.

x

Drive Item name

String

Name to use when creating the file.

x

DriveItem Type

Enumeration, one of:

FOLDER
FILE

The type of driveItem to create, which can be either FILE or FOLDER

FILE

Conflict behavior

Enumeration, one of:

RENAME
REPLACE
FAIL

Specifies what happens in case of a name conflict. Possible values are: FAIL, RENAME, REPLACE

FAIL

Item properties

Object

Additional properties to add to the file.

Use the Item properties field for folder or file metadata settings. The following example shows the Item properties field for folder metadata settings:

output application/json
---
{
"childCount": 1024,
"view": { "@odata.type": "microsoft.graph.folderView" }
}

The result request to Microsoft OneDrive is:

{
"name":"New Folder",
"folder": {
"childCount": 1024,
"view":{"@odata.type":"microsoft.graph.folderView"}
},
"@microsoft.graph.conflictBehavior":"rename"
}

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

The time unit value used by the read timeout

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Create Sharing Link

<microsoftOneDrive:create-sharing-link>

Creates a new sharing link. If a sharing link of the specified type already exists for the app, the existing sharing link is returned.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

ID of the driveItem for which to create the sharing link.

x

Link Type

Enumeration, one of:

VIEW
EDIT

Type of sharing link to create. Accepted values are view or edit. A value of view creates a read-only link to the driveItem. A value of edit creates a read-write link to the driveItem.

x

Scope Type

Enumeration, one of:

ANONYMOUS
ORGANIZATION

The scope of the link to create. Accepted values are anonymous and organization. A value of anonymous indicates the link is usable by anyone. A value of organization indicates the link is only usable for users who are signed in to the same tenant.

Expiration Date Time

String

Indicates the expiration time of the permission, specified as a string with a format of yyyy-MM-ddTHH:mm:ssZ for DateTime.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve a list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Delete Drive Item

<microsoftOneDrive:delete-drive-item>

Deletes a driveItem based on the specified ID.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

ID of the driveItem to delete.

x

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve a list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

Reconnection Strategy

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Get Drive Item By Id

<microsoftOneDrive:get-drive-item-by-id>

Retrieves information about the a driveItem based on the specified ID.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

ID of the driveItem to retrieve.

x

Select

String

Properties to retrieve in the response.

Expand

String

The response includes information about the specified relationship.

Advanced Query Params

Object

Additional OData queries that are not exposed as specific parameters.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Get Drive Item By Path

<microsoftOneDrive:get-drive-item-by-path>

Retrieves information about a driveItem based on the specified path.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem Path

String

Path of the driveItem to retrieve.

x

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information about the specified relationship.

Advanced Query Params

Object

Additional OData queries that are not exposed as specific parameters.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Get Root

<microsoftOneDrive:get-root>

Retrieves information about the root folder of a drive.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information about the specified relationship.

Advanced Query Params

Object

Additional OData queries that are not exposed as specific parameters.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

List Children

<microsoftOneDrive:list-children>

Retrieves a collection of driveItems from the driveItem’s child relationships.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

Folder ID

String

ID of the folder from which to extract the list of children.

x

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information about the specified relationship.

Order By

String

Parameter used to specify the sort order of the items returned.

Advanced Query Params

Object

Additional OData queries that are not exposed as specific parameters.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type	Array of Object

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

List Permissions

<microsoftOneDrive:list-permissions>

Retrieves a collection of permissions resources on a driveItem.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

The ID of the driveItem.

x

Select

String

Properties to retrieve in the response.

Advanced Query Params

Object

Additional OData queries that are not exposed as specific parameters.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate a driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Monitor Request

<microsoftOneDrive:monitor-request>

Retrieves information about an async request.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
URL	String	Location of the URL to query.		x
Read Timeout	Number	Read timeout value. Used to override the read timeout values defined in the connector configuration
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. The default is to use repeatable streams.
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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

URL

String

Location of the URL to query.

x

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Move Drive Item

<microsoftOneDrive:move-drive-item>

Executes a move request to Microsoft OneDrive.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

ID of the driveItem to move.

x

Parent DriveItem ID

String

ID of the folder to which to move the driveItem.

New DriveItem name

String

New name for the driveItem after it is moved.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate the driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Remove Permission

<microsoftOneDrive:remove-permission>

Removes access to a driveItem.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

DriveItem ID

String

ID of the driveItem.

x

Permission Id

String

ID of the permission to remove.

x

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate the driveItem.

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Unauthorize

<microsoftOneDrive: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 first repeating the authorization dance.

Parameters

Name	Type	Description	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

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

Microsoft OneDrive Config

Upload Content

<microsoftOneDrive:upload-content>

Uploads content of one file into another file in OneDrive.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

File ID

String

ID of the file to which to upload the content.

x

Content

Any

Content to upload.

#[payload]

Size

Number

Size of the content in bytes.

x

Preferred Request Size

Number

Preferred request size in megabytes. Minimum is 1 MB. Maximum is 60 MB.

10

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configures how Mule processes streams. The default is to use repeatable streams.

Location

Enumeration, one of:

GROUP
USER

Location from which to retrieve the list of drive IDs.

Entity ID

String

ID of the entity to use to retrieve the list of drives.

The Entity ID is either the user ID or the group ID, depending on which fetch location is used as the first parameter of the DriveInfo parameter group.

Drive ID

String

Drive ID used to locate the driveItem.

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Microsoft OneDrive Config

Throws

MICROSOFTONEDRIVE:BAD_REQUEST
MICROSOFTONEDRIVE:CONFLICT
MICROSOFTONEDRIVE:CONNECTIVITY
MICROSOFTONEDRIVE:FORBIDDEN
MICROSOFTONEDRIVE:INSUFFICIENT_STORAGE
MICROSOFTONEDRIVE:INVALID_CONNECTION
MICROSOFTONEDRIVE:INVALID_INPUT
MICROSOFTONEDRIVE:LOCKED
MICROSOFTONEDRIVE:NOT_FOUND
MICROSOFTONEDRIVE:RETRY_EXHAUSTED
MICROSOFTONEDRIVE:SERVER_ERROR
MICROSOFTONEDRIVE:TIMEOUT
MICROSOFTONEDRIVE:TOO_MANY_REQUESTS
MICROSOFTONEDRIVE:UNAUTHORIZED

Types

Proxy Configuration

Field	Type	Description	Required
Host	String	Host where the proxy requests are sent.	x
Port	Number	Port where the proxy requests are sent.	x
Username	String	The username to authenticate against the proxy.
Password	String	The password to authenticate against the proxy.

Field

Type

Description

Default Value

Required

Host

String

Host where the proxy requests are sent.

x

Port

Number

Port where the proxy requests are 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

Trust Store

Key Store

Key Store

Revocation Check

Standard Revocation Check
Custom OCSP Responder
CRL File

Trust Store

Field Type Description Default Value Required

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.
Password	String	Password used to protect the truststore.
Type	String	Type of truststore used.
Algorithm	String	The algorithm used by the truststore.
Insecure	Boolean	If `true`, Mule stops performing certificate validations. This can make connections vulnerable to attacks.

Path

String

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

Password

String

Password used to protect the truststore.

Type

String

Type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

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

Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.
Type	String	The type of store used.
Alias	String	When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.
Key Password	String	Password used to protect the private key.
Password	String	Password used to protect the keystore.
Algorithm	String	Algorithm used by the keystore.

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 keystore.

Type

String

The type of store used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Algorithm used by the keystore.

Standard Revocation Check

Field	Type	Description
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 previously selected).
Soft Fail	Boolean	Avoid verification failure when the revocation server cannot be reached or is busy.

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 previously selected).

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot 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 truststore), if present.

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 truststore), if present.

CRL File

Field	Type	Description	Default Value	Required
Path	String	The path to the 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

Reconnect
Reconnect Forever

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 can 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.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the memory stream. If the stream 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

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 content on the disk is buffered.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed.

Repeatable In Memory Iterable

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

The number of instances that are initially allowed to be kept 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 bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. 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 zero or lower means that the buffer should 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

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.

Repeatable File Store Iterable

Field

Type

Description

Default Value

Required

In Memory Objects

Number

The maximum number 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

The unit in which maxInMemorySize is expressed.