com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig Maven / Gradle / Ivy

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

package com.azure.cosmos;

import java.time.Duration;

/**
 * Represents End to end operation latency policy config
 * This enables requests to get cancelled by the client once the specified timeout is reached
 */
public final class CosmosEndToEndOperationLatencyPolicyConfig {
    private final boolean isEnabled;
    private final Duration endToEndOperationTimeout;

    private final AvailabilityStrategy availabilityStrategy;

    private final String toStringValue;

    /**
     * Constructor
     *
     * @param isEnabled                    toggle if the policy should be enabled or disabled
     * @param endToEndOperationTimeout     the timeout for request cancellation in {@link Duration}. Setting very low timeouts
     *                                     can cause the request to never succeed.
     * @param availabilityStrategy         the availability strategy to be used for the policy
     */
    CosmosEndToEndOperationLatencyPolicyConfig(
        boolean isEnabled,
        Duration endToEndOperationTimeout,
        AvailabilityStrategy availabilityStrategy) {

        this.isEnabled = isEnabled;
        this.endToEndOperationTimeout = endToEndOperationTimeout;
        this.availabilityStrategy = availabilityStrategy;
        this.toStringValue = this.createStringRepresentation();
    }

    /**
     * Returns if the policy is enabled or not
     *
     * @return if the policy is enabled or not
     */
    public boolean isEnabled() {
        return this.isEnabled;
    }

    /**
     * Gets the defined end to end operatoin timeout
     *
     * @return the end to end operation timeout
     */
    public Duration getEndToEndOperationTimeout() {
        return endToEndOperationTimeout;
    }

    /**
     * Gets the availability strategy to be used for the policy.
     *
     * @return the availability strategy to be used for the policy
     */
    public AvailabilityStrategy getAvailabilityStrategy() {
        return availabilityStrategy;
    }

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

    private String createStringRepresentation() {

        if (this.endToEndOperationTimeout == null) {
            return "";
        }

        String availabilityStrategyAsString = "";
        if (this.availabilityStrategy != null) {
            availabilityStrategyAsString = availabilityStrategy.toString();
        }

        return "{" +
            "e2eto=" + this.endToEndOperationTimeout +
            ", as=" + availabilityStrategyAsString +
            "}";
    }

}