RedactionResult Leave feedback
On this page
Inheritance: java.lang.Object
public class RedactionResult
Represents a result of the redaction operation.
Learn more
- More details about redaction results: Redaction basics
| Method | Description |
|---|---|
| getStatus() | Gets the execution status. |
| getErrorMessage() | Gets the error message for diagnostics. |
| skipped(String description) | Initializes a new instance of RedactionResult class with Skipped status. |
| partial(String description) | Initializes a new instance of RedactionResult class with PartiallyApplied status. |
| failed(String description) | Initializes a new instance of RedactionResult class with Failed status. |
| successful() | Initializes a new instance of RedactionResult class with Applied (successful) status. |
public final RedactionStatus getStatus()
Gets the execution status.
Returns: RedactionStatus - The execution status.
public final String getErrorMessage()
Gets the error message for diagnostics.
Returns: java.lang.String - The error message for diagnostics.
public static RedactionResult skipped(String description)
Initializes a new instance of RedactionResult class with Skipped status.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| description | java.lang.String | Reason why the operation was skipped |
Returns: RedactionResult - Sskipped redaction result
public static RedactionResult partial(String description)
Initializes a new instance of RedactionResult class with PartiallyApplied status.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| description | java.lang.String | Reason why the operation was not fully applied |
Returns: RedactionResult - Partially applied redaction result
public static RedactionResult failed(String description)
Initializes a new instance of RedactionResult class with Failed status.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| description | java.lang.String | Failure or exception details |
Returns: RedactionResult - Failed redaction result
public static RedactionResult successful()
Initializes a new instance of RedactionResult class with Applied (successful) status.
Returns: RedactionResult - Successful redaction result
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
