com.gradle.develocity.agent.maven.api.cache.CleanupPolicy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of develocity-maven-extension Show documentation

Maven extension for Develocity installations that provides Build Insights, Build Caching, Predictive Test Selection, and Test Distribution for Maven builds. Alternatively, Build Insights can be captured and viewed for free at scans.gradle.com and Build Caching can be used for free locally. See https://gradle.com for more information on Develocity.

There is a newer version: 1.23

Show newest version

package com.gradle.develocity.agent.maven.api.cache;

import java.time.Duration;

/**
 * Configures the cleanup policy of the local build cache.
 * 
 * The specified values will take precedence over the values defined in the {@code develocity.xml}.
 *
 * @since 1.21
 */
public interface CleanupPolicy {

    /**
     * Gets whether the local build cache cleanup is enabled.
     *
     * @return {@code true} if the local build cache cleanup is enabled, {@code false} otherwise
     */
    boolean isEnabled();

    /**
     * Sets whether to enable the local build cache cleanup.
     * 

     * Configuration via the {@code develocity.cache.local.cleanup.enabled} system property will always take precedence.
     *
     * @param enabled whether to enable the local build cache cleanup
     */
    void setEnabled(boolean enabled);

    /**
     * Gets the local build cache retention period.
     *
     * @return the local build cache cleanup retention period
     */
    Duration getRetentionPeriod();

    /**
     * Sets the local build cache cleanup retention period.
     * 

     * Configuration via the {@code develocity.cache.local.cleanup.retention} system property will always take precedence.
     *
     * @param retentionPeriod the local build cache cleanup retention period
     */
    void setRetentionPeriod(Duration retentionPeriod);

    /**
     * Gets the local build cache cleanup interval.
     *
     * @return the local build cache cleanup interval
     */
    Duration getCleanupInterval();

    /**
     * Sets the local build cache cleanup interval.
     * 
     * Configuration via the {@code develocity.cache.local.cleanup.interval} system property will always take precedence.
     *
     * @param cleanupInterval the local build cache cleanup interval
     */
    void setCleanupInterval(Duration cleanupInterval);

}