{
  "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.",
  "type" : "scalar",
  "name" : "clamp_min",
  "description" : "Limits (or clamps) all input sample values to a lower bound of min. Any value below min is set to min.",
  "signatures" : [
    {
      "params" : [
        {
          "name" : "field",
          "type" : "boolean",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "boolean",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "boolean"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "date",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "date",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "date"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "double",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "double",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "double",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "integer",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "double",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "double",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "integer",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "double",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "integer",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "integer",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "integer"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "integer",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "integer",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "unsigned_long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "ip",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "ip",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "ip"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "keyword",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "keyword",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "double",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "integer",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "unsigned_long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "double",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "integer",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "unsigned_long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "unsigned_long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "version",
          "optional" : false,
          "description" : "field to clamp."
        },
        {
          "name" : "min",
          "type" : "version",
          "optional" : false,
          "description" : "The min value to clamp data into."
        }
      ],
      "variadic" : false,
      "returnType" : "version"
    }
  ],
  "examples" : [
    "FROM k8s\n| STATS full_clamped_cost=sum(clamp(network.cost, 1, 2)), clamped_cost=sum(clamp_max(network.cost, 1)), clamped_min_cost=sum(clamp_min(network.cost, 10)) BY time_bucket = bucket(@timestamp,1minute)"
  ],
  "preview" : false,
  "snapshot_only" : false
}