Zuora Aqua Connector Reference | MuleSoft Documentation
# Zuora Aqua Connector Reference
Support Version: Select
Zuora AQuA Connector v1.0.0
## Configurations
### Config
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection |  Basic Connection Provider | The connection types to provide to this configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the response timeout  
The identifier of this element used to reference it in other components  
Expiration Policy |  Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before it is eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances when appropriate.  
#### Connection Types
##### Basic Connection Provider
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | The timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the connection timeout  
Use Persistent Connections | If `false`, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections kept open at the same time  
Connection Idle Timeout | A timeout for how long a connection can remain idle before it is closed  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the connection idle timeout  
Proxy Config | Reusable configuration element for outbound connections through a proxy  
Stream Response | Whether or not to stream the received responses  
Response Buffer Size | The space (in bytes) for the buffer where the HTTP response will be stored.  
Username | The username to authenticate the requests  
Password | The password to authenticate the requests  
Base Uri | Parameter base URI, each instance or tenant gets its own | `https://rest.apisandbox.zuora.com:443`  
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.  
## Operations
  * Post Query or Export Deleted Data
  * Delete a Running Job
  *   * Get Last Job Completed
  * Get Results Files


## Sources
  * Batch JobResponse Result Listener


This source (listener) uses Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs. For more information, see The Different Types of Object Stores Explained.   
---  
## Post Query or Export Deleted Data
`<mule-zuora-aqua-connector:create-v1-batch-query>`
This operation makes an HTTP POST request to the `/v1/batch-query/` endpoint.
The POST query is used for:
  * Export deleted data
  * Post query with API version
  * Post query with notification
  * Post query with retrieval time


### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is valid only for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header.  
The content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the response timeout.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
### Throws
  * MULE-ZUORA-AQUA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-AQUA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-AQUA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-AQUA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-AQUA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-AQUA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Delete a Running Job
`<mule-zuora-aqua-connector:delete-v1-batch-query-jobs-by-id>`
This REST API deletes the current job if the job is not complete. If the job is complete, an error is thrown. This operation makes an HTTP DELETE request to the `/v1/batch-query/jobs/{id}` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of the job.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is valid only for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the response timeout  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * MULE-ZUORA-AQUA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-AQUA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-AQUA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-AQUA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-AQUA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-AQUA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * MULE-ZUORA-AQUA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-AQUA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-AQUA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-AQUA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-AQUA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-AQUA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get Job Results
`<mule-zuora-aqua-connector:get-v1-batch-query-jobs-by-id>`
Retrieves an aggregate query using the Job ID. This operation makes an HTTP GET request to the /v1/batch-query/jobs/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of the job.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is valid only for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the Response Timeout}  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * MULE-ZUORA-AQUA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-AQUA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-AQUA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-AQUA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-AQUA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-AQUA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get Last Job Completed
`<mule-zuora-aqua-connector:get-v1-batch-query-jobs-partner-project-by-partner-project>`
Returns the details of the last completed job. This operation makes an HTTP GET request to the /v1/batch-query/jobs/partner/{partner}/project/{project} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The partner field indicates the unique ID of a data integration partner.  
The project field contains the unique ID of a data integration project for a particular partner.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the Response Timeout}  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * MULE-ZUORA-AQUA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-AQUA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-AQUA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-AQUA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-AQUA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-AQUA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get Results Files
`<mule-zuora-aqua-connector:get-v1-file-by-file-id>`
This REST API retrieves the results in the specified file format. The AQuA results files are purged after 7 days. This operation makes an HTTP GET request to the /v1/file/{file-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The Zuora ID of the file to retrieve.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the Response Timeout}  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
| Configure to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the Response Timeout}  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
### Throws
  * MULE-ZUORA-AQUA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-AQUA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-AQUA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-AQUA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-AQUA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-AQUA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-AQUA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-AQUA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Batch JobResponse Result Listener
`<mule-zuora-aqua-connector:batch-job-result-listener>`
Periodically polls for the status of the jobs retrieved from the given object store (filled from PostQuery operation) and returns the results of the jobs with the expected status. This source works ONLY with jobs sent using the PostQuery operation.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object Store Name | The name of the objectStore that holds the JobId’s from the PostQuery results.  
Entity Parameters |  Entity Parameters Group  
Expected Status |  Enumeration, one of:
  * PENDING
  * EXECUTING
  * COMPLETED
  * ABORTED
  * CANCELLED
  * SUBMITTED
  * ERROR

| The expected status of the job to be retrieved. | COMPLETED  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Primary Node Only | Whether this source should only be executed on the primary node when running in Cluster  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type  
---  
### For Configurations
## Types
### Default Header
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Default Query Param
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Proxy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Non Proxy Hosts**  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Enabled Protocols** |  A comma separated list of protocols enabled for this context.  
**Enabled Cipher Suites** |  A comma separated list of cipher suites enabled for this context.  
**Trust Store**  
**Revocation Check** | 
  * Standard Revocation Check
  * Custom Ocsp Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.  
The password used to protect the trust store.  
The type of store used.  
The algorithm used by the trust store.  
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  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.  
The type of store used.  
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.  
**Key Password** |  The password used to protect the private key.  
The password used to protect the key store.  
The algorithm used by the key store.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Only End Entities** |  Only verify the last element of the certificate chain.  
**Prefer Crls** |  Try CRL instead of OCSP first.  
**No Fallback** |  Do not use the secondary checking method (the one not selected before).  
Avoid verification failure when the revocation server can not be reached or is busy.  
### Custom Ocsp Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
**Cert Alias** |  Alias of the signing certificate for the OCSP response (must be in the trust store), if present.  
### Crl File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  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 Forever

|  The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
If false, the reconnection strategy will run in a separate, non-blocking thread  
How many reconnection attempts to make.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
If false, the reconnection strategy will run in a separate, non-blocking thread  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  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  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
|  The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
If false, the reconnection strategy will run in a separate, non-blocking thread  
How many reconnection attempts to make.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
If false, the reconnection strategy will run in a separate, non-blocking thread  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  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  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A time unit that qualifies the maxIdleTime attribute  
### Entity Parameters Group
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
An optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified).  
**Entity Name** |  An optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified).  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than fits into this buffer, then the buffer expands according to the **Buffer size increment** attribute, with an upper limit of **Max in memory size**.  
**Buffer Size Increment** |  This specifies 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, and that a `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised when the buffer gets full.  
**Max Buffer Size** |  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: |  The unit in which all these attributes are expressed  
### Repeatable File Store Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**In Memory Size** |  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 **Max in memory size** is expressed  
### Redelivery Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Redelivery Count** |  The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed-message  
**Message Digest Algorithm** |  The secure hashing algorithm to use. If not set, the default is SHA-256.  
**Message Identifier** |  Redelivery Policy Message Identifier |  Defines which strategy is used to identify the messages.  
**Object Store** |  ObjectStore |  The object store where the redelivery counter for each message is going to be stored.  
### Redelivery Policy Message Identifier
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Use Secure Hash** |  Whether to use a secure hash algorithm to identify a redelivered message.  
**Id Expression** |  Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.  
### Http Response Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Status Code**  
**Reason Phrase**