ground_control_client library

Classes

AcceptedTerms
AcceptedTermsDTO
AdminProjectInfo
AuthenticationKeyManager: Manages keys for authentication with the server.
AuthTokenInfo
BackupSchedule: An automated backup (snapshot) schedule for a database.
BadRequestMessage: A message sent when a bad request is received.
BillingInfo
Bit: Represents a binary vector, where each element is either true or false.
BucketFile: A single stored file in a bucket.
BucketFileListing: A single page of files in a bucket together with the token for the next page.
BucketResource
BucketServiceAccount
Capsule: Represents an infrastructure capsule instance (a deployment target).
CapsuleDeploymentStatus: The runtime status of a capsule's deployment.
CapsuleNetworkSeries: Aggregate network signals for a capsule over a time range.
CapsuleResource
CapsuleRevision: The identity of one revision of a capsule deployment.
CapsuleRuntimeStatus: The live runtime status of a capsule, enriched with summaries of the deploy attempts behind the serving and incoming revisions.
CapsuleStatus: The live runtime status of a capsule.
Client
ClientAuthKeyProvider: Provides the authentication key for the client.
CloseMethodStreamCommand: A message sent over a websocket connection to close a websocket stream of data to an endpoint method.
ComputeCatalogInfo: A catalog of available compute products.
ComputeInfo
ComputeProductInfo: Definition of a compute product including defaults and constraints.
ComputeScalingInfo: Scaling configuration for a compute size that supports variable replica scaling.
ConnectivityMonitor: Keeps track of internet connectivity and notifies its listeners when the internet connection is either lost or regained. For most use cases, use the concrete FlutterConnectivityMonitor class in the serverpod_flutter package.
ConsoleRoutes: Official route paths to entry pages in the console. Used for example by scloud to open the intended page in the console on login or project creation.
CustomDomainName
CustomDomainNameList
CustomDomainNameWithDefaultDomains
DartSdkVersion: A Dart SDK version supported by Serverpod Cloud.
DartSdkVersionPolicy: The Dart SDK version policy for projects deployed to Serverpod Cloud.
DatabaseCatalogInfo: A catalog of available database products.
DatabaseConnection
DatabaseInfo
DatabaseMetrics: Database signals for a capsule over a time range.
DatabaseProductInfo: Definition of a database product including defaults and constraints.
DatabaseQuota
DatabaseResource
DatabaseScaling
DatabaseScalingInfo: Scaling configuration for a database size that supports variable CU allocation.
DatabaseSnapshot: A point-in-time snapshot (backup) of a database.
DatabaseUser
DeepCollectionEquality: Deep equality on collections.
DeployAttempt: Represents the status information of a deployment attempt.
DeployAttemptStage: Represents the status information of a stage in a deployment attempt.
DeployAttemptSummary: Display summary of a deploy attempt, for presenting the deployment behind a capsule revision without the full attempt aggregate.
EndpointAdminDatabaseScaling Endpoint: Endpoint for reconciling database compute scaling against Serverpod Cloud.
EndpointAdminMigration Endpoint
EndpointAdminProcurement Endpoint: Endpoint for global administrator to handle procurement for users.
EndpointAdminProjects Endpoint: Endpoint for global administrator projects access.
EndpointAdminSecrets Endpoint: Endpoint for global administrator secrets migration.
EndpointAdminStorageIdentity Endpoint: Endpoint for the one-off storage-identity backfill.
EndpointAdminUpdatePlan Endpoint
EndpointAdminUsers Endpoint: Endpoint for global administrator users access.
EndpointAuth Endpoint: Endpoint for authentication.
EndpointAuthWithAuth Endpoint: Endpoint for authenticated-user session management.
EndpointBilling Endpoint
EndpointBucket Endpoint: Endpoint for managing a capsule's storage buckets.
EndpointBucketObjects Endpoint: Endpoint for the object contents of a capsule's storage buckets.
EndpointCaller: Super class for all classes that can call a server endpoint.
EndpointCapsules Endpoint: Endpoint for capsule operations.
EndpointCompute Endpoint: Endpoint for reading and updating capsule compute configuration.
EndpointCustomDomainName Endpoint
EndpointDatabase Endpoint: Endpoint for database management.
EndpointDeploy Endpoint
EndpointEmailIdp Endpoint
EndpointEnvironmentVariables Endpoint: Endpoint for managing environment variables.
EndpointGitHubIdp Endpoint
EndpointGoogleIdp Endpoint
EndpointInfraResources Endpoint: Endpoint for infrastructure resource provisioning.
EndpointInsights Endpoint
EndpointJwtRefresh Endpoint: By extending RefreshJwtTokensEndpoint, the JWT token refresh endpoint is made available on the server and enables automatic token refresh on the client.
EndpointLogs Endpoint: Endpoint for accessing cloud logs.
EndpointMetrics Endpoint: Endpoint for reading capsule metrics.
EndpointPlans Endpoint: Endpoint for managing subscription plans.
EndpointPlatform Endpoint: Endpoint for reading platform information about Serverpod Cloud.
EndpointProjects Endpoint: Endpoint for managing projects.
EndpointRef: This class connects endpoints on the server with the client, it also hooks up streams with the endpoint. Overridden by generated code.
EndpointRoles Endpoint: Endpoint for managing access roles.
EndpointSecrets Endpoint
EndpointStatus Endpoint: Endpoint for accessing capsule deployment status.
EndpointUsers Endpoint: Endpoint for managing users.
EnvironmentVariable
FileUploader: The file uploader uploads files to Serverpod's cloud storage. On the server you can setup a custom storage service, such as S3 or Google Cloud. To directly upload a file, you first need to retrieve an upload description from your server. After the file is uploaded, make sure to notify the server by calling the verifyDirectFileUpload on the current Session object.
Geography: Abstract base class for all PostGIS geography types.
GeographyGeometryCollection: Represents a PostGIS GeometryCollection — a heterogeneous collection of Geography values (points, line strings, polygons).
GeographyLineString: Represents a geographic line string (sequence of points) for use with PostGIS.
GeographyPoint: Represents a geographic point with longitude, latitude, and spatial reference system identifier (SRID) for use with PostGIS.
GeographyPolygon: Represents a geographic polygon (exterior ring + optional holes) for PostGIS.
HalfVector: Represents a vector of half-precision float values.
InsightsConnectionDetail
LogRecord: Represents a log record (entry).
MethodCallContext: Context for a method call.
MethodStreamMessage: A message sent to a method stream.
MethodStreamSerializableException: A serializable exception sent over a method stream.
MetricSample: A single observed sample in a metric series, for a pod or a database alike.
ModuleEndpointCaller: This class is used to connect modules with the client. Overridden by generated code.
Modules
MutexRefresherClientAuthKeyProvider: A RefresherClientAuthKeyProvider decorator that adds a mutex lock to prevent concurrent refresh calls. Actual auth header getter and refresh logic is delegated to the _delegate provider.
OpenMethodStreamCommand: A message sent over a websocket connection to open a websocket stream of data to an endpoint method.
OpenMethodStreamResponse: A message sent over a websocket connection to respond to an OpenMethodStreamCommand.
Owner
PaymentMethod
PaymentMethodCard
PaymentSetupIntent
PaymentsStatus
PingCommand: A message sent over a websocket connection to check if the connection is still alive. The other end should respond with a PongCommand.
PlanInfo: Information about a plan product. Contains information to be sent to the client.
PodResourceSeries: Per-pod CPU and memory series for a capsule over a time range.
PongCommand: A response to a PingCommand.
Project: Represents a project of a tenant. Typically a serverpod project.
ProjectConfig
ProjectInfo: Augments a project object with ancillary information.
ProjectProductInfo: Definition of a project product including its compute and database sub-products.
ProjectProfileUpdate: Payload for updating a project profile together with compute scaling and database sizing.
Protocol
ProtocolSerialization: The ProtocolSerialization defines a toJsonForProtocol method which makes it possible to limit what fields are serialized when communicating over the protocol.
PubsubEntry: Represents the receiving of a Pubsub message.
RefresherClientAuthKeyProvider: Provides the authentication key for the client, with a method to refresh it.
RequiredTerms
ResponseClassSeries: Response-rate series for a single status class of a capsule's aggregate traffic.
Role: Represents an access role for a specific project. Roles are assigned to users via membership, giving them the role's access scopes.
SecretResource
SerializableModel: The SerializableModel is the base interface for all serializable objects in Serverpod, except primitives.
SerializationManager: The SerializationManager is responsible for creating objects from a serialization, but also for serializing objects. This class is typically extended by generated code.
ServerpodClientRequestDelegate: Defines the interface of the delegate that performs the actual request to the server and returns the response data. The delegate is used by ServerpodClientShared to perform the actual request. It's overridden in different versions depending on if the dart:io library is available.
ServerpodClientShared: Superclass with shared methods for handling communication with the server. Is typically overridden by generated code to provide implementations of methods for calling the server.
SparseVector: Represents a sparse vector that stores only non-zero elements.
StoredSecretVersion
SubscriptionInfo: Information about a subscription. Contains information to be sent to the client.
Timestamp
User: Represents a Serverpod cloud customer user, invited or registered.
UserLabelMapping: Associates users (including invited, not yet registered) with user labels.
UserRoleMembership: Represents a membership of a user in a role.
Uuid: uuid for Dart Author: Yulian Kuncheff Released under MIT License.
UuidValue
Vector: Represents a vector of double values.
WebSocketMessage: Base class for messages sent over a WebSocket connection.
WebSocketMessageInfo: Interface of WebSocketMessage subclasses that have endpoint, method and connection id info.

Enums

BackupFrequency: How often an automated backup schedule creates database snapshots.
BillingCustomerType
BillingMappingType
BucketAccessRevocationReason: The cap breach that caused customer access to a bucket to be revoked.
BucketProvider
BucketServiceAccountStatus: The lifecycle state of a capsule's storage-identity service account, recording facts that have happened rather than operations in flight.
BucketStatus: The lifecycle state of a bucket resource, recording facts that have happened rather than operations in flight.
BucketVisibility
BuildSecretType
CapsuleState: The runtime state of a capsule or its deployment.
CloseReason: The reason a stream was closed.
ComputeSizeOption
DatabaseMetricsStatus: Why a database series may be empty over the queried window.
DatabaseProvider
DatabaseSizeOption
DeployProgressStatus
DeployStageType
DnsRecordType
DomainNameStatus
DomainNameTarget
HttpResponseClass: An HTTP response status class.
MetricsRange: A predefined span length for pod resource metrics queries.
Namespace: RFC4122 & RFC9562 provided namespaces for v3, v5, and v8 namespace based UUIDs
OpenMethodStreamResponseType: The response to an OpenMethodStreamCommand.
PlanChangeDeniedReason: The reason a plan change was denied.
PlanType: The type of plan.
ProcurementDeniedReason: The reason a procurement was denied.
ProductType
RefreshAuthKeyResult: Represents the result of an authentication key refresh operation.
SecretType
ServerpodRegion
Terms
UserAccountStatus
UserLabel
ValidationMode: The options for UUID Validation strictness

Extensions

Base64Dec on String: Extension for decoding ByteData in protocol.
Base64Enc on ByteData: Extension for encoding ByteData in the protocol.
BigIntJsonExtension on BigInt: Expose toJson on BigInt Expose static fromJson builder
BitJsonExtension on Bit: Expose toJson on Bit
BoolJsonExtension on bool: Expose static fromJson builder for bool that handles bool or int values. Required to handle SQL boolean values that are stored as 0 or 1.
ByteDataJsonExtension on ByteData: Expose toJson on ByteData Expose static fromJson builder
CloneBit on Bit: Adds clone method that create a deep copy of a Bit vector.
CloneByteData on ByteData: Adds clone method that create a deep copy of a ByteData.
CloneHalfVector on HalfVector: Adds clone method that create a deep copy of a HalfVector.
CloneSparseVector on SparseVector: Adds clone method that create a deep copy of a SparseVector.
CloneVector on Vector: Adds clone method that create a deep copy of a ByteData.
DateTimeJsonExtension on DateTime: Expose toJson on DateTime Expose static fromJson builder
DurationJsonExtension on Duration: Expose toJson on Duration Expose static fromJson builder
GeographyGeometryCollectionJsonExtension on GeographyGeometryCollection: Expose toJson on GeographyGeometryCollection and a static fromJson builder.
GeographyLineStringJsonExtension on GeographyLineString: Expose toJson on GeographyLineString and a static fromJson builder.
GeographyPointJsonExtension on GeographyPoint: Expose toJson on GeographyPoint and a static fromJson builder.
GeographyPolygonJsonExtension on GeographyPolygon: Expose toJson on GeographyPolygon and a static fromJson builder.
HalfVectorJsonExtension on HalfVector: Expose toJson on HalfVector
ListJsonExtension on List<T>: Expose toJson on List
MapJsonExtension on Map<K, V>: Expose toJson on Map
SetJsonExtension on Set<T>: Expose toJson on Set
SparseVectorJsonExtension on SparseVector: Expose toJson on SparseVector
UriJsonExtension on Uri: Expose toJson on Uri Expose static fromJson builder
UuidValueJsonExtension on UuidValue: Expose toJson on UuidValue Expose static fromJson builder
VectorJsonExtension on Vector: Expose toJson on Vector

Constants

autoSerializedTypes → const List<String>: All datatypes that are serialized by default. Used internally in Serverpod code generation.
basicAuthSchemeName → const String: The name of the default Serverpod scheme for HTTP "authorization" headers. Note, the scheme name is case-insensitive and should be compared in a case-insensitive manner.
bearerAuthSchemeName → const String: The name of the Bearer scheme for HTTP "authorization" headers. Note, the scheme name is case-insensitive and should be compared in a case-insensitive manner.
extensionSerializedTypes → const List<String>: All datatypes that has extensions to support serialization. Used internally in Serverpod code generation.
hasCloneExtensionTypes → const List<String>: List of types that has a clone method extension and therefore can be copied by calling clone().
immutable → const Immutable: Annotation on an immutable class.
useResult → const UseResult: Annotation on function or property whose value must not be ignored.

Properties

nonMutableTypeNames → List<String>: List of types that are not mutable and therefore do not need to be copied or handled in a copyWith method.
final

Functions

getType<T>() → Type: Get the type provided as an generic. Useful for getting a nullable type.
isRetryableMethodStreamDisconnect(Object error) → bool: Whether error represents a method-stream transport disconnect that can be retried by opening a new stream.
isValidAuthHeaderValue(String value) → bool: Returns true if the provided value is a valid HTTP "authorization" header value (which includes starting with an authentication scheme name).
isWrappedBasicAuthHeaderValue(String value) → bool: Returns true if the provided value is a Serverpod-wrapped auth key.
isWrappedBearerAuthHeaderValue(String value) → bool: Returns true if the provided value is a Bearer auth header value.
reconnectStream<T>(Stream<T> connect(T? lastEvent), {required bool shouldRetry(Object error), int maxRetries = 3, Duration retryDelay = const Duration(seconds: 2)}) → Stream<T>: Recreates a stream after retryable errors, passing the last emitted event to each subsequent connection.
unwrapAuthHeaderValue(String? authValue) → String?: Returns the auth key from an auth value that has potentially been wrapped. This operation is the inverse of wrapAsBasicAuthHeaderValue and wrapAsBearerAuthHeaderValue. If null is provided, null is returned.
wrapAsBasicAuthHeaderValue(String key) → String: Returns a value that is compliant with the HTTP auth header format by encoding and wrapping the provided auth key as a Basic auth value.
wrapAsBearerAuthHeaderValue(String token) → String: Returns a value that is compliant with the HTTP auth header format by wrapping the provided token as a Bearer auth value. Unlike Basic auth, Bearer tokens are not Base64 encoded as they are expected to already be in the correct format.

Typedefs

