ProjectIdOption class
Constructors
- ProjectIdOption.new({bool asFirstArg = false})
-
Project ID option that can be passed as command line argument
(and if asFirstArg is true, also as the first positional argument),
env variable, and scloud config file.
const
- ProjectIdOption.argsOnly({bool asFirstArg = false})
-
Used for commands that require explicit command line argument for the
project ID, i.e. not from env variable or scloud config file.
(And if asFirstArg is true, also as the first positional argument.)
const
- ProjectIdOption.nonMandatory({bool asFirstArg = false})
-
Used for commands that interactively ask for the project ID but
allow it to be specified as a command line argument
(and if asFirstArg is true, also as the first positional argument).
Does not accept value from env variable or scloud config file.
const
Properties
-
allowedHelp
→ Map<
String, String> ? -
finalinherited
-
allowedValues
→ List<
String> ? -
finalinherited
- argAbbrev → String?
-
finalinherited
-
argAliases
→ List<
String> ? -
finalinherited
- argName → String?
-
finalinherited
- argPos → int?
-
finalinherited
- configKey → String?
-
finalinherited
- customValidator → void Function(String value)?
-
finalinherited
- defaultsTo → String?
-
finalinherited
- envName → String?
-
finalinherited
-
fromCustom
→ String? Function(Configuration<
OptionDefinition> cfg)? -
finalinherited
- fromDefault → String Function()?
-
finalinherited
- group → OptionGroup?
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- helpText → String?
-
finalinherited
- hide → bool
-
finalinherited
- mandatory → bool
-
finalinherited
-
option
→ ConfigOptionBase<
String> -
Returns self.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- valueHelp → String?
-
finalinherited
-
valueParser
→ ValueParser<
String> -
finalinherited
Methods
-
defaultValue(
) → String? -
inherited
-
defaultValueString(
) → String? -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
qualifiedString(
) → String -
inherited
-
resolveValue(
Configuration< OptionDefinition> cfg, {ArgResults? args, Iterator<String> ? posArgs, Map<String, String> ? env, ConfigurationBroker<OptionDefinition> ? configBroker}) → OptionResolution<String> -
//////////////////
Returns the resolved value of this configuration option from the provided context.
For options with positional arguments this must be invoked in ascending position order.
Returns the result with the resolved value or error.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
validateDefinition(
) → void -
Validates the configuration option definition.
inherited
-
validateOptionValue(
String? value) → String? -
Returns an error message if the value is invalid, or null if valid.
inherited
-
validateValue(
String value) → void -
Validates the parsed value,
throwing a FormatException if the value is invalid,
or a
UsageException
if the value is invalid for other reasons.inherited -
valueHelpString(
) → String? -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited