SoftDeleteColumnDeletionDetectionPolicy Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.8.1

public final class SoftDeleteColumnDeletionDetectionPolicy
extends DataDeletionDetectionPolicy

Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.

Constructor Summary

Constructor Description
SoftDeleteColumnDeletionDetectionPolicy()

Creates an instance of SoftDeleteColumnDeletionDetectionPolicy class.

Method Summary

Modifier and Type Method and Description
static SoftDeleteColumnDeletionDetectionPolicy fromJson(JsonReader jsonReader)

Reads an instance of SoftDeleteColumnDeletionDetectionPolicy from the JsonReader.
String getOdataType()

Get the odataType property: A URI fragment specifying the type of data deletion detection policy.
String getSoftDeleteColumnName()

Get the softDeleteColumnName property: The name of the column to use for soft-deletion detection.
String getSoftDeleteMarkerValue()

Get the softDeleteMarkerValue property: The marker value that identifies an item as deleted.
SoftDeleteColumnDeletionDetectionPolicy setSoftDeleteColumnName(String softDeleteColumnName)

Set the softDeleteColumnName property: The name of the column to use for soft-deletion detection.
SoftDeleteColumnDeletionDetectionPolicy setSoftDeleteMarkerValue(String softDeleteMarkerValue)

Set the softDeleteMarkerValue property: The marker value that identifies an item as deleted.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from DataDeletionDetectionPolicy

fromJson getOdataType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SoftDeleteColumnDeletionDetectionPolicy

public SoftDeleteColumnDeletionDetectionPolicy()

Creates an instance of SoftDeleteColumnDeletionDetectionPolicy class.

Method Details

fromJson

public static SoftDeleteColumnDeletionDetectionPolicy fromJson(JsonReader jsonReader)

Reads an instance of SoftDeleteColumnDeletionDetectionPolicy from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SoftDeleteColumnDeletionDetectionPolicy if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the SoftDeleteColumnDeletionDetectionPolicy.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of data deletion detection policy.

Overrides:

SoftDeleteColumnDeletionDetectionPolicy.getOdataType()

Returns:

the odataType value.

getSoftDeleteColumnName

public String getSoftDeleteColumnName()

Get the softDeleteColumnName property: The name of the column to use for soft-deletion detection.

Returns:

the softDeleteColumnName value.

getSoftDeleteMarkerValue

public String getSoftDeleteMarkerValue()

Get the softDeleteMarkerValue property: The marker value that identifies an item as deleted.

Returns:

the softDeleteMarkerValue value.

setSoftDeleteColumnName

public SoftDeleteColumnDeletionDetectionPolicy setSoftDeleteColumnName(String softDeleteColumnName)

Set the softDeleteColumnName property: The name of the column to use for soft-deletion detection.

Parameters:

softDeleteColumnName - the softDeleteColumnName value to set.

Returns:

the SoftDeleteColumnDeletionDetectionPolicy object itself.

setSoftDeleteMarkerValue

public SoftDeleteColumnDeletionDetectionPolicy setSoftDeleteMarkerValue(String softDeleteMarkerValue)

Set the softDeleteMarkerValue property: The marker value that identifies an item as deleted.

Parameters:

softDeleteMarkerValue - the softDeleteMarkerValue value to set.

Returns:

the SoftDeleteColumnDeletionDetectionPolicy object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SoftDeleteColumnDeletionDetectionPolicy.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to