xyz.block.ftl.v1.ControllerServiceClient.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ftl-runtime Show documentation

Towards a 𝝺-calculus for large-scale systems

There is a newer version: 0.189.0

// Code generated by Wire protocol buffer compiler, do not edit.
// Source: xyz.block.ftl.v1.ControllerService in xyz/block/ftl/v1/ftl.proto
package xyz.block.ftl.v1

import com.squareup.wire.GrpcCall
import com.squareup.wire.GrpcStreamingCall
import com.squareup.wire.Service

public interface ControllerServiceClient : Service {
  /**
   * Ping service for readiness.
   */
  public fun Ping(): GrpcCall

  /**
   * List "processes" running on the cluster.
   */
  public fun ProcessList(): GrpcCall

  public fun Status(): GrpcCall

  /**
   * Get list of artefacts that differ between the server and client.
   */
  public fun GetArtefactDiffs(): GrpcCall

  /**
   * Upload an artefact to the server.
   */
  public fun UploadArtefact(): GrpcCall

  /**
   * Create a deployment.
   */
  public fun CreateDeployment(): GrpcCall

  /**
   * Get the schema and artefact metadata for a deployment.
   */
  public fun GetDeployment(): GrpcCall

  /**
   * Stream deployment artefacts from the server.
   *
   * Each artefact is streamed one after the other as a sequence of max 1MB
   * chunks.
   */
  public fun GetDeploymentArtefacts():
      GrpcStreamingCall

  /**
   * Register a Runner with the Controller.
   *
   * Each runner issue a RegisterRunnerRequest to the ControllerService
   * every 10 seconds to maintain its heartbeat.
   */
  public fun RegisterRunner(): GrpcStreamingCall

  /**
   * Update an existing deployment.
   */
  public fun UpdateDeploy(): GrpcCall

  /**
   * Gradually replace an existing deployment with a new one.
   *
   * If a deployment already exists for the module of the new deployment,
   * it will be scaled down and replaced by the new one.
   */
  public fun ReplaceDeploy(): GrpcCall

  /**
   * Stream logs from a deployment
   */
  public fun StreamDeploymentLogs():
      GrpcStreamingCall

  /**
   * Get the full schema.
   */
  public fun GetSchema(): GrpcCall

  /**
   * Pull schema changes from the Controller.
   *
   * Note that if there are no deployments this will block indefinitely, making it unsuitable for
   * just retrieving the schema. Use GetSchema for that.
   */
  public fun PullSchema(): GrpcStreamingCall
}