com.azure.cosmos.models.ConflictResolutionMode Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of azure-cosmos Show documentation

This Package contains Microsoft Azure Cosmos SDK (with Reactive Extension Reactor support) for Azure Cosmos DB SQL API

There is a newer version: 4.61.1

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.cosmos.models;

import com.azure.cosmos.implementation.Conflict;
import com.azure.cosmos.implementation.StoredProcedure;

/**
 * The enum Conflict resolution mode.
 */
public enum ConflictResolutionMode {
    /**
     * Last writer wins conflict resolution mode
     *
     * Setting the ConflictResolutionMode to "LAST_WRITER_WINS" indicates that conflict resolution should be done by
     * inspecting a field in the conflicting items
     * and picking the item which has the higher value in that path. See
     * {@link ConflictResolutionPolicy#getConflictResolutionPath()} for details on how to specify the path
     *
     */
    LAST_WRITER_WINS("LastWriterWins"),

    /**
     * CUSTOM conflict resolution mode
     * 
     * Setting the ConflictResolutionMode to "CUSTOM" indicates that conflict resolution is custom handled by a user.
     * The user could elect to register a user specified {@link StoredProcedure} for handling conflicting resources.
     * Should the user not register a user specified StoredProcedure, conflicts will default to being made available
     * as {@link Conflict} resources,
     * which the user can inspect and manually resolve.
     * See {@link ConflictResolutionPolicy#getConflictResolutionProcedure()} for details on how to specify the stored
     * procedure
     * to run for conflict resolution.
     */
    CUSTOM("Custom"),

    /**
     * INVALID or unknown mode.
     */
    INVALID("Invalid");

    ConflictResolutionMode(String overWireValue) {
        this.overWireValue = overWireValue;
    }

    private final String overWireValue;

    @Override
    public String toString() {
        return this.overWireValue;
    }
}