-- Generated by scripts/generate.mjs. Do not edit.
module Dagger.FunctionArg
  ( defaultAddress
  , defaultPath
  , defaultValue
  , deprecated
  , description
  , id
  , ignore
  , name
  , sourceMap
  , typeDef
  ) where

import Data.Maybe (Maybe)
import Effect.Aff (Aff)
import Dagger.Internal.Runtime as R
import Dagger.Types as T

-- | Only applies to arguments of type Container. If the argument is not set, load it from the given address (e.g. alpine:latest)
defaultAddress :: T.FunctionArg -> Aff String
defaultAddress = R.scalar "defaultAddress" []

-- | 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
defaultPath :: T.FunctionArg -> Aff String
defaultPath = R.scalar "defaultPath" []

-- | A default value to use for this argument when not explicitly set by the caller, if any.
defaultValue :: T.FunctionArg -> Aff T.JSON
defaultValue = R.scalar "defaultValue" []

-- | The reason this function is deprecated, if any.
deprecated :: T.FunctionArg -> Aff (Maybe String)
deprecated = R.scalar "deprecated" []

-- | A doc string for the argument, if any.
description :: T.FunctionArg -> Aff String
description = R.scalar "description" []

-- | A unique identifier for this FunctionArg.
id :: T.FunctionArg -> Aff T.ID
id = R.scalar "id" []

-- | 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.
ignore :: T.FunctionArg -> Aff (Array String)
ignore = R.scalar "ignore" []

-- | The name of the argument in lowerCamelCase format.
name :: T.FunctionArg -> Aff String
name = R.scalar "name" []

-- | The location of this arg declaration.
sourceMap :: T.FunctionArg -> Aff (Maybe T.SourceMap)
sourceMap = R.nullableObject "SourceMap" "sourceMap" []

-- | The type of the argument.
typeDef :: T.FunctionArg -> T.TypeDef
typeDef = R.select "typeDef" []