Package com.buildless.service.v1

Interface ProjectsGrpc.AsyncService

All Known Implementing Classes:
ProjectsGrpc.ProjectsImplBase
Enclosing class:
ProjectsGrpc
public static interface ProjectsGrpc.AsyncService
 Defines the API surface for the Buildless Projects service.

  • Method Details

    • listProjects

      default void listProjects(ListProjectsRequest request, io.grpc.stub.StreamObserver<ListProjectsResponse> responseObserver)
       ## List Projects
 Retrieve a list of projects accessible to the authenticated user; this endpoint will list projects based on the
 current account scope and effective set of applicable policies or permissions.

    • fetchProject

      default void fetchProject(ProjectFetchRequest request, io.grpc.stub.StreamObserver<ProjectFetchResponse> responseObserver)
       ## Fetch Project
 Retrieve a project by its assigned name or key; if the project cannot be found, return a `NOT_FOUND` error instead.
 This endpoint returns the full suite of information available for a project.

    • newProjectNameCheck

      default void newProjectNameCheck(ProjectCheckNameRequest request, io.grpc.stub.StreamObserver<ProjectCheckNameResponse> responseObserver)
       ## Create Project: Check Name
 Check uniqueness of a name nominated for use with a new project. This endpoint returns a `CONFLICT` error if the
 name is already in use. Names obtained via the name generator can be used without additional checks.

    • newProjectNameGenerate

      default void newProjectNameGenerate(ProjectGenerateNameRequest request, io.grpc.stub.StreamObserver<ProjectGenerateNameResponse> responseObserver)
       ## Create Project: Generate Name
 Generate another name for use with a new Buildless project. This method is only employed if the first name provided
 by creation advice is rejected by the user.

    • newProjectAdvice

      default void newProjectAdvice(ProjectCreateAdviceRequest request, io.grpc.stub.StreamObserver<ProjectCreateAdviceResponse> responseObserver)
       ## Create Project: Advice
 Obtain server-provided advice during a project creation workflow; this includes the scopes to which the user has
 access to create projects, their quota status, and other information which can be used to inform the user during
 scope selection and project setup.

    • createProject

      default void createProject(CreateProjectRequest request, io.grpc.stub.StreamObserver<CreateProjectResponse> responseObserver)
       ## Create Project
 Create a new Buildless cache project from scratch. The `dry` flag can be provided to execute a verification run
 instead of actually creating the underlying record. Once created, a finished record is returned, with an assigned
 key and other metadata.

    • updateProjectSettings

      default void updateProjectSettings(UpdateProjectSettingsRequest request, io.grpc.stub.StreamObserver<UpdateProjectSettingsResponse> responseObserver)
       ## Update Project Settings
 Update the settings for a project, including, potentially, its visibility mode, isolation mode, and other metadata.
 This endpoint expects either delta record which only contains the updates to apply; before applying such updates,
 the project settings are fetched in a transaction.

    • projectArchive

      default void projectArchive(ProjectArchiveRequest request, io.grpc.stub.StreamObserver<ProjectArchiveResponse> responseObserver)
       ## Archive Project
 Archive a project, which will prevent it from being used for new data, but will not delete the underlying data.

    • projectDelete

      default void projectDelete(ProjectDeleteRequest request, io.grpc.stub.StreamObserver<ProjectDeleteResponse> responseObserver)
       ## Delete Project
 Marks a project for soft-deletion. To be eligible for deletion, a project must already be in an archived state.