attributeType property

String? attributeType
getter/setter pair

The attribute type to be used to determine the boost amount.

The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).

Optional. Possible string values are:

  • "ATTRIBUTE_TYPE_UNSPECIFIED" : Unspecified AttributeType.
  • "NUMERICAL" : The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.
  • "FRESHNESS" : For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: nDnM]. E.g. 5D, 3DT12H30M, T24H.

Implementation

core.String? attributeType;