Package com.azure.health.deidentification.models

Class TargetStorageLocation

java.lang.Object
com.azure.health.deidentification.models.TargetStorageLocation
All Implemented Interfaces:
com.azure.json.JsonSerializable<TargetStorageLocation>
public final class TargetStorageLocation extends Object implements com.azure.json.JsonSerializable<TargetStorageLocation>
Storage location.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TargetStorageLocation(String location, String prefix)
    Creates an instance of TargetStorageLocation class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TargetStorageLocation
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of TargetStorageLocation from the JsonReader.
    String
    getLocation()
    Get the location property: URL to storage location.
    String
    getPrefix()
    Get the prefix property: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure.
    Boolean
    isOverwrite()
    Get the overwrite property: When set to true during a job, the service will overwrite the output location if it already exists.
    TargetStorageLocation
    setOverwrite(Boolean overwrite)
    Set the overwrite property: When set to true during a job, the service will overwrite the output location if it already exists.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • TargetStorageLocation

      public TargetStorageLocation(String location, String prefix)
      Creates an instance of TargetStorageLocation class.
      Parameters:
      location - the location value to set.
      prefix - the prefix value to set.

  • Method Details

    • getLocation

      public String getLocation()
      Get the location property: URL to storage location.
      Returns:
      the location value.

    • getPrefix

      public String getPrefix()
      Get the prefix property: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure. Example: File full path: documents/user/note.txt Input Prefix: "documents/user/" Output Prefix: "output_docs/" Output file: "output_docs/note.txt".
      Returns:
      the prefix value.

    • isOverwrite

      public Boolean isOverwrite()
      Get the overwrite property: When set to true during a job, the service will overwrite the output location if it already exists.
      Returns:
      the overwrite value.

    • setOverwrite

      public TargetStorageLocation setOverwrite(Boolean overwrite)
      Set the overwrite property: When set to true during a job, the service will overwrite the output location if it already exists.
      Parameters:
      overwrite - the overwrite value to set.
      Returns:
      the TargetStorageLocation object itself.

    • toJson

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

    • fromJson

      public static TargetStorageLocation fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of TargetStorageLocation from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of TargetStorageLocation 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 TargetStorageLocation.