ConnectivityMonitorListener = void Function(bool connected): Callback for when internet connectivity changes.
VoidCallback = void Function(): A callback with no parameters or return value.

Exceptions / Errors

AuthHeaderEncodingException: An exception thrown upon erroneous encoding of an auth header.
BucketAccessRevokedException: Thrown when an upload is attempted on a bucket whose customer access is revoked by cap enforcement. Reads and deletes remain available so usage can be reduced.
BucketRateLimitExceededException: Thrown when a capsule has spent its hourly budget for a bucket object operation. retryAfter is the time left until the budget is refreshed.
BucketStorageIdentityUnavailableException: Thrown when a bucket cannot be created yet because the capsule's storage identity has not finished provisioning. The operation is safe to retry.
CapsuleStatusUnavailableException: Thrown when the live status of a capsule cannot currently be determined, due to a status service failure, network error, or timeout. The operation is safe to retry.
ConcurrentSubscriptionUpdateException: Exception thrown when another subscription update is in progress.
ConnectionAttemptTimedOutException: Thrown if connection attempt timed out.
ConnectionClosedException: Thrown if the connection is closed with an error.
DartSdkUnsupportedConstraintException
DatabaseSnapshotLimitException: Thrown when a manual snapshot cannot be created because the per-project snapshot limit has been reached.
DeserializationTypeNotFoundException: Exception thrown when no deserialization type was found during protocol deserialization
DNSVerificationFailedException
DuplicateEntryException
EmailMethodBlockedException: Thrown when a user attempts to sign in with email/password for an account that was registered with another identity provider.
InvalidValueException
MethodStreamException: Exceptions thrown by the ClientMethodStreamManager.
MethodStreamIdleTimeoutException: Thrown if the method stream connection is idle for too long.
NoCustomerBillingTypeException: Exception thrown when the owner has no customer billing type configured.
NoPriorDeploymentException: Exception thrown when no prior deployment exists for a capsule.
NoSubscriptionException: Exception thrown when a user / owner lacks a valid subscription.
NotFoundException
OpenMethodStreamException: Thrown if opening a method stream fails.
PlanChangeDeniedException: Exception thrown when a plan change is denied because a feature that is currently in use would be stranded by the new plan.
ProcurementCancellationException: Exception thrown when the cancellation of a procured product failed.
ProcurementDeniedException: Exception thrown when a procurement is denied to the user / organization due to insufficient allowance or other subscription limits.
SerializableException: This is SerializableException that can be used to pass Domain exceptions from the Server to the Client
ServerpodClientBadRequest: Thrown if the client created a malformed or invalid request to the server.
ServerpodClientEndpointNotFound: Thrown if the client tries to call an endpoint that was not generated. This will typically happen if getting the endpoint by type while the user has not defined the endpoint in their project.
ServerpodClientException: Exception thrown when errors in communication with the server occurs.
ServerpodClientForbidden: Thrown if the client is forbidden to perform the request. This is typically due to missing permissions.
ServerpodClientGetEndpointException: Thrown if not able to get an endpoint on the client by type.
ServerpodClientInternalServerError: Thrown if the server encountered an internal error. This is typically a bug in the server code.
ServerpodClientMultipleEndpointsFound: Thrown if the client tries to call an endpoint by type, but multiple endpoints of that type exists. The user should disambiguate by using the name parameter.
ServerpodClientNotFound: Thrown if the requested resource was not found on the server.
ServerpodClientUnauthorized: Thrown if the client fails to authenticate and is therefore not authorized to perform the request.
UnauthenticatedException
UnauthorizedException
UnknownMessageException: Exception thrown when an unknown message is received.
UserAccountRegistrationDeniedException: Indicates that the user account registration request was denied, due to incomplete information or missing approval.
WebSocketClosedException: Thrown if the WebSocket connection is closed.
WebSocketConnectException: Thrown if the WebSocket connection fails.
WebSocketListenException: Thrown if an error occurs when listening to the WebSocket connection.

ground_control_client library

Classes

Enums

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

ground_control_client package

ground_control_client library