GmFunctionParam

A typed parameter of a studio-defined function.

type GmFunctionParam {
  name: String!
  valueType: String!
  required: Boolean!
  defaultValueJson: String
  description: String
  sortOrder: Int!
}

Fields

GmFunctionParam.name ● String! non-null scalar

Parameter name (referenced as $name in expressions).

GmFunctionParam.valueType ● String! non-null scalar

Value type: int | float | string | bool | array | object | container_ref.

GmFunctionParam.required ● Boolean! non-null scalar

Whether the parameter is required at invoke time.

GmFunctionParam.defaultValueJson ● String scalar

JSON-encoded default value.

GmFunctionParam.description ● String scalar

Optional description of the parameter.

GmFunctionParam.sortOrder ● Int! non-null scalar

Display/order index of the parameter.

Member Of

GmFunction object