GcRuleBuilder

GcRuleBuilder

Helper class for building valid garbage collection rules. TypeScript is recommended here for the maximum help, as types will guide user code at compile time; however, some correctness checking happens at runtime to help JavaScript users as well.

Constructor

new GcRuleBuilder()

Methods

(static) intersection(…params)

Intersections are formed from other groupings (union, intersection) and potentially rules (e.g. maxAge). They will match if all of the items are true.

Parameters:
Name Type Attributes Description
params <repeatable>

Groupings and/or rules to be included

Returns:
Type Description

[IGcRule] A newly built group

(static) rule(params)

Rules are leaf nodes and contain constraints such as maxAge and maxNumVersions.

Parameters:
Name Type Description
params

[IGcRule] Filled rule

Returns:
Type Description

[IGcRule] A typed/checked rule

(static) union(…params)

Unions are formed from other groupings (union, intersection) and potentially rules (e.g. maxAge). They will match if any of the items are true.

Parameters:
Name Type Attributes Description
params <repeatable>

Groupings and/or rules to be included

Returns:
Type Description

[IGcRule] A newly built group