SK-2071: Implement Deidentify File Interface and Polling for Detect Support

.github/workflows/pr.yml

@@ -19,10 +19,12 @@ jobs:
   Test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-java@v1
+      - uses: actions/checkout@v4
+      - name: Set up Java
+        uses: actions/setup-java@v3
         with:
-          java-version: "1.8"
+          java-version: "11"
+          distribution: 'temurin'
 
       - name: create-json
         id: create-json

src/main/java/com/skyflow/errors/ErrorMessage.java

@@ -129,6 +129,21 @@ public enum ErrorMessage {
     InvalidEmptyTextInDeIdentify("%s0 Validation error. The text field is required string and must not be empty string. Specify a valid text."),
     InvalidNullTextInReIdentify("%s0 Validation error. The text field is required string and must not be null. Specify a valid text."),
     InvalidEmptyTextInReIdentify("%s0 Validation error. The text field is required string and must not be empty string. Specify a valid text."),
+
+    //Detect Files
+    InvalidNullFileInDeIdentifyFile("%s0 Validation error. The file field is required and must not be null. Specify a valid file object."),
+    FileNotFoundToDeidentify("%s0 Validation error. The file to deidentify was not found at the specified path. Verify the file path and try again."),
+    FileNotReadableToDeidentify("%s0 Validation error. The file to deidentify is not readable. Check the file permissions and try again."),
+    InvalidPixelDensityToDeidentifyFile("%s0 Validation error. Should be a positive integer. Specify a valid pixel density."),
+    InvalidMaxResolution("%s0 Validation error. Should be a positive integer. Specify a valid max resolution."),
+    OutputDirectoryNotFound("%s0 Validation error. The output directory for deidentified files was not found at the specified path. Verify the output directory path and try again."),
+    InvalidPermission("%s0 Validation error. The output directory for deidentified files is not writable. Check the directory permissions and try again."),
+    InvalidWaitTime("%s0 Validation error. The wait time for deidentify file operation should be a positive integer. Specify a valid wait time."),
+    WaitTimeExceedsLimit("%s0 Validation error. The wait time for deidentify file operation exceeds the maximum limit of 64 seconds. Specify a wait time less than or equal to 60 seconds."),
+    InvalidOrEmptyRunId("%s0 Validation error. The run ID is invalid or empty. Specify a valid run ID."),
+    FailedToEncodeFile("%s0 Validation error. Failed to encode the file. Ensure the file is in a supported format and try again."),
+    PollingForResultsFailed("%s0 API error. Polling for results failed. Unable to retrieve the deidentified file"),
+    FailedtoSaveProcessedFile("%s0 Validation error. Failed to save the processed file. Ensure the output directory is valid and writable."),
     ;
     private final String message;
 

src/main/java/com/skyflow/errors/SkyflowException.java

@@ -41,18 +41,37 @@
         super(cause);
         this.httpCode = httpCode;
         setRequestId(responseHeaders);
-        setResponseBody(responseBody, responseHeaders);
+        // Determine if responseBody is a JSON string with "error" key or a plain string
+        if (isJsonWithErrorObject(responseBody)) {
+            setResponseBodyFromJson(responseBody, responseHeaders);
+        } else {
+            this.message = responseBody;
+            this.details = new JsonArray();
+        }
     }
 
