GlobalConfiguration class
The current global configuration values for the Serverpod Cloud CLI.
Constructors
-
GlobalConfiguration.from({required Configuration<
GlobalOption> configuration}) -
GlobalConfiguration.resolve({ArgResults? argResults, Iterable<
String> ? args, Map<String, String> ? env})
Properties
- apiServer → String
-
no setter
- authToken → String?
-
no setter
- connectionTimeout → Duration
-
no setter
- consoleServer → String
-
no setter
-
errors
→ Iterable<
String> -
Gets the errors that occurred during configuration resolution.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
options
→ Iterable<
GlobalOption> -
Gets the option definitions for this configuration.
no setterinherited
- projectConfigContent → String?
-
no setter
- projectConfigFile → File?
-
no setter
- projectDir → Directory?
-
no setter
- quiet → bool
-
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scloudDir → Directory
-
no setter
- skipConfirmation → bool
-
no setter
- usage → String
-
Returns the usage help text for the options of this configuration.
no setterinherited
- verbose → bool
-
no setter
- version → bool
-
no setter
Methods
-
findOption(
{String? enumName, String? argName, int? argPos, String? envName, String? configKey}) → GlobalOption? -
Returns the option definition for the given enum name,
or any provided argument name, position,
environment variable name, or configuration key.
The first one that matches is returned, or null if none match.
inherited
-
findValueOf<
V> ({String? enumName, String? argName, int? argPos, String? envName, String? configKey}) → V? -
Returns the value of a configuration option
identified by name, position, or key.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
optionalValue<
V> (OptionDefinition< V> option) → V? -
Returns the value of an optional configuration option.
Returns
null
if the option is not set.inherited -
optionsWhereSource(
bool test(ValueSourceType source)) → Iterable< GlobalOption> -
Returns the options that have a value matching
the source type test.
inherited
-
throwExceptionOnErrors(
) → void -
Throws a
UsageException
with error and correct usage information if there were any errors during configuration resolution. Can be overridden to change the exception or its content.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
value<
V> (OptionDefinition< V> option) → V -
Returns the value of a configuration option
that is guaranteed to be non-null.
inherited
-
valueSourceType(
GlobalOption option) → ValueSourceType -
Returns the source type of the given option's value.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited