@aneoconsultingfr/armonik.api
Version:
gRPC API to interact with ArmoniK built for the web
211 lines (208 loc) • 10.4 kB
text/typescript
import _m0 from 'protobufjs/minimal.js';
declare const protobufPackage = "armonik.api.grpc.v1.tasks";
/** Represents every available field in a task summary. */
declare enum TaskSummaryEnumField {
/** TASK_SUMMARY_ENUM_FIELD_UNSPECIFIED - Unspecified */
TASK_SUMMARY_ENUM_FIELD_UNSPECIFIED = 0,
/** TASK_SUMMARY_ENUM_FIELD_TASK_ID - The task ID. */
TASK_SUMMARY_ENUM_FIELD_TASK_ID = 16,
/** TASK_SUMMARY_ENUM_FIELD_SESSION_ID - The session ID. */
TASK_SUMMARY_ENUM_FIELD_SESSION_ID = 1,
/** TASK_SUMMARY_ENUM_FIELD_OWNER_POD_ID - The owner pod ID. */
TASK_SUMMARY_ENUM_FIELD_OWNER_POD_ID = 9,
/** TASK_SUMMARY_ENUM_FIELD_INITIAL_TASK_ID - The initial task ID. Set when a task is submitted independently of retries. */
TASK_SUMMARY_ENUM_FIELD_INITIAL_TASK_ID = 10,
/** TASK_SUMMARY_ENUM_FIELD_STATUS - The task status. */
TASK_SUMMARY_ENUM_FIELD_STATUS = 2,
/** TASK_SUMMARY_ENUM_FIELD_CREATED_AT - The task creation date. */
TASK_SUMMARY_ENUM_FIELD_CREATED_AT = 3,
/** TASK_SUMMARY_ENUM_FIELD_SUBMITTED_AT - The task submission date. */
TASK_SUMMARY_ENUM_FIELD_SUBMITTED_AT = 11,
/** TASK_SUMMARY_ENUM_FIELD_STARTED_AT - The task start date. */
TASK_SUMMARY_ENUM_FIELD_STARTED_AT = 4,
/** TASK_SUMMARY_ENUM_FIELD_ENDED_AT - The task end date. */
TASK_SUMMARY_ENUM_FIELD_ENDED_AT = 5,
/** TASK_SUMMARY_ENUM_FIELD_CREATION_TO_END_DURATION - The task duration. Between the creation date and the end date. */
TASK_SUMMARY_ENUM_FIELD_CREATION_TO_END_DURATION = 6,
/** TASK_SUMMARY_ENUM_FIELD_PROCESSING_TO_END_DURATION - The task calculated duration. Between the start date and the end date. */
TASK_SUMMARY_ENUM_FIELD_PROCESSING_TO_END_DURATION = 7,
/** TASK_SUMMARY_ENUM_FIELD_RECEIVED_TO_END_DURATION - The task calculated duration. Between the received date and the end date. */
TASK_SUMMARY_ENUM_FIELD_RECEIVED_TO_END_DURATION = 18,
/** TASK_SUMMARY_ENUM_FIELD_POD_TTL - The pod TTL (Time To Live). */
TASK_SUMMARY_ENUM_FIELD_POD_TTL = 12,
/** TASK_SUMMARY_ENUM_FIELD_POD_HOSTNAME - The hostname of the container running the task. */
TASK_SUMMARY_ENUM_FIELD_POD_HOSTNAME = 13,
/** TASK_SUMMARY_ENUM_FIELD_RECEIVED_AT - When the task is received by the agent. */
TASK_SUMMARY_ENUM_FIELD_RECEIVED_AT = 14,
/** TASK_SUMMARY_ENUM_FIELD_ACQUIRED_AT - When the task is acquired by the agent. */
TASK_SUMMARY_ENUM_FIELD_ACQUIRED_AT = 15,
/** TASK_SUMMARY_ENUM_FIELD_PROCESSED_AT - When the task is processed by the agent. */
TASK_SUMMARY_ENUM_FIELD_PROCESSED_AT = 17,
/** TASK_SUMMARY_ENUM_FIELD_ERROR - The error message. Only set if task have failed. */
TASK_SUMMARY_ENUM_FIELD_ERROR = 8,
/** TASK_SUMMARY_ENUM_FIELD_FETCHED_AT - When task data are fetched by the agent. */
TASK_SUMMARY_ENUM_FIELD_FETCHED_AT = 19,
/** TASK_SUMMARY_ENUM_FIELD_PAYLOAD_ID - The ID of the Result that is used as a payload for this task. */
TASK_SUMMARY_ENUM_FIELD_PAYLOAD_ID = 20,
/** TASK_SUMMARY_ENUM_FIELD_CREATED_BY - The ID of the Result that is used as a payload for this task. */
TASK_SUMMARY_ENUM_FIELD_CREATED_BY = 21,
UNRECOGNIZED = -1
}
declare function taskSummaryEnumFieldFromJSON(object: any): TaskSummaryEnumField;
declare function taskSummaryEnumFieldToJSON(object: TaskSummaryEnumField): string;
/** Represents a field in a task option. */
declare enum TaskOptionEnumField {
TASK_OPTION_ENUM_FIELD_UNSPECIFIED = 0,
TASK_OPTION_ENUM_FIELD_MAX_DURATION = 1,
TASK_OPTION_ENUM_FIELD_MAX_RETRIES = 2,
TASK_OPTION_ENUM_FIELD_PRIORITY = 3,
TASK_OPTION_ENUM_FIELD_PARTITION_ID = 4,
TASK_OPTION_ENUM_FIELD_APPLICATION_NAME = 5,
TASK_OPTION_ENUM_FIELD_APPLICATION_VERSION = 6,
TASK_OPTION_ENUM_FIELD_APPLICATION_NAMESPACE = 7,
TASK_OPTION_ENUM_FIELD_APPLICATION_SERVICE = 8,
TASK_OPTION_ENUM_FIELD_ENGINE_TYPE = 9,
UNRECOGNIZED = -1
}
declare function taskOptionEnumFieldFromJSON(object: any): TaskOptionEnumField;
declare function taskOptionEnumFieldToJSON(object: TaskOptionEnumField): string;
/** This message is used to wrap the enum in order to facilitate the 'oneOf' generation. */
interface TaskSummaryField {
field: TaskSummaryEnumField;
}
declare const TaskSummaryField: {
encode(message: TaskSummaryField, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TaskSummaryField;
fromJSON(object: any): TaskSummaryField;
toJSON(message: TaskSummaryField): unknown;
create<I extends {
field?: TaskSummaryEnumField | undefined;
} & {
field?: TaskSummaryEnumField | undefined;
} & { [K in Exclude<keyof I, "field">]: never; }>(base?: I | undefined): TaskSummaryField;
fromPartial<I_1 extends {
field?: TaskSummaryEnumField | undefined;
} & {
field?: TaskSummaryEnumField | undefined;
} & { [K_1 in Exclude<keyof I_1, "field">]: never; }>(object: I_1): TaskSummaryField;
};
/** This message is used to wrap the enum in order to facilitate the 'oneOf' generation. */
interface TaskOptionField {
field: TaskOptionEnumField;
}
declare const TaskOptionField: {
encode(message: TaskOptionField, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TaskOptionField;
fromJSON(object: any): TaskOptionField;
toJSON(message: TaskOptionField): unknown;
create<I extends {
field?: TaskOptionEnumField | undefined;
} & {
field?: TaskOptionEnumField | undefined;
} & { [K in Exclude<keyof I, "field">]: never; }>(base?: I | undefined): TaskOptionField;
fromPartial<I_1 extends {
field?: TaskOptionEnumField | undefined;
} & {
field?: TaskOptionEnumField | undefined;
} & { [K_1 in Exclude<keyof I_1, "field">]: never; }>(object: I_1): TaskOptionField;
};
/** Represents a generic field in a task option. */
interface TaskOptionGenericField {
/** The generic field. */
field: string;
}
declare const TaskOptionGenericField: {
encode(message: TaskOptionGenericField, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TaskOptionGenericField;
fromJSON(object: any): TaskOptionGenericField;
toJSON(message: TaskOptionGenericField): unknown;
create<I extends {
field?: string | undefined;
} & {
field?: string | undefined;
} & { [K in Exclude<keyof I, "field">]: never; }>(base?: I | undefined): TaskOptionGenericField;
fromPartial<I_1 extends {
field?: string | undefined;
} & {
field?: string | undefined;
} & { [K_1 in Exclude<keyof I_1, "field">]: never; }>(object: I_1): TaskOptionGenericField;
};
interface TaskField {
/** The task summary field. */
taskSummaryField?: TaskSummaryField | undefined;
/** The task option field. */
taskOptionField?: TaskOptionField | undefined;
/** The task option generic field. */
taskOptionGenericField?: TaskOptionGenericField | undefined;
}
declare const TaskField: {
encode(message: TaskField, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TaskField;
fromJSON(object: any): TaskField;
toJSON(message: TaskField): unknown;
create<I extends {
taskSummaryField?: {
field?: TaskSummaryEnumField | undefined;
} | undefined;
taskOptionField?: {
field?: TaskOptionEnumField | undefined;
} | undefined;
taskOptionGenericField?: {
field?: string | undefined;
} | undefined;
} & {
taskSummaryField?: ({
field?: TaskSummaryEnumField | undefined;
} & {
field?: TaskSummaryEnumField | undefined;
} & { [K in Exclude<keyof I["taskSummaryField"], "field">]: never; }) | undefined;
taskOptionField?: ({
field?: TaskOptionEnumField | undefined;
} & {
field?: TaskOptionEnumField | undefined;
} & { [K_1 in Exclude<keyof I["taskOptionField"], "field">]: never; }) | undefined;
taskOptionGenericField?: ({
field?: string | undefined;
} & {
field?: string | undefined;
} & { [K_2 in Exclude<keyof I["taskOptionGenericField"], "field">]: never; }) | undefined;
} & { [K_3 in Exclude<keyof I, keyof TaskField>]: never; }>(base?: I | undefined): TaskField;
fromPartial<I_1 extends {
taskSummaryField?: {
field?: TaskSummaryEnumField | undefined;
} | undefined;
taskOptionField?: {
field?: TaskOptionEnumField | undefined;
} | undefined;
taskOptionGenericField?: {
field?: string | undefined;
} | undefined;
} & {
taskSummaryField?: ({
field?: TaskSummaryEnumField | undefined;
} & {
field?: TaskSummaryEnumField | undefined;
} & { [K_4 in Exclude<keyof I_1["taskSummaryField"], "field">]: never; }) | undefined;
taskOptionField?: ({
field?: TaskOptionEnumField | undefined;
} & {
field?: TaskOptionEnumField | undefined;
} & { [K_5 in Exclude<keyof I_1["taskOptionField"], "field">]: never; }) | undefined;
taskOptionGenericField?: ({
field?: string | undefined;
} & {
field?: string | undefined;
} & { [K_6 in Exclude<keyof I_1["taskOptionGenericField"], "field">]: never; }) | undefined;
} & { [K_7 in Exclude<keyof I_1, keyof TaskField>]: never; }>(object: I_1): TaskField;
};
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
[K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
type KeysOfUnion<T> = T extends T ? keyof T : never;
type Exact<P, I extends P> = P extends Builtin ? P : P & {
[K in keyof P]: Exact<P[K], I[K]>;
} & {
[K in Exclude<keyof I, KeysOfUnion<P>>]: never;
};
export { DeepPartial, Exact, TaskField, TaskOptionEnumField, TaskOptionField, TaskOptionGenericField, TaskSummaryEnumField, TaskSummaryField, protobufPackage, taskOptionEnumFieldFromJSON, taskOptionEnumFieldToJSON, taskSummaryEnumFieldFromJSON, taskSummaryEnumFieldToJSON };