get_change_data_retention_barrier
Returns the date of the earliest partition retention barrier when multiple partition retention barriers have been set.
When different retention barriers have been set by multiple consuming applications, Replicate will delete old Change Data partitions up to the earliest partition retention barrier.
For information on setting a partition retention barrier, see set_change_data_retention_barrier.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public AemGetChangeDataRetentionBarrierResp GetChangeDataRetentionBarrier(
string server,
string task
);
Parameters
| Parameter | Type | Description |
|---|---|---|
|
server |
string |
The name of the server on which the task is running. |
| task | string | The name of the task. |
Response
| Name | Type | Description |
|---|---|---|
|
application |
string |
The name of the consuming application that set the earliest partition retention barrier. |
|
retention_point |
datetime Format: yyyy'-'MM'-'dd'T'HH':'mm':'ss'Z' |
The date of the earliest partition retention barrier. |
Error response
| Error | Message | Description |
|---|---|---|
|
AEM_TASK_NOT_FOUND |
Replication task {task] on server {server} could not be found. |
Returned when an unknown task name is encountered. |
| AEM_GET_CHANGE_DATA_RETENTION_BARRIER_INNER_ERR |
Failed to get change data retention barrier for task {task} on server {server}. Message: {error_message} |
Returned when an error is encountered while attempting to get the earliest partition retention barrier. |