EndpointEnvironmentVariables class Endpoint

Endpoint for managing environment variables.

Inheritance
Implementers

Properties

caller → EndpointCaller
Holds a reference to the caller class.
finalinherited
client ↔ ServerpodClientShared
Reference to the client.
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
name → String
The name of the endpoint this reference is connected to.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stream → Stream<SerializableModel>
Stream of messages sent from an endpoint that supports streaming.
no setterinherited

Methods

create(String name, String value, String cloudCapsuleId) → Future<EnvironmentVariable>
Creates a new EnvironmentVariable with the specified name and value. Throws a DuplicateEntryException if an environment variable with the same name already exists.
delete({required String cloudCapsuleId, required String name}) → Future<EnvironmentVariable>
Permanently deletes an environment variable. Throws a NotFoundException if the environment variable is not found.
list(String cloudCapsuleId) → Future<List<EnvironmentVariable>>
Gets the list of environment variables for the given cloudCapsuleId.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
read({required String name, required String cloudCapsuleId}) → Future<EnvironmentVariable>
Fetches the specified environment variable. Throws a NotFoundException if the environment variable is not found.
resetStream() → void
Resets web socket stream, so it's possible to re-listen to endpoint streams.
inherited
sendStreamMessage(SerializableModel message) → Future<void>
Sends a message to the endpoint's stream.
inherited
toString() → String
A string representation of this object.
inherited
update({required String name, required String value, required String cloudCapsuleId}) → Future<EnvironmentVariable>
Creates a new EnvironmentVariable with the specified name and value. Throws a NotFoundException if the environment variable is not found.

Operators

operator ==(Object other) → bool
The equality operator.
inherited