Package com.atlassian.bamboo.resultsummary

Interface ExpiryCriteria

All Known Implementing Classes:
MutableExpiryCriteria
public interface ExpiryCriteria
A criteria class to be used for selecting result summaries for build expiry.

  • Method Details

    • getPlanKey

      @NotNull @NotNull PlanKey getPlanKey()
      A plan key by which the result summaries should be filtered.

    • getResultsSummaryClass

      @NotNull @NotNull Class<? extends ResultsSummary> getResultsSummaryClass()
      The actual class of returned result summaries (eg. ChainResultsSummary or BuildResultsSummary).

    • isRequireArtifactLinks

      boolean isRequireArtifactLinks()
      A filter for result summaries that requires them to have a directly or indirectly linked artifact (eg. an artifact link exists for a job result of a chain result).

      Note that this search criterion and getMaxIgnoredLogSize() criterion are a disjunction (either of the conditions must be met).

    • getMaxIgnoredLogSize

      @Nullable @Nullable Long getMaxIgnoredLogSize()
      A threshold for result summaries ImmutableResultsSummary.getLogSize() - the log size must be either unknown or greater than the given value.

      Note that this search criterion and isRequireArtifactLinks() criterion are a disjunction (either of the conditions must be met).

      Returns:
      the log size threshold (inclusive) or null, if the criterion is not set

    • getMaxBuildNumber

      @Nullable @Nullable Integer getMaxBuildNumber()
      A criterion for result summaries that will cause to fetch only results with smaller than or equal build number.
      Returns:
      the maximum result build number or null, if the criterion is not set

    • getMaxBuildCompletedDate

      @Nullable @Nullable Date getMaxBuildCompletedDate()
      A criterion for result summaries completion date - will cause to fetch only results completed before the date.
      Returns:
      the date or null, if the criterion is not set

    • getLabelsToExclude

      @NotNull @NotNull Set<String> getLabelsToExclude()
      A set of labellings to exclude from the search (so to avoid expiring build results with certain labels).
      Returns:
      an immutable set of labels to exclude

    • getMaxResults

      int getMaxResults()
      Number of results to return.

    • getMinBuildNumberToKeep

      @Nullable @Nullable Integer getMinBuildNumberToKeep()
      A criterion for result summaries that will cause to fetch results with smaller build number, regardless of getMaxBuildCompletedDate()
      Returns:
      the first build number that should be kept or null, if the criterion is not set