Number Function Parameter

Number function parameters expect an arbitrary precision (generally over 64-bit, up to 512-bit) number value from a practitioner configuration. Values are accessible in function logic by the Go built-in *big.Float type or the framework number type.

In this Terraform configuration example, a number parameter is set to the value greater than 64 bits:

provider::example::example(pow(2, 64) + 1)

Function Definition

Use the function.NumberParameter type in the function definition to accept a number value.

In this example, a function definition includes a first position number parameter:

func (f ExampleFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse) {
    resp.Definition = function.Definition{
        // ... other Definition fields ...
        Parameters: []function.Parameter{
            function.NumberParameter{
                Name: "number_param",
                // ... potentially other NumberParameter fields ...
            },
        },
    }
}

If the number value should be the element type of a collection parameter type, set the ElementType field according to the framework number type. Refer to the collection parameter type documentation for additional details.

If the number value should be a value type of an object parameter type, set the AttributeTypes map value according to the framework number type. Refer to the object parameter type documentation for additional details.

Allow Null Values

By default, Terraform will not pass null values to the function logic. Use the AllowNullValue field to explicitly allow null values, if there is a meaningful distinction that should occur in function logic. Enabling AllowNullValue requires using a Go pointer type or framework number type when reading argument data.

Allow Unknown Values

By default, Terraform will not pass unknown values to the function logic. Use the AllowUnknownValues field to explicitly allow unknown values, if there is a meaningful distinction that should occur in function logic. Enabling AllowUnknownValues requires using a framework number type when reading argument data.

Custom Types

You may want to build your own data value and type implementations to allow your provider to combine validation and other behaviors into a reusable bundle. This helps avoid duplication and ensures consistency. These implementations use the CustomType field in the parameter type.

Refer to Custom Types for further details on creating provider-defined types and values.

Documentation

Refer to function documentation for information about the Name, Description, and MarkdownDescription fields available.

Reading Argument Data

The function implementation documentation covers the general methods for reading function argument data in function logic.

When retrieving the argument value for this parameter:

• If CustomType is set, use its associated value type.
• If AllowUnknownValues is enabled, you must use the framework number type.
• Otherwise, use the Go built-in *big.Float type or framework number type.

In this example, a function defines a single number parameter and accesses its argument value:

func (f ExampleFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse) {
    resp.Definition = function.Definition{
        // ... other Definition fields ...
        Parameters: []function.Parameter{
            function.NumberParameter{
                Name: "number_param",
                // ... potentially other NumberParameter fields ...
            },
        },
    }
}

func (f ExampleFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse) {
    var numberArg *big.Float
    // var numberArg types.Number // e.g. with AllowUnknownValues or AllowNullValue

    resp.Error = function.ConcatFuncErrors(resp.Error, req.Arguments.Get(ctx, &numberArg))

    // numberArg is now populated
    // ... other logic ...
}