-    private void setResponseBody(String responseBody, Map<String, List<String>> responseHeaders) {
+    // Helper to check if responseBody is a JSON string with "error" key
+    private boolean isJsonWithErrorObject(String responseBody) {
+        try {
+            if (responseBody == null) return false;
+            JsonObject obj = JsonParser.parseString(responseBody).getAsJsonObject();
+            return obj.has("error");
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    // Handles new error structure: {error={grpc_code=3, http_code=400, message=..., http_status=..., details=[]}}
+    private void setResponseBodyFromJson(String responseBody, Map<String, List<String>> responseHeaders) {
         try {
             if (responseBody != null) {
                 this.responseBody = JsonParser.parseString(responseBody).getAsJsonObject();
-                if (this.responseBody.get("error") != null) {
-                    setGrpcCode();
-                    setHttpStatus();
-                    setMessage();
-                    setDetails(responseHeaders);
+                if (this.responseBody.has("error")) {
+                    JsonObject errorObj = this.responseBody.getAsJsonObject("error");
+                    setGrpcCode(errorObj);
+                    setHttpStatus(errorObj);
+                    setMessage(errorObj);
+                    setDetails(errorObj, responseHeaders);
                 }
             }
         } catch (JsonSyntaxException e) {
@@ -71,21 +90,43 @@
         }
     }
 
+    // For legacy error structure
     private void setMessage() {
         JsonElement messageElement = ((JsonObject) responseBody.get("error")).get("message");
         this.message = messageElement == null ? null : messageElement.getAsString();
     }
 
+    // For new error structure
+    private void setMessage(JsonObject errorObj) {
+        JsonElement messageElement = errorObj.get("message");
+        this.message = messageElement == null ? null : messageElement.getAsString();
+    }
+
+    // For legacy error structure
     private void setGrpcCode() {
         JsonElement grpcElement = ((JsonObject) responseBody.get("error")).get("grpc_code");
         this.grpcCode = grpcElement == null ? null : grpcElement.getAsInt();
     }
 
+    // For new error structure
+    private void setGrpcCode(JsonObject errorObj) {
+        JsonElement grpcElement = errorObj.get("grpc_code");
+        this.grpcCode = grpcElement == null ? null : grpcElement.getAsInt();
+    }
+
+    // For legacy error structure
     private void setHttpStatus() {
         JsonElement statusElement = ((JsonObject) responseBody.get("error")).get("http_status");
         this.httpStatus = statusElement == null ? null : statusElement.getAsString();
     }
 
+    // For new error structure
+    private void setHttpStatus(JsonObject errorObj) {
+        JsonElement statusElement = errorObj.get("http_status");
+        this.httpStatus = statusElement == null ? null : statusElement.getAsString();
+    }
+
+    // For legacy error structure
     private void setDetails(Map<String, List<String>> responseHeaders) {
         JsonElement detailsElement = ((JsonObject) responseBody.get("error")).get("details");
         List<String> errorFromClientHeader = responseHeaders.get("error-from-client");
@@ -101,6 +142,22 @@
         }
     }
 
+    // For new error structure
+    private void setDetails(JsonObject errorObj, Map<String, List<String>> responseHeaders) {
+        JsonElement detailsElement = errorObj.get("details");
+        List<String> errorFromClientHeader = responseHeaders.get("error-from-client");
+        if (detailsElement != null && detailsElement.isJsonArray()) {
+            this.details = detailsElement.getAsJsonArray();
+        }
+        if (errorFromClientHeader != null) {
+            this.details = this.details == null ? new JsonArray() : this.details;
+            String errorFromClient = errorFromClientHeader.get(0);
+            JsonObject detailObject = new JsonObject();
+            detailObject.addProperty("errorFromClient", errorFromClient);
+            this.details.add(detailObject);
+        }
+    }
+
     public int getHttpCode() {
         return httpCode;
     }

src/main/java/com/skyflow/generated/rest/core/ClientOptions.java

@@ -34,7 +34,7 @@ private ClientOptions(
             {
                 put("X-Fern-Language", "JAVA");
                 put("X-Fern-SDK-Name", "com.skyflow.fern:api-sdk");
-                put("X-Fern-SDK-Version", "0.0.202");
+                put("X-Fern-SDK-Version", "0.0.208");
             }
         });
         this.headerSuppliers = headerSuppliers;

src/main/java/com/skyflow/generated/rest/resources/files/types/DeidentifyImageRequestMaskingMethod.java

@@ -6,7 +6,7 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 
 public enum DeidentifyImageRequestMaskingMethod {
-    BLACKOUT("blackout"),
+    BLACKBOX("blackbox"),
 
     BLUR("blur");
 

src/main/java/com/skyflow/generated/rest/types/DeidentifyStatusResponseOutputType.java

@@ -6,9 +6,11 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 
 public enum DeidentifyStatusResponseOutputType {
-    BASE_64("base64"),
+    BASE_64("BASE64"),
 
-    EFS_PATH("efs_path");
+    EFS_PATH("EFS_PATH"),
+
+    UNKNOWN("UNKNOWN");
 
     private final String value;
 

src/main/java/com/skyflow/generated/rest/types/DeidentifyStatusResponseStatus.java

@@ -6,11 +6,11 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 
 public enum DeidentifyStatusResponseStatus {
-    FAILED("failed"),
+    FAILED("FAILED"),
 
-    IN_PROGRESS("in_progress"),
+    IN_PROGRESS("IN_PROGRESS"),
 
-    SUCCESS("success");
+    SUCCESS("SUCCESS");
 
     private final String value;
 

src/main/java/com/skyflow/generated/rest/types/ReidentifyStringResponse.java

@@ -20,21 +20,21 @@
 @JsonInclude(JsonInclude.Include.NON_ABSENT)
 @JsonDeserialize(builder = ReidentifyStringResponse.Builder.class)
 public final class ReidentifyStringResponse {
-    private final Optional<String> processedText;
+    private final Optional<String> text;
 
     private final Map<String, Object> additionalProperties;
 
-    private ReidentifyStringResponse(Optional<String> processedText, Map<String, Object> additionalProperties) {
-        this.processedText = processedText;
+    private ReidentifyStringResponse(Optional<String> text, Map<String, Object> additionalProperties) {
+        this.text = text;
         this.additionalProperties = additionalProperties;
     }
 
     /**
      * @return Re-identified text.
      */
-    @JsonProperty("processed_text")
-    public Optional<String> getProcessedText() {
-        return processedText;
+    @JsonProperty("text")
+    public Optional<String> getText() {
+        return text;
     }
 
     @java.lang.Override
@@ -49,12 +49,12 @@ public Map<String, Object> getAdditionalProperties() {
     }
 
     private boolean equalTo(ReidentifyStringResponse other) {
-        return processedText.equals(other.processedText);
+        return text.equals(other.text);
     }
 
     @java.lang.Override
     public int hashCode() {
-        return Objects.hash(this.processedText);
+        return Objects.hash(this.text);
     }
 
     @java.lang.Override
@@ -68,31 +68,31 @@ public static Builder builder() {
 
     @JsonIgnoreProperties(ignoreUnknown = true)
     public static final class Builder {
-        private Optional<String> processedText = Optional.empty();
+        private Optional<String> text = Optional.empty();
 
         @JsonAnySetter
         private Map<String, Object> additionalProperties = new HashMap<>();
 
         private Builder() {}
 
         public Builder from(ReidentifyStringResponse other) {
-            processedText(other.getProcessedText());
+            text(other.getText());
             return this;
         }
 
-        @JsonSetter(value = "processed_text", nulls = Nulls.SKIP)
-        public Builder processedText(Optional<String> processedText) {
-            this.processedText = processedText;
+        @JsonSetter(value = "text", nulls = Nulls.SKIP)
+        public Builder text(Optional<String> text) {
+            this.text = text;
             return this;
         }
 
-        public Builder processedText(String processedText) {
-            this.processedText = Optional.ofNullable(processedText);
+        public Builder text(String text) {
+            this.text = Optional.ofNullable(text);
             return this;
         }
 
         public ReidentifyStringResponse build() {
-            return new ReidentifyStringResponse(processedText, additionalProperties);
+            return new ReidentifyStringResponse(text, additionalProperties);
         }
     }
 }

src/main/java/com/skyflow/logs/ErrorLogs.java

@@ -117,7 +117,16 @@ public enum ErrorLogs {
     INVALID_NULL_TEXT_IN_REIDENTIFY("Invalid %s1 request. The text field is required string and must not be null. Specify a valid text."),
     INVALID_EMPTY_TEXT_IN_REIDENTIFY("Invalid %s1 request. The text field is required string and must not be empty string. Specify a valid text."),
     REIDENTIFY_TEXT_REQUEST_REJECTED("ReIdentify text request resulted in failure."),
-
+    DEIDENTIFY_FILE_REQUEST_REJECTED("DeIdentify file request resulted in failure."),
+    GET_DETECT_RUN_REQUEST_REJECTED("Get detect run request resulted in failure."),
+    INVALID_NULL_FILE_IN_DEIDENTIFY_FILE("Invalid %s1 request. The file field is required and must not be null. Specify a valid file."),
+    FILE_NOT_FOUND_TO_DEIDENTIFY("Invalid %s1 request. The file field is required and must not be empty. Specify a valid file."),
+    FILE_NOT_READABLE_TO_DEIDENTIFY("Invalid %s1 request. The file is not readable. Please check the file permissions or path."),
+    INVALID_PIXEL_DENSITY_TO_DEIDENTIFY_FILE("Invalid %s1 request. Pixel density must be a positive integer greater than 0. Specify a valid pixel density."),
+    INVALID_MAX_RESOLUTION("Invalid %s1 request. Max resolution must be a positive integer greater than 0. Specify a valid max resolution."),
+    INVALID_BLEEP_TO_DEIDENTIFY_AUDIO("Invalid %s1 request. Specify a valid bleep as AudioBleep"),
+    OUTPUT_DIRECTORY_NOT_FOUND("Invalid %s1 request. The output directory does not exist. Please specify a valid output directory."),
+    INVALID_PERMISSIONS_FOR_OUTPUT_DIRECTORY("Invalid %s1 request. The output directory is not writable. Please check the permissions or specify a valid output directory."),
     ;
 
     private final String log;

src/main/java/com/skyflow/logs/InfoLogs.java

@@ -83,6 +83,12 @@ public enum InfoLogs {
     VALIDATE_REIDENTIFY_TEXT_REQUEST("Validating reidentify text request."),
     REIDENTIFY_TEXT_TRIGGERED("ReIdentify text method triggered."),
     REIDENTIFY_TEXT_REQUEST_RESOLVED("ReIdentify text request resolved."),
+    DEIDENTIFY_FILE_TRIGGERED("DeIdentify file method triggered."),
+    VALIDATE_DEIDENTIFY_FILE_REQUEST("Validating deidentify file request."),
+    DEIDENTIFY_FILE_REQUEST_RESOLVED("DeIdentify file request resolved."),
+    DEIDENTIFY_FILE_SUCCESS("File deidentified successfully."),
+    GET_DETECT_RUN_TRIGGERED("Get detect run method triggered."),
+    VALIDATE_GET_DETECT_RUN_REQUEST("Validating get detect run request."),
     REIDENTIFY_TEXT_SUCCESS("Text data re-identified."),
     ;