Interface ProjectService
-
- All Implemented Interfaces:
public interface ProjectServiceServerless PostgreSQL databases with instant branching
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceProjectService.WithRawResponseA view of ProjectService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract ProjectService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract ProjectService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
create
ProjectCreateResponse create(ProjectCreateParams params)
Creates a new serverless Postgres database project powered by Neon. Includes automatic scaling, connection pooling, and a default 'main' branch with 'neondb' database. Supports branching for isolated dev/staging environments. Perfect for case management applications, document workflows, and litigation support systems.
-
create
abstract ProjectCreateResponse create(ProjectCreateParams params, RequestOptions requestOptions)
-
retrieve
ProjectRetrieveResponse retrieve(String id)
Retrieves detailed information about a specific database project including branches, databases, storage/compute metrics, connection host, and linked deployments. Fetches live usage statistics from Neon API.
-
retrieve
ProjectRetrieveResponse retrieve(String id, ProjectRetrieveParams params, RequestOptions requestOptions)
-
retrieve
ProjectRetrieveResponse retrieve(String id, ProjectRetrieveParams params)
-
retrieve
abstract ProjectRetrieveResponse retrieve(ProjectRetrieveParams params, RequestOptions requestOptions)
-
retrieve
ProjectRetrieveResponse retrieve(ProjectRetrieveParams params)
-
retrieve
ProjectRetrieveResponse retrieve(String id, RequestOptions requestOptions)
-
list
ProjectListResponse list()
Retrieves all serverless Postgres database projects for the authenticated organization. Includes storage and compute metrics, plus linked deployments from Thurgood apps and Compute instances.
-
list
abstract ProjectListResponse list(ProjectListParams params, RequestOptions requestOptions)
-
list
ProjectListResponse list(ProjectListParams params)
-
list
ProjectListResponse list(RequestOptions requestOptions)
-
delete
ProjectDeleteResponse delete(String id)
Permanently deletes a database project from Neon and marks it as deleted in Case.dev. This action cannot be undone and will destroy all data including branches and databases. Use with caution.
-
delete
ProjectDeleteResponse delete(String id, ProjectDeleteParams params, RequestOptions requestOptions)
-
delete
ProjectDeleteResponse delete(String id, ProjectDeleteParams params)
-
delete
abstract ProjectDeleteResponse delete(ProjectDeleteParams params, RequestOptions requestOptions)
-
delete
ProjectDeleteResponse delete(ProjectDeleteParams params)
-
delete
ProjectDeleteResponse delete(String id, RequestOptions requestOptions)
-
createBranch
ProjectCreateBranchResponse createBranch(String id, ProjectCreateBranchParams params)
Creates a new branch from the specified parent branch (or default 'main' branch). Branches provide instant point-in-time clones of your database for isolated development, staging, testing, or feature work. Perfect for testing schema changes, running migrations safely, or creating ephemeral preview environments.
-
createBranch
ProjectCreateBranchResponse createBranch(String id, ProjectCreateBranchParams params, RequestOptions requestOptions)
-
createBranch
ProjectCreateBranchResponse createBranch(ProjectCreateBranchParams params)
-
createBranch
abstract ProjectCreateBranchResponse createBranch(ProjectCreateBranchParams params, RequestOptions requestOptions)
-
getConnection
ProjectGetConnectionResponse getConnection(String id)
Retrieves the PostgreSQL connection URI for a database project. Supports selecting specific branches and pooled vs direct connections. Connection strings include credentials and should be stored securely. Use for configuring applications and deployment environments.
-
getConnection
ProjectGetConnectionResponse getConnection(String id, ProjectGetConnectionParams params, RequestOptions requestOptions)
-
getConnection
ProjectGetConnectionResponse getConnection(String id, ProjectGetConnectionParams params)
-
getConnection
abstract ProjectGetConnectionResponse getConnection(ProjectGetConnectionParams params, RequestOptions requestOptions)
-
getConnection
ProjectGetConnectionResponse getConnection(ProjectGetConnectionParams params)
-
getConnection
ProjectGetConnectionResponse getConnection(String id, RequestOptions requestOptions)
-
listBranches
ProjectListBranchesResponse listBranches(String id)
Retrieves all branches for a database project. Branches enable isolated development and testing environments with instant point-in-time cloning. Each branch includes the default branch and any custom branches created for staging, testing, or feature development.
-
listBranches
ProjectListBranchesResponse listBranches(String id, ProjectListBranchesParams params, RequestOptions requestOptions)
-
listBranches
ProjectListBranchesResponse listBranches(String id, ProjectListBranchesParams params)
-
listBranches
abstract ProjectListBranchesResponse listBranches(ProjectListBranchesParams params, RequestOptions requestOptions)
-
listBranches
ProjectListBranchesResponse listBranches(ProjectListBranchesParams params)
-
listBranches
ProjectListBranchesResponse listBranches(String id, RequestOptions requestOptions)
-
-
-
-