FunctionArg
API reference
An argument accepted by a function.
This is a specification for an argument at function definition time, not an argument passed at function call time.
Implements Node
defaultAddress- Only applies to arguments of type Container. If the argument is not set, load it from the given address (e.g. alpine:latest)
defaultPath- Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory
defaultValue- A default value to use for this argument when not explicitly set by the caller, if any.
deprecated- The reason this function is deprecated, if any.
description- A doc string for the argument, if any.
id- A unique identifier for this FunctionArg.
ignore- Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.
name- The name of the argument in lowerCamelCase format.
sourceMap- The location of this arg declaration.
typeDef- The type of the argument.
defaultAddress: String!
Only applies to arguments of type Container. If the argument is not set, load it from the given address (e.g. alpine:latest)
defaultPath: String!
Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory
defaultValue: JSON!
A default value to use for this argument when not explicitly set by the caller, if any.
deprecated: String
The reason this function is deprecated, if any.
description: String!
A doc string for the argument, if any.
id: ID!
A unique identifier for this FunctionArg.
ignore: [String!]!
Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.
name: String!
The name of the argument in lowerCamelCase format.