Azure Data Lake Storage Connector Module Connector Reference
Configurations
Parameters
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 |
||
Response Timeout |
Number |
The timeout for requests to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
AUTO |
|
Name |
String |
The identifier of this element used in other components 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. |
Connection Types
OAuth 2.0 Connection Provider
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 |
---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Timeout |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections that to keep open at the same time |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base URI |
String |
Parameter base URI, each instance/tenant gets its own |
x |
|
X-MS-Version |
String |
Specifies the version of the REST API protocol used for processing the request |
2018-11-09 |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
Shared Access Signature
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Timeout |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection will be closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections that will be kept open at the same time |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not to stream received responses |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response is stored. |
-1 |
|
Storage account name |
String |
Storage account name |
x |
|
DNS Suffix |
String |
DNS suffix of the storage. The DNS suffix works only with |
x |
|
Sas Token |
String |
SAS token for the Azure Data Lake Storage account. |
x |
|
TLS Configuration |
||||
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. |
Shared Key Connection
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Timeout |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections to keep open concurrently |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not to stream received responses |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response is stored. |
-1 |
|
Storage account name |
String |
Storage account name |
x |
|
DNS Suffix |
String |
DNS suffix of the storage. The DNS suffix works only with |
x |
|
X-MS-Version |
String |
Specifies the version of the REST protocol used for processing the request |
x |
|
Account Key |
String |
Password used to access the Azure Data Lake Storage account. |
x |
|
TLS Configuration |
||||
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. |
Create File System
<azure-data-lake-storage:create-file-system>
Creates a file system on the storage account.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
X-MS-Properties |
String |
User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Create/Rename Path
<azure-data-lake-storage:create-or-rename>
Creates or renames a file or directory path on the provided file system.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Path |
String |
Target path. |
x |
|
Resource |
String |
Only required for creation. The value must be |
||
Continuation |
String |
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. |
||
Mode |
String |
Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be |
||
X-MS-Rename Source |
String |
An optional file or directory to rename. The value must have the following format:`/{filesystem}/{path}`. If |
||
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Cache Control |
String |
The service stores this value and includes it in the "Cache-Control" response header for |
||
Content Encoding |
String |
Specifies which content encodings are applied to the file. This value is returned to the client when the |
||
Content Language |
String |
Optional. Specifies the natural language used by the intended audience for the file. |
||
Content Disposition |
String |
The service stores this value and includes it in the "Content-Disposition" response header for |
||
X-MS-Cache Control |
String |
The service stores this value and includes it in the "Cache-Control" response header for |
||
X-MS-Content Type |
String |
The service stores this value and includes it in the "Content-Type" response header for |
||
X-MS-Content Encoding |
String |
The service stores this value and includes it in the "Content-Encoding" response header for |
||
X-MS-Content Language |
String |
The service stores this value and includes it in the "Content-Language" response header for |
||
X-MS-Content Disposition |
String |
The service stores this value and includes it in the "Content-Disposition" response header for |
||
X-MS-Lease ID |
String |
A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match. |
||
X-MS-Source Lease ID |
String |
Optional for rename operations. A lease ID for the source path. The source path must have an active lease and the lease ID must match. |
||
X-MS-Properties |
String |
User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, |
||
X-MS-Permissions |
String |
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. |
||
X-MS-Umask |
String |
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory, if the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. |
||
If Match |
String |
An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes. |
||
If None Match |
String |
An ETag value or the special wildcard ( |
||
If Modified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
||
If Unmodified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
||
X-MS-Source If Match |
String |
An ETag value. Specify this header to perform the rename operation only if the source’s ETag matches the value specified. The ETag must be specified in quotes. |
||
X-MS-Source If None Match |
String |
An ETag value or the special wildcard ( |
||
X-MS-Source If Modified Since |
String |
A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time. |
||
X-MS-Source If Unmodified Since |
String |
A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Delete File System
<azure-data-lake-storage:delete-file-system>
Deletes a file system on the Storage account.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
If Modified Since |
String |
Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
||
If Unmodified Since |
String |
Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
||
X-MS-Properties |
String |
User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Delete Path
<azure-data-lake-storage:delete-path>
Deletes a path.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Path |
String |
Target path. |
x |
|
Continuation |
String |
When deleting a directory, the number of paths that are deleted with each invocation is limited. |
||
Recursive |
String |
Required for directory only. If |
||
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
X-MS-Lease ID |
String |
A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match. |
||
If Match |
String |
An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes. |
||
If None Match |
String |
An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes. |
||
If Modified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
||
If Unmodified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Get Path Properties
<azure-data-lake-storage:get-path-properties>
Retrieves the properties of a path.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Path |
String |
Target path. |
x |
|
Action |
String |
Optional. If the value is |
||
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
UPN |
Boolean |
Optional. Valid only when Hierarchical Namespace is enabled for the account. If |
false |
|
X-MS-Lease ID |
String |
A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match. |
||
If Match |
String |
An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes. |
||
If None Match |
String |
An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes. |
||
If Modified Since |
String |
Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
||
If Unmodified Since |
String |
Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Lease path
<azure-data-lake-storage:lease-path>
Create and manage a lease to restrict write and delete access to the path.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Path |
String |
Target path. |
x |
|
X-MS-Lease Action |
String |
The lease action, which can be: |
x |
|
X-MS-Lease ID |
String |
Required when "x-ms-lease-action" is |
||
X-MS-Lease Duration |
Number |
The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for an infinite lease. |
||
X-MS-Proposed Lease ID |
String |
Required when "X-MS-Lease Action" is |
||
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
X-MS-Lease Break Period |
Number |
Optional. Breaks a lease, and specifies the break period duration of the lease in seconds. The lease break duration must be between 0 and 60 seconds. |
||
If Match |
String |
Optional. An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes. |
||
If None Match |
String |
Optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes. |
||
If Modified Since |
String |
Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
||
If Unmodified Since |
String |
Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
List File Systems
<azure-data-lake-storage:list-file-systems>
Lists all the file systems on the account.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Continuation |
String |
Number of file systems returned with each invocation is limited. If the number of file systems to return exceeds this limit, a continuation token is returned in the response header x-ms-continuation. |
||
Max Results |
Number |
An optional value that specifies the maximum number of items to return. If omitted, or greater than 5,000, the response will include up to 5,000 items. |
||
Prefix |
String |
Filters results to file systems within the specified prefix. |
||
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
List Paths
<azure-data-lake-storage:list-paths>
List all paths of a file system.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Recursive |
Boolean |
If |
false |
|
Continuation |
String |
The number of paths returned with each invocation is limited. If the number of paths to return exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths. |
||
Directory |
String |
Filters results to paths within the specified directory. An error occurs if the directory does not exist. |
||
Max Results |
Number |
An optional value that specifies the maximum number of items to return. If omitted, or greater than 5,000, the response will include up to 5,000 items. |
||
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
UPN |
Boolean |
Optional. Valid only when Hierarchical Namespace is enabled for the account. If |
false |
|
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Read Path
<azure-data-lake-storage:read-path>
Read the contents of a file.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Path |
String |
Target path. |
x |
|
Range |
String |
The HTTP range request header specifies one or more byte ranges of the resource to be retrieved. |
||
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
X-MS-Lease ID |
String |
A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match. |
||
X-MS-Range Get Content MD5 |
String |
Optional. When this header is set to |
||
If Match |
String |
An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes. |
||
If None Match |
String |
An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes. |
||
If Modified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
||
If Unmodified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Update Path
<azure-data-lake-storage:update-path>
Uploads data to append to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
File System |
String |
Target file system. |
x |
|
Path |
String |
Target path. |
x |
|
Action |
String |
Action to perform, must be |
x |
|
Position |
Number |
Allows the caller to upload data in parallel and control the order in which it is appended to the file. |
x |
|
Content Length |
Number |
Required for Append or Flush data. Must be |
x |
|
Content |
Binary |
The payload to upload. |
#[payload] |
|
Timeout |
Number |
Optional. Timeout value expressed in seconds. |
||
Close |
String |
Allow applications to receive notifications when files change. |
||
Retain Uncommitted Data |
Boolean |
Valid for flush operations. If true, uncommitted data is retained after the flush operation completes. Defaults to false. |
false |
|
Content MD5 |
String |
An MD5 hash of the request content. This header is valid on |
||
X-MS-Lease ID |
String |
A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match. |
||
X-MS-Cache Control |
String |
The service stores this value and includes it in the "Cache-Control" response header for |
||
X-MS-Content Type |
String |
The service stores this value and includes it in the "Content-Type" response header for |
||
X-MS-Content Encoding |
String |
The service stores this value and includes it in the "Content-Encoding" response header for |
||
X-MS-Content Language |
String |
The service stores this value and includes it in the "Content-Language" response header for |
||
X-MS-Content Disposition |
String |
The service stores this value and includes it in the "Content-Disposition" response header for |
||
X-MS-Content MD5 |
String |
Optional and only valid for Flush & Set Properties operations. The service stores this value and includes it in the "Content-Md5" response header for Read & Get Properties operations. |
||
X-MS-Properties |
String |
User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, |
||
X-MS-Permissions |
String |
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. |
||
X-MS-Owner |
String |
Optional and valid only for the setAccessControl Operation. Sets the owner of the file or directory. |
||
X-MS-Group |
String |
Optional and valid only for the setAccessControl operation. Sets the owner of the file or directory. |
||
X-MS-ACL |
String |
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. |
||
If Match |
String |
An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes. |
||
If None Match |
String |
An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes. |
||
If Modified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
||
If Unmodified Since |
String |
A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
||
X-MS-Client Request ID |
String |
A UUID recorded in the analytics logs for troubleshooting and correlation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
An 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. |
Throws
-
AZURE-DATA-LAKE-STORAGE:BAD_REQUEST
-
AZURE-DATA-LAKE-STORAGE:CLIENT_ERROR
-
AZURE-DATA-LAKE-STORAGE:CONNECTIVITY
-
AZURE-DATA-LAKE-STORAGE:INTERNAL_SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:NOT_ACCEPTABLE
-
AZURE-DATA-LAKE-STORAGE:NOT_FOUND
-
AZURE-DATA-LAKE-STORAGE:RETRY_EXHAUSTED
-
AZURE-DATA-LAKE-STORAGE:SERVER_ERROR
-
AZURE-DATA-LAKE-STORAGE:SERVICE_UNAVAILABLE
-
AZURE-DATA-LAKE-STORAGE:TIMEOUT
-
AZURE-DATA-LAKE-STORAGE:TOO_MANY_REQUESTS
-
AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED
-
AZURE-DATA-LAKE-STORAGE:UNSUPPORTED_MEDIA_TYPE
Types
Proxy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
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 truststore. |
||
Password |
String |
The password used to protect the truststore. |
||
Type |
String |
The type of truststore used. |
||
Algorithm |
String |
The algorithm used by the truststore. |
||
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 keystore. |
||
Type |
String |
The type of keystore 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 |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the keystore. |
||
Algorithm |
String |
The algorithm used by the keystore. |
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 will fail 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 |
HTTP Response Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In-Memory Stream
When streaming in this mode, Mule does not use the disk to buffer the contents. If you exceed the buffer size, the message fails.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than what can fit into this buffer, then it expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This specifies the increment for how much the buffer size will expand if it exceeds its initial specified size. Setting a value of zero or lower means that the buffer should not expand, and a |
||
Max Buffer Size |
Number |
This is 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 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
File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
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 |