add endpoint for cancelling job run (#217)

Author: ianedwards

generated/go/porter/v1/cluster_control_plane.pb.go

@@ -4219,6 +4219,72 @@ export declare class ManualServiceRunRequest extends Message<ManualServiceRunReq
   static equals(a: ManualServiceRunRequest | PlainMessage<ManualServiceRunRequest> | undefined, b: ManualServiceRunRequest | PlainMessage<ManualServiceRunRequest> | undefined): boolean;
 }
 
+/**
+ * CancelJobRunRequest is the request object for CancelJobRun
+ *
+ * @generated from message porter.v1.CancelJobRunRequest
+ */
+export declare class CancelJobRunRequest extends Message<CancelJobRunRequest> {
+  /**
+   * @generated from field: int64 project_id = 1;
+   */
+  projectId: bigint;
+
+  /**
+   * @generated from field: int64 cluster_id = 2;
+   */
+  clusterId: bigint;
+
+  /**
+   * deployment_target_identifier is the object that identifies the deployment target for the job run
+   *
+   * @generated from field: porter.v1.DeploymentTargetIdentifier deployment_target_identifier = 3;
+   */
+  deploymentTargetIdentifier?: DeploymentTargetIdentifier;
+
+  /**
+   * job_run_name is the name of the job run to cancel
+   *
+   * @generated from field: string job_run_name = 4;
+   */
+  jobRunName: string;
+
+  constructor(data?: PartialMessage<CancelJobRunRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "porter.v1.CancelJobRunRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): CancelJobRunRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): CancelJobRunRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): CancelJobRunRequest;
+
+  static equals(a: CancelJobRunRequest | PlainMessage<CancelJobRunRequest> | undefined, b: CancelJobRunRequest | PlainMessage<CancelJobRunRequest> | undefined): boolean;
+}
+
+/**
+ * CancelJobRunResponse is the response object for CancelJobRun
+ *
+ * @generated from message porter.v1.CancelJobRunResponse
+ */
+export declare class CancelJobRunResponse extends Message<CancelJobRunResponse> {
+  constructor(data?: PartialMessage<CancelJobRunResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "porter.v1.CancelJobRunResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): CancelJobRunResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): CancelJobRunResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): CancelJobRunResponse;
+
+  static equals(a: CancelJobRunResponse | PlainMessage<CancelJobRunResponse> | undefined, b: CancelJobRunResponse | PlainMessage<CancelJobRunResponse> | undefined): boolean;
+}
+
 /**
  * ManualServiceRunResponse is the response object for ManualServiceRun
  *

generated/go/porter/v1/porter_app.pb.go

@@ -1415,6 +1415,31 @@ export const ManualServiceRunRequest = /*@__PURE__*/ proto3.makeMessageType(
   ],
 );
 
+/**
+ * CancelJobRunRequest is the request object for CancelJobRun
+ *
+ * @generated from message porter.v1.CancelJobRunRequest
+ */
+export const CancelJobRunRequest = /*@__PURE__*/ proto3.makeMessageType(
+  "porter.v1.CancelJobRunRequest",
+  () => [
+    { no: 1, name: "project_id", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 2, name: "cluster_id", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 3, name: "deployment_target_identifier", kind: "message", T: DeploymentTargetIdentifier },
+    { no: 4, name: "job_run_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ],
+);
+
+/**
+ * CancelJobRunResponse is the response object for CancelJobRun
+ *
+ * @generated from message porter.v1.CancelJobRunResponse
+ */
+export const CancelJobRunResponse = /*@__PURE__*/ proto3.makeMessageType(
+  "porter.v1.CancelJobRunResponse",
+  [],
+);
+
 /**
  * ManualServiceRunResponse is the response object for ManualServiceRun
  *

generated/go/porter/v1/porterv1connect/cluster_control_plane.connect.go

@@ -104,6 +104,11 @@ export declare enum EnumJobRunStatus {
    * @generated from enum value: ENUM_JOB_RUN_STATUS_FAILED = 3;
    */
   FAILED = 3,
+
+  /**
+   * @generated from enum value: ENUM_JOB_RUN_STATUS_CANCELED = 4;
+   */
+  CANCELED = 4,
 }
 
 /**

generated/js/src/porter/v1/cluster_control_plane_pb.d.ts

@@ -62,6 +62,7 @@ export const EnumJobRunStatus = /*@__PURE__*/ proto3.makeEnum(
     {no: 1, name: "ENUM_JOB_RUN_STATUS_RUNNING", localName: "RUNNING"},
     {no: 2, name: "ENUM_JOB_RUN_STATUS_SUCCESSFUL", localName: "SUCCESSFUL"},
     {no: 3, name: "ENUM_JOB_RUN_STATUS_FAILED", localName: "FAILED"},
+    {no: 4, name: "ENUM_JOB_RUN_STATUS_CANCELED", localName: "CANCELED"},
   ],
 );
 

generated/js/src/porter/v1/cluster_control_plane_pb.js

@@ -936,6 +936,19 @@ message ManualServiceRunRequest {
   AppImage image = 7;
 }
 
+// CancelJobRunRequest is the request object for CancelJobRun
+message CancelJobRunRequest {
+  int64 project_id = 1;
+  int64 cluster_id = 2;
+  // deployment_target_identifier is the object that identifies the deployment target for the job run
+  DeploymentTargetIdentifier deployment_target_identifier = 3;
+  // job_run_name is the name of the job run to cancel
+  string job_run_name = 4;
+}
+
+// CancelJobRunResponse is the response object for CancelJobRun
+message CancelJobRunResponse {}
+
 // ManualServiceRunResponse is the response object for ManualServiceRun
 message ManualServiceRunResponse {
   // job_run_id is the id of the job run that was created, if any
@@ -1494,6 +1507,9 @@ service ClusterControlPlaneService {
   // and runs the provided command, or if no command is provided, runs the command defined for the service.
   rpc ManualServiceRun(ManualServiceRunRequest) returns (ManualServiceRunResponse) {}
 
+  // CancelJobRun cancels a job run for a given app and job service in the provided deployment target
+  rpc CancelJobRun(CancelJobRunRequest) returns (CancelJobRunResponse) {}
+
   // JobRunStatus returns the status of a given job run
   rpc JobRunStatus(JobRunStatusRequest) returns (JobRunStatusResponse) {}
 

generated/js/src/porter/v1/porter_app_pb.d.ts

@@ -231,6 +231,7 @@ enum EnumJobRunStatus {
   ENUM_JOB_RUN_STATUS_RUNNING = 1;
   ENUM_JOB_RUN_STATUS_SUCCESSFUL = 2;
   ENUM_JOB_RUN_STATUS_FAILED = 3;
+  ENUM_JOB_RUN_STATUS_CANCELED = 4;
 }
 
 // JobRun contains details about a job run