Package com.gradle.maven.extension.api.cache

Interface CleanupPolicy

  • public interface CleanupPolicy
    Configures the cleanup policy of the local build cache.

    The specified values will take precedence over the values defined in the gradle-enterprise.xml.

    Since:
    1.6.5

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.time.Duration getCleanupInterval()
      Gets the local build cache cleanup interval.
      java.time.Duration getRetentionPeriod()
      Gets the local build cache retention period.
      boolean isEnabled()
      Gets whether the local build cache cleanup is enabled.
      void setCleanupInterval​(java.time.Duration cleanupInterval)
      Sets the local build cache cleanup interval.
      void setEnabled​(boolean enabled)
      Sets whether to enable the local build cache cleanup.
      void setRetentionPeriod​(java.time.Duration retentionPeriod)
      Sets the local build cache cleanup retention period.

    • Method Detail

      • isEnabled

        boolean isEnabled()
        Gets whether the local build cache cleanup is enabled.
        Returns:
        true if the local build cache cleanup is enabled, false otherwise
        Since:
        1.6.5

      • setEnabled

        void setEnabled​(boolean enabled)
        Sets whether to enable the local build cache cleanup.

        Configuration via the gradle.cache.local.cleanup.enabled system property will always take precedence.

        Parameters:
        enabled - whether to enable the local build cache cleanup
        Since:
        1.6.5

      • getRetentionPeriod

        java.time.Duration getRetentionPeriod()
        Gets the local build cache retention period.
        Returns:
        the local build cache cleanup retention period
        Since:
        1.6.5

      • setRetentionPeriod

        void setRetentionPeriod​(java.time.Duration retentionPeriod)
        Sets the local build cache cleanup retention period.

        Configuration via the gradle.cache.local.cleanup.retention system property will always take precedence.

        Parameters:
        retentionPeriod - the local build cache cleanup retention period
        Since:
        1.6.5

      • getCleanupInterval

        java.time.Duration getCleanupInterval()
        Gets the local build cache cleanup interval.
        Returns:
        the local build cache cleanup interval
        Since:
        1.6.5

      • setCleanupInterval

        void setCleanupInterval​(java.time.Duration cleanupInterval)
        Sets the local build cache cleanup interval.

        Configuration via the gradle.cache.local.cleanup.interval system property will always take precedence.

        Parameters:
        cleanupInterval - the local build cache cleanup interval
        Since:
        1.6.5