EndpointAdminProjects class Endpoint
Endpoint for global administrator projects access.
- Inheritance
-
- Object
- EndpointRef
- EndpointAdminProjects
Constructors
- EndpointAdminProjects(EndpointCaller caller)
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
Methods
-
changeProjectOwner(
{required String cloudProjectId, required UuidValue newOwnerId}) → Future< void> - Moves a project to a new subscription under a new owner, with the same plan type as previously and to the private/business type of the new owner.
-
deleteProject(
{required String cloudProjectId, bool? keepEmptySubscription}) → Future< Project> - Archives a project and its capsule and permanently deletes its infrastructure on behalf of a user. Executes the same deletion code path as the regular deleteProject endpoint, but bypasses project-level authorization.
-
getDeployAttempts(
{required String cloudCapsuleId, int? limit}) → Future< List< DeployAttempt> > -
Gets deploy attempts of the specified capsule.
Gets the recent-most attempts, up till
limitif specified. -
getProjectStatus(
{required String cloudProjectId}) → Future< AdminProjectInfo> - Reads overview status for a project.
-
listAdminProjectsInfo(
{bool? includeArchived, bool? includeLatestDeployAttemptTime, bool? includePaymentsStatus, ProjectListFilter? filter}) → Stream< AdminProjectInfo> - Fetches administrative information for the list of all projects. The result includes the owners for each project and the latest deploy attempt time (or null if undeployed).
-
listProjects(
{bool? includeArchived}) → Future< List< Project> > - Fetches the list of all projects. The result includes the owners for each project.
-
listProjectsInfo(
{bool? includeArchived, bool? includeLatestDeployAttemptTime}) → Future< List< ProjectInfo> > - Fetches the list of all projects. The result includes the owners for each project and the latest deploy attempt time (or null if undeployed).
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reactivateProject(
{required String cloudProjectId}) → Future< Project> - Reactivates a suspended project, resuming its capsule if it has a successful deployment. An already active project is returned unchanged.
-
redeployCapsule(
String cloudCapsuleId) → Future< UuidValue> - Redeploys a capsule using its current image. Triggers a deploymentUpdated event to redeploy the infrastructure.
-
reprocureExistingProject(
{required String cloudProjectId, required ProjectProfileUpdate profile}) → Future< UuidValue> - Re-procures a plan subscription and the products of an existing project whose previous product allocations are missing or have been archived.
-
suspendProject(
{required String cloudProjectId}) → Future< Project> - Suspends a project manually, pausing its capsule. An already suspended project is returned unchanged.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateProjectProfile(
{required String cloudProjectId, required ProjectProfileUpdate profile}) → Future< void> - Applies a project profile change together with compute scaling and optional database sizing in one call.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited