Pre-GA release followup for Deid (Azure#44893)

* Add custom request matcher to ignore Intellij headers

* Customizations

* Use TypeSpec fixes

* JobName fix - enable samples README

* Restore generation

* update sample links

* links

* update OperationState client name

* update TypeSpec commit

* update changelog

* update release date

---------

Co-authored-by: Josiah Vinson <[email protected]>

Author: jovinson-ms

sdk/healthdataaiservices/azure-health-deidentification/CHANGELOG.md

@@ -1,23 +1,26 @@
 # Release History
 
-## 1.0.0 (2025-02-17)
+## 1.0.0 (2025-04-10)
 
 ### Features Added
 
-- Introduced `DeidentificationCustomizationOptions` and `DeidentificationJobCustomizationOptions` models
-    - Added `SurrogateLocale` field in these models
-    - Moved `RedactionFormat` field into these models
-- Introduced `Overwrite` flag in `TargetStorageLocation` model
+- Introduced `DeidentificationCustomizationOptions` and `DeidentificationJobCustomizationOptions` models.
+    - Added `SurrogateLocale` field in these models.
+    - Moved `RedactionFormat` field into these models.
+- Introduced `Overwrite` flag in `TargetStorageLocation` model.
 
 ### Breaking Changes
 
+- Changed the name of model `OperationState` to `OperationStatus`.
+- Changed the property `DeidentificationJob.name` to `DeidentificationJob.jobName`, and corresponding parameters in client methods. 
+- Changed the property `DeidentificationJob.type` to `DeidentificationJob.operationType`.
 - Changed method names in `DeidentificationClient` to match functionality:
-  - Changed the `deidentify` method name to `deidentifyText`
-  - Changed the `beginCreateJob` method name to `beginDeidentifyDocuments`
-- Changed `outputPrefix` behavior to no longer include `jobName` by default
-- Changed `Path` field to `Location` in `SourceStorageLocation` and `TargetStorageLocation`
-- Deprecated `DocumentDataType`
-- Deprecated `Path` and `Location` from `TaggerResult` model
+  - Changed the `deidentify` method name to `deidentifyText`.
+  - Changed the `beginCreateJob` method name to `beginDeidentifyDocuments`.
+- Changed `outputPrefix` behavior to no longer include `jobName` by default.
+- Changed `Path` field to `Location` in `SourceStorageLocation` and `TargetStorageLocation`.
+- Deprecated `DocumentDataType`.
+- Deprecated `Path` and `Location` from `TaggerResult` model.
 
 ## 1.0.0-beta.1 (2024-08-15)
 

sdk/healthdataaiservices/azure-health-deidentification/README.md

@@ -87,7 +87,7 @@ DeidentificationJob job = new DeidentificationJob(
         .setOverwrite(true)
 );
 
-job.setOperation(DeidentificationOperationType.REDACT);
+job.setOperationType(DeidentificationOperationType.REDACT);
 
 String jobName = Configuration.getGlobalConfiguration().get("DEID_JOB_NAME", "MyJob-" + Instant.now().toEpochMilli());
 DeidentificationJob result = deidentificationClient.beginDeidentifyDocuments(jobName, job)
@@ -139,7 +139,7 @@ DeidentificationJob job = new DeidentificationJob(
         .setOverwrite(true)
 );
 
-job.setOperation(DeidentificationOperationType.REDACT);
+job.setOperationType(DeidentificationOperationType.REDACT);
 
 String jobName = Configuration.getGlobalConfiguration().get("DEID_JOB_NAME", "MyJob-" + Instant.now().toEpochMilli());
 DeidentificationJob result = deidentificationClient.beginDeidentifyDocuments(jobName, job)
@@ -161,7 +161,7 @@ System.out.println(jobName + " - " + result.getStatus());
 ```java com.azure.health.deidentification.samples.list_deidentification_jobs
 PagedIterable<DeidentificationJob> result = deidentificationClient.listJobs();
 for (DeidentificationJob job : result) {
-    System.out.println(job.getName() + " - " + job.getStatus());
+    System.out.println(job.getJobName() + " - " + job.getStatus());
 }
 ```
 

sdk/healthdataaiservices/azure-health-deidentification/customization/src/main/java/ListJobsCustomization.java

@@ -2,88 +2,12 @@
 // Licensed under the MIT License.
 
 import com.azure.autorest.customization.*;
-import com.github.javaparser.StaticJavaParser;
-import com.github.javaparser.ast.Modifier;
-import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
-import com.github.javaparser.ast.body.MethodDeclaration;
-import com.github.javaparser.javadoc.JavadocBlockTag;
 import org.slf4j.Logger;
 
-/**
- * This customizes the generated Azure Deidentification client. The following changes are made by this customization:
- * <li>Mark the listJobs() overload with continuationToken parameter in DeidentificationClient as private.</li>
- * <li>Mark the listJobs() overload with continuationToken parameter in DeidentificationAsyncClient as privater.</li>
- * <li>Mark the listJobDocuments() overload with continuationToken parameter in DeidentificationClient as private.</li>
- * <li>Mark the listJobDocuments() overload with continuationToken parameter in DeidentificationAsyncClient as private.</li>
- * <li>Rename the 'name' parameter in listJobDocuments() to 'jobName'.</li>
- * <li>Rename the 'name' parameter in the JavaDoc for listJobDocuments() to 'jobName'.</li>
- */
 public class ListJobsCustomization extends Customization {
 
     @Override
     public void customize(LibraryCustomization libraryCustomization, Logger logger) {
-        PackageCustomization models = libraryCustomization.getPackage("com.azure.health.deidentification");
-
-        ClassCustomization deidentificationClientClass = models.getClass("DeidentificationClient");
-        customizeClassByMarkingContinuationTokenOverloadsPrivate(deidentificationClientClass);
-        customizeClassByRenamingJobNameParameter(deidentificationClientClass);
-        customizeJavadocByRenamingJobNameParameter(deidentificationClientClass);
-
-        ClassCustomization deidentificationAsyncClientClass = models.getClass("DeidentificationAsyncClient");
-        customizeClassByMarkingContinuationTokenOverloadsPrivate(deidentificationAsyncClientClass);
-        customizeClassByRenamingJobNameParameter(deidentificationAsyncClientClass);
-        customizeJavadocByRenamingJobNameParameter(deidentificationAsyncClientClass);
-    }
-
-    private static void customizeClassByMarkingContinuationTokenOverloadsPrivate(ClassCustomization classCustomization) {
-        classCustomization.customizeAst(ast -> {
-            ClassOrInterfaceDeclaration clazz = ast.getClassByName(classCustomization.getClassName()).get();
-
-            clazz.getMethodsBySignature("listJobs", "String").get(0).setModifiers(Modifier.Keyword.PRIVATE);
-            clazz.getMethodsBySignature("listJobDocuments", "String", "String").get(0).setModifiers(Modifier.Keyword.PRIVATE);
-        });
     }
 
-    private static void customizeClassByRenamingJobNameParameter(ClassCustomization classCustomization) {
-        classCustomization.customizeAst(ast -> {
-            ClassOrInterfaceDeclaration clazz = ast.getClassByName(classCustomization.getClassName()).get();
-
-            clazz.getMethodsByName("listJobDocuments").forEach(method -> {
-                method.getParameterByName("name").ifPresent(parameter -> parameter.setName("jobName"));
-                method.getBody().ifPresent(body -> {
-                    String updatedBodySyncOnly = body.asBlockStmt().toString().replace("listJobDocuments(name, requestOptions)", "listJobDocuments(jobName, requestOptions)");
-                    String updatedBody = updatedBodySyncOnly.replace("listJobDocumentsAsync(name, requestOptions)", "listJobDocumentsAsync(jobName, requestOptions)");
-                    method.setBody(StaticJavaParser.parseBlock(updatedBody));
-                });
-            });
-        });
-    }
-
-    private static void customizeJavadocByRenamingJobNameParameter(ClassCustomization classCustomization) {
-        classCustomization.customizeAst(ast -> {
-            ClassOrInterfaceDeclaration clazz = ast.getClassByName(classCustomization.getClassName()).get();
-
-            MethodDeclaration listJobDocsString = clazz.getMethodsBySignature("listJobDocuments", "String").get(0);
-            listJobDocsString.getJavadoc().ifPresent(javadoc ->
-            {
-                // Remove name parameter
-                javadoc.getBlockTags().removeIf(javadocBlockTag -> javadocBlockTag.toString().contains("The name of a job."));
-                // Add jobName parameter at beginning
-                JavadocBlockTag jobNameParam = new JavadocBlockTag("param", "jobName The name of a job.");
-                javadoc.getBlockTags().add(0, jobNameParam);
-                listJobDocsString.setJavadocComment(javadoc);
-            });
-
-            MethodDeclaration listJobDocsStringRequestOptions = clazz.getMethodsBySignature("listJobDocuments", "String", "RequestOptions").get(0);
-            listJobDocsStringRequestOptions.getJavadoc().ifPresent(javadoc ->
-            {
-                // Remove name parameter
-                javadoc.getBlockTags().removeIf(javadocBlockTag -> javadocBlockTag.toString().contains("The name of a job."));
-                // Add jobName parameter at beginning
-                JavadocBlockTag jobNameParam = new JavadocBlockTag("param", "jobName The name of a job.");
-                javadoc.getBlockTags().add(0, jobNameParam);
-                listJobDocsStringRequestOptions.setJavadocComment(javadoc);
-            });
-        });
-    }
 }

sdk/healthdataaiservices/azure-health-deidentification/src/main/java/com/azure/health/deidentification/DeidentificationAsyncClient.java

@@ -101,7 +101,7 @@ public final class DeidentificationAsyncClient {
      * }
      * </pre>
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
      * @throws HttpResponseException thrown if the request is rejected by server.
      * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -113,8 +113,8 @@ public final class DeidentificationAsyncClient {
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Response<BinaryData>> getJobWithResponse(String name, RequestOptions requestOptions) {
-        return this.serviceClient.getJobWithResponseAsync(name, requestOptions);
+    public Mono<Response<BinaryData>> getJobWithResponse(String jobName, RequestOptions requestOptions) {
+        return this.serviceClient.getJobWithResponseAsync(jobName, requestOptions);
     }
 
     /**
@@ -221,7 +221,7 @@ public Mono<Response<BinaryData>> getJobWithResponse(String name, RequestOptions
      * }
      * </pre>
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @param resource The resource instance.
      * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
      * @throws HttpResponseException thrown if the request is rejected by server.
@@ -232,9 +232,9 @@ public Mono<Response<BinaryData>> getJobWithResponse(String name, RequestOptions
      */
     @Generated
     @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
-    public PollerFlux<BinaryData, BinaryData> beginDeidentifyDocuments(String name, BinaryData resource,
+    public PollerFlux<BinaryData, BinaryData> beginDeidentifyDocuments(String jobName, BinaryData resource,
         RequestOptions requestOptions) {
-        return this.serviceClient.beginDeidentifyDocumentsAsync(name, resource, requestOptions);
+        return this.serviceClient.beginDeidentifyDocumentsAsync(jobName, resource, requestOptions);
     }
 
     /**
@@ -425,7 +425,7 @@ public PagedFlux<BinaryData> listJobDocuments(String jobName, RequestOptions req
      * }
      * </pre>
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
      * @throws HttpResponseException thrown if the request is rejected by server.
      * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -436,16 +436,16 @@ public PagedFlux<BinaryData> listJobDocuments(String jobName, RequestOptions req
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Response<BinaryData>> cancelJobWithResponse(String name, RequestOptions requestOptions) {
-        return this.serviceClient.cancelJobWithResponseAsync(name, requestOptions);
+    public Mono<Response<BinaryData>> cancelJobWithResponse(String jobName, RequestOptions requestOptions) {
+        return this.serviceClient.cancelJobWithResponseAsync(jobName, requestOptions);
     }
 
     /**
      * Delete a de-identification job.
      *
      * Removes the record of the job from the service. Does not delete any documents.
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
      * @throws HttpResponseException thrown if the request is rejected by server.
      * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -455,8 +455,8 @@ public Mono<Response<BinaryData>> cancelJobWithResponse(String name, RequestOpti
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Response<Void>> deleteJobWithResponse(String name, RequestOptions requestOptions) {
-        return this.serviceClient.deleteJobWithResponseAsync(name, requestOptions);
+    public Mono<Response<Void>> deleteJobWithResponse(String jobName, RequestOptions requestOptions) {
+        return this.serviceClient.deleteJobWithResponseAsync(jobName, requestOptions);
     }
 
     /**
@@ -523,7 +523,7 @@ public Mono<Response<BinaryData>> deidentifyTextWithResponse(BinaryData body, Re
      *
      * Resource read operation template.
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @throws IllegalArgumentException thrown if parameters fail the validation.
      * @throws HttpResponseException thrown if the request is rejected by server.
      * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -536,10 +536,10 @@ public Mono<Response<BinaryData>> deidentifyTextWithResponse(BinaryData body, Re
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<DeidentificationJob> getJob(String name) {
+    public Mono<DeidentificationJob> getJob(String jobName) {
         // Generated convenience method for getJobWithResponse
         RequestOptions requestOptions = new RequestOptions();
-        return getJobWithResponse(name, requestOptions).flatMap(FluxUtil::toMono)
+        return getJobWithResponse(jobName, requestOptions).flatMap(FluxUtil::toMono)
             .map(protocolMethodData -> protocolMethodData.toObject(DeidentificationJob.class));
     }
 
@@ -548,7 +548,7 @@ public Mono<DeidentificationJob> getJob(String name) {
      *
      * Long-running resource create or replace operation template.
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @param resource The resource instance.
      * @throws IllegalArgumentException thrown if parameters fail the validation.
      * @throws HttpResponseException thrown if the request is rejected by server.
@@ -560,11 +560,11 @@ public Mono<DeidentificationJob> getJob(String name) {
      */
     @Generated
     @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
-    public PollerFlux<DeidentificationJob, DeidentificationJob> beginDeidentifyDocuments(String name,
+    public PollerFlux<DeidentificationJob, DeidentificationJob> beginDeidentifyDocuments(String jobName,
         DeidentificationJob resource) {
         // Generated convenience method for beginDeidentifyDocumentsWithModel
         RequestOptions requestOptions = new RequestOptions();
-        return serviceClient.beginDeidentifyDocumentsWithModelAsync(name, BinaryData.fromObject(resource),
+        return serviceClient.beginDeidentifyDocumentsWithModelAsync(jobName, BinaryData.fromObject(resource),
             requestOptions);
     }
 
@@ -582,7 +582,6 @@ public PollerFlux<DeidentificationJob, DeidentificationJob> beginDeidentifyDocum
      * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return paged collection of DeidentificationJob items as paginated response with {@link PagedFlux}.
      */
-    @Generated
     @ServiceMethod(returns = ReturnType.COLLECTION)
     private PagedFlux<DeidentificationJob> listJobs(String continuationToken) {
         // Generated convenience method for listJobs
@@ -644,7 +643,7 @@ public PagedFlux<DeidentificationJob> listJobs() {
      *
      * Resource list operation template.
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @param continuationToken Token to continue a previous query.
      * @throws IllegalArgumentException thrown if parameters fail the validation.
      * @throws HttpResponseException thrown if the request is rejected by server.
@@ -654,7 +653,6 @@ public PagedFlux<DeidentificationJob> listJobs() {
      * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return paged collection of DeidentificationDocumentDetails items as paginated response with {@link PagedFlux}.
      */
-    @Generated
     @ServiceMethod(returns = ReturnType.COLLECTION)
     private PagedFlux<DeidentificationDocumentDetails> listJobDocuments(String jobName, String continuationToken) {
         // Generated convenience method for listJobDocuments
@@ -721,7 +719,7 @@ public PagedFlux<DeidentificationDocumentDetails> listJobDocuments(String jobNam
      *
      * If the job is already complete, this will have no effect.
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @throws IllegalArgumentException thrown if parameters fail the validation.
      * @throws HttpResponseException thrown if the request is rejected by server.
      * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -732,10 +730,10 @@ public PagedFlux<DeidentificationDocumentDetails> listJobDocuments(String jobNam
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<DeidentificationJob> cancelJob(String name) {
+    public Mono<DeidentificationJob> cancelJob(String jobName) {
         // Generated convenience method for cancelJobWithResponse
         RequestOptions requestOptions = new RequestOptions();
-        return cancelJobWithResponse(name, requestOptions).flatMap(FluxUtil::toMono)
+        return cancelJobWithResponse(jobName, requestOptions).flatMap(FluxUtil::toMono)
             .map(protocolMethodData -> protocolMethodData.toObject(DeidentificationJob.class));
     }
 
@@ -744,7 +742,7 @@ public Mono<DeidentificationJob> cancelJob(String name) {
      *
      * Removes the record of the job from the service. Does not delete any documents.
      *
-     * @param name The name of a job.
+     * @param jobName The name of a job.
      * @throws IllegalArgumentException thrown if parameters fail the validation.
      * @throws HttpResponseException thrown if the request is rejected by server.
      * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -755,10 +753,10 @@ public Mono<DeidentificationJob> cancelJob(String name) {
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Void> deleteJob(String name) {
+    public Mono<Void> deleteJob(String jobName) {
         // Generated convenience method for deleteJobWithResponse
         RequestOptions requestOptions = new RequestOptions();
-        return deleteJobWithResponse(name, requestOptions).flatMap(FluxUtil::toMono);
+        return deleteJobWithResponse(jobName, requestOptions).flatMap(FluxUtil::toMono);
     }
 
     /**