Package com.azure.health.deidentification.models

Class DeidentificationJob

java.lang.Object
com.azure.health.deidentification.models.DeidentificationJob
All Implemented Interfaces:
com.azure.json.JsonSerializable<DeidentificationJob>
public final class DeidentificationJob extends Object implements com.azure.json.JsonSerializable<DeidentificationJob>
A job containing a batch of documents to de-identify.

  • Constructor Details

    • DeidentificationJob

      public DeidentificationJob(SourceStorageLocation sourceLocation, TargetStorageLocation targetLocation)
      Creates an instance of DeidentificationJob class.
      Parameters:
      sourceLocation - the sourceLocation value to set.
      targetLocation - the targetLocation value to set.

  • Method Details

    • getSourceLocation

      public SourceStorageLocation getSourceLocation()
      Get the sourceLocation property: Storage location to perform the operation on.
      Returns:
      the sourceLocation value.

    • getTargetLocation

      public TargetStorageLocation getTargetLocation()
      Get the targetLocation property: Target location to store output of operation.
      Returns:
      the targetLocation value.

    • getCustomizations

      public DeidentificationJobCustomizationOptions getCustomizations()
      Get the customizations property: Customization parameters to override default service behaviors.
      Returns:
      the customizations value.

    • setCustomizations

      public DeidentificationJob setCustomizations(DeidentificationJobCustomizationOptions customizations)
      Set the customizations property: Customization parameters to override default service behaviors.
      Parameters:
      customizations - the customizations value to set.
      Returns:
      the DeidentificationJob object itself.

    • getStatus

      public OperationStatus getStatus()
      Get the status property: Current status of a job.
      Returns:
      the status value.

    • getError

      public com.azure.core.models.ResponseError getError()
      Get the error property: Error when job fails in it's entirety.
      Returns:
      the error value.

    • getLastUpdatedAt

      public OffsetDateTime getLastUpdatedAt()
      Get the lastUpdatedAt property: Date and time when the job was completed. If the job is canceled, this is the time when the job was canceled. If the job failed, this is the time when the job failed.
      Returns:
      the lastUpdatedAt value.

    • getCreatedAt

      public OffsetDateTime getCreatedAt()
      Get the createdAt property: Date and time when the job was created.
      Returns:
      the createdAt value.

    • getStartedAt

      public OffsetDateTime getStartedAt()
      Get the startedAt property: Date and time when the job was started.
      Returns:
      the startedAt value.

    • getSummary

      public DeidentificationJobSummary getSummary()
      Get the summary property: Summary of a job. Exists only when the job is completed.
      Returns:
      the summary value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DeidentificationJob>
      Throws:
      IOException

    • fromJson

      public static DeidentificationJob fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DeidentificationJob from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DeidentificationJob if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DeidentificationJob.

    • getOperationType

      public DeidentificationOperationType getOperationType()
      Get the operationType property: Operation to perform on the input documents.
      Returns:
      the operationType value.

    • setOperationType

      public DeidentificationJob setOperationType(DeidentificationOperationType operationType)
      Set the operationType property: Operation to perform on the input documents.
      Parameters:
      operationType - the operationType value to set.
      Returns:
      the DeidentificationJob object itself.

    • getJobName

      public String getJobName()
      Get the jobName property: The name of a job.
      Returns:
      the jobName value.