Class ComponentPurgeBodyFilters


  • public final class ComponentPurgeBodyFilters
    extends Object
    User-defined filters to return data which will be purged from the table.
    • Constructor Detail

      • ComponentPurgeBodyFilters

        public ComponentPurgeBodyFilters()
    • Method Detail

      • column

        public String column()
        Get the column property: The column of the table over which the given query should run.
        Returns:
        the column value.
      • withColumn

        public ComponentPurgeBodyFilters withColumn​(String column)
        Set the column property: The column of the table over which the given query should run.
        Parameters:
        column - the column value to set.
        Returns:
        the ComponentPurgeBodyFilters object itself.
      • operator

        public String operator()
        Get the operator property: A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query.
        Returns:
        the operator value.
      • withOperator

        public ComponentPurgeBodyFilters withOperator​(String operator)
        Set the operator property: A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query.
        Parameters:
        operator - the operator value to set.
        Returns:
        the ComponentPurgeBodyFilters object itself.
      • value

        public Object value()
        Get the value property: the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values.
        Returns:
        the value value.
      • withValue

        public ComponentPurgeBodyFilters withValue​(Object value)
        Set the value property: the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values.
        Parameters:
        value - the value value to set.
        Returns:
        the ComponentPurgeBodyFilters object itself.
      • key

        public String key()
        Get the key property: When filtering over custom dimensions, this key will be used as the name of the custom dimension.
        Returns:
        the key value.
      • withKey

        public ComponentPurgeBodyFilters withKey​(String key)
        Set the key property: When filtering over custom dimensions, this key will be used as the name of the custom dimension.
        Parameters:
        key - the key value to set.
        Returns:
        the ComponentPurgeBodyFilters object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.