com.azure.cosmos.implementation.throughputControl.controller.request.IThroughputRequestController 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.implementation.throughputControl.controller.request;

import com.azure.cosmos.implementation.throughputControl.controller.IThroughputController;

/**
 * Represents a throughput request controller.
 */
public interface IThroughputRequestController extends IThroughputController {
    /**
     * Renew throughput usage cycle.
     *
     * Each request controller will maintain one to many request throttlers.
     * By calling this method, it will also renew the throughput usage cycles for the request throttlers.
     * And it will return the throughput usage for the current cycle.
     *
     * @param throughput The scheduled throughput for the new cycle.
     * @return The throughput usage for previous cycle.
     */
    double renewThroughputUsageCycle(double throughput);
}