@Generated public interface PostgresService
This API manages database infrastructure only. To query or modify data, use the Data API or direct SQL connections.
**About resource IDs and names**
Resources are identified by hierarchical resource names like `projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`. The `name` field on each resource contains this full path and is output-only. Note that `name` refers to this resource path, not the user-visible `display_name`.
This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.
| Modifier and Type | Method and Description |
|---|---|
Operation |
createBranch(CreateBranchRequest createBranchRequest)
Creates a new database branch in the project.
|
Operation |
createEndpoint(CreateEndpointRequest createEndpointRequest)
Creates a new compute endpoint in the branch.
|
Operation |
createProject(CreateProjectRequest createProjectRequest)
Creates a new Lakebase Autoscaling Postgres database project, which contains branches and
compute endpoints.
|
Operation |
createRole(CreateRoleRequest createRoleRequest)
Creates a new Postgres role in the branch.
|
Operation |
deleteBranch(DeleteBranchRequest deleteBranchRequest)
Deletes the specified database branch.
|
Operation |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the specified compute endpoint.
|
Operation |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes the specified database project.
|
Operation |
deleteRole(DeleteRoleRequest deleteRoleRequest)
Deletes the specified Postgres role.
|
DatabaseCredential |
generateDatabaseCredential(GenerateDatabaseCredentialRequest generateDatabaseCredentialRequest)
Generate OAuth credentials for a Postgres database.
|
Branch |
getBranch(GetBranchRequest getBranchRequest)
Retrieves information about the specified database branch.
|
Endpoint |
getEndpoint(GetEndpointRequest getEndpointRequest)
Retrieves information about the specified compute endpoint, including its connection details
and operational state.
|
Operation |
getOperation(GetOperationRequest getOperationRequest)
Retrieves the status of a long-running operation.
|
Project |
getProject(GetProjectRequest getProjectRequest)
Retrieves information about the specified database project.
|
Role |
getRole(GetRoleRequest getRoleRequest)
Retrieves information about the specified Postgres role, including its authentication method
and permissions.
|
ListBranchesResponse |
listBranches(ListBranchesRequest listBranchesRequest)
Returns a paginated list of database branches in the project.
|
ListEndpointsResponse |
listEndpoints(ListEndpointsRequest listEndpointsRequest)
Returns a paginated list of compute endpoints in the branch.
|
ListProjectsResponse |
listProjects(ListProjectsRequest listProjectsRequest)
Returns a paginated list of database projects in the workspace that the user has permission to
access.
|
ListRolesResponse |
listRoles(ListRolesRequest listRolesRequest)
Returns a paginated list of Postgres roles in the branch.
|
Operation |
updateBranch(UpdateBranchRequest updateBranchRequest)
Updates the specified database branch.
|
Operation |
updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
Updates the specified compute endpoint.
|
Operation |
updateProject(UpdateProjectRequest updateProjectRequest)
Updates the specified database project.
|
Operation createBranch(CreateBranchRequest createBranchRequest)
Operation createEndpoint(CreateEndpointRequest createEndpointRequest)
Operation createProject(CreateProjectRequest createProjectRequest)
Operation createRole(CreateRoleRequest createRoleRequest)
Operation deleteBranch(DeleteBranchRequest deleteBranchRequest)
Operation deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Operation deleteProject(DeleteProjectRequest deleteProjectRequest)
Operation deleteRole(DeleteRoleRequest deleteRoleRequest)
DatabaseCredential generateDatabaseCredential(GenerateDatabaseCredentialRequest generateDatabaseCredentialRequest)
Branch getBranch(GetBranchRequest getBranchRequest)
Endpoint getEndpoint(GetEndpointRequest getEndpointRequest)
Operation getOperation(GetOperationRequest getOperationRequest)
Project getProject(GetProjectRequest getProjectRequest)
Role getRole(GetRoleRequest getRoleRequest)
ListBranchesResponse listBranches(ListBranchesRequest listBranchesRequest)
ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest)
ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest)
ListRolesResponse listRoles(ListRolesRequest listRolesRequest)
Operation updateBranch(UpdateBranchRequest updateBranchRequest)
Operation updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
Operation updateProject(UpdateProjectRequest updateProjectRequest)
Copyright © 2026. All rights reserved.