@aneoconsultingfr/armonik.api
Version:
gRPC API to interact with ArmoniK built for the web
580 lines (577 loc) • 25.6 kB
text/typescript
import { Filters, FilterField } from './applications_filters.mjs';
import { FilterStringOperator, FilterString } from './filters_common.mjs';
import { ApplicationRawEnumField, ApplicationField } from './applications_fields.mjs';
import _m0 from 'protobufjs/minimal.js';
import { SortDirection } from './sort_direction.mjs';
import './google/protobuf/duration.mjs';
declare const protobufPackage = "armonik.api.grpc.v1.applications";
/** Messages describing applications and associated requests and responses. */
/**
* A raw application object.
*
* Used when a list of applications is requested.
*/
interface ApplicationRaw {
/** Application name. */
name: string;
/** Application version. */
version: string;
/** Application namespace used in the excecuted class. */
namespace: string;
/** Application service used in the excecuted class. */
service: string;
}
declare const ApplicationRaw: {
encode(message: ApplicationRaw, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ApplicationRaw;
fromJSON(object: any): ApplicationRaw;
toJSON(message: ApplicationRaw): unknown;
create<I extends {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & { [K in Exclude<keyof I, keyof ApplicationRaw>]: never; }>(base?: I | undefined): ApplicationRaw;
fromPartial<I_1 extends {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & { [K_1 in Exclude<keyof I_1, keyof ApplicationRaw>]: never; }>(object: I_1): ApplicationRaw;
};
/**
* Request to list applications.
*
* Use pagination, filtering and sorting.
*/
interface ListApplicationsRequest {
/** The page number. Start at 0. */
page: number;
/** Number of items per page. */
pageSize: number;
/** The filters. */
filters: Filters | undefined;
/**
* The sort.
*
* Must be set for every request.
*/
sort: ListApplicationsRequest_Sort | undefined;
}
declare const ListApplicationsRequest: {
encode(message: ListApplicationsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ListApplicationsRequest;
fromJSON(object: any): ListApplicationsRequest;
toJSON(message: ListApplicationsRequest): unknown;
create<I extends {
page?: number | undefined;
pageSize?: number | undefined;
filters?: {
or?: {
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[] | undefined;
} | undefined;
sort?: {
fields?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] | undefined;
direction?: SortDirection | undefined;
} | undefined;
} & {
page?: number | undefined;
pageSize?: number | undefined;
filters?: ({
or?: {
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[] | undefined;
} & {
or?: ({
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[] & ({
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
} & {
and?: ({
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] & ({
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
} & {
field?: ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} & {
applicationField?: ({
field?: ApplicationRawEnumField | undefined;
} & {
field?: ApplicationRawEnumField | undefined;
} & { [K in Exclude<keyof I["filters"]["or"][number]["and"][number]["field"]["applicationField"], "field">]: never; }) | undefined;
} & { [K_1 in Exclude<keyof I["filters"]["or"][number]["and"][number]["field"], "applicationField">]: never; }) | undefined;
filterString?: ({
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} & {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} & { [K_2 in Exclude<keyof I["filters"]["or"][number]["and"][number]["filterString"], keyof FilterString>]: never; }) | undefined;
} & { [K_3 in Exclude<keyof I["filters"]["or"][number]["and"][number], keyof FilterField>]: never; })[] & { [K_4 in Exclude<keyof I["filters"]["or"][number]["and"], keyof {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[]>]: never; }) | undefined;
} & { [K_5 in Exclude<keyof I["filters"]["or"][number], "and">]: never; })[] & { [K_6 in Exclude<keyof I["filters"]["or"], keyof {
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[]>]: never; }) | undefined;
} & { [K_7 in Exclude<keyof I["filters"], "or">]: never; }) | undefined;
sort?: ({
fields?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] | undefined;
direction?: SortDirection | undefined;
} & {
fields?: ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] & ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} & {
applicationField?: ({
field?: ApplicationRawEnumField | undefined;
} & {
field?: ApplicationRawEnumField | undefined;
} & { [K_8 in Exclude<keyof I["sort"]["fields"][number]["applicationField"], "field">]: never; }) | undefined;
} & { [K_9 in Exclude<keyof I["sort"]["fields"][number], "applicationField">]: never; })[] & { [K_10 in Exclude<keyof I["sort"]["fields"], keyof {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[]>]: never; }) | undefined;
direction?: SortDirection | undefined;
} & { [K_11 in Exclude<keyof I["sort"], keyof ListApplicationsRequest_Sort>]: never; }) | undefined;
} & { [K_12 in Exclude<keyof I, keyof ListApplicationsRequest>]: never; }>(base?: I | undefined): ListApplicationsRequest;
fromPartial<I_1 extends {
page?: number | undefined;
pageSize?: number | undefined;
filters?: {
or?: {
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[] | undefined;
} | undefined;
sort?: {
fields?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] | undefined;
direction?: SortDirection | undefined;
} | undefined;
} & {
page?: number | undefined;
pageSize?: number | undefined;
filters?: ({
or?: {
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[] | undefined;
} & {
or?: ({
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[] & ({
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
} & {
and?: ({
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] & ({
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
} & {
field?: ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} & {
applicationField?: ({
field?: ApplicationRawEnumField | undefined;
} & {
field?: ApplicationRawEnumField | undefined;
} & { [K_13 in Exclude<keyof I_1["filters"]["or"][number]["and"][number]["field"]["applicationField"], "field">]: never; }) | undefined;
} & { [K_14 in Exclude<keyof I_1["filters"]["or"][number]["and"][number]["field"], "applicationField">]: never; }) | undefined;
filterString?: ({
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} & {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} & { [K_15 in Exclude<keyof I_1["filters"]["or"][number]["and"][number]["filterString"], keyof FilterString>]: never; }) | undefined;
} & { [K_16 in Exclude<keyof I_1["filters"]["or"][number]["and"][number], keyof FilterField>]: never; })[] & { [K_17 in Exclude<keyof I_1["filters"]["or"][number]["and"], keyof {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[]>]: never; }) | undefined;
} & { [K_18 in Exclude<keyof I_1["filters"]["or"][number], "and">]: never; })[] & { [K_19 in Exclude<keyof I_1["filters"]["or"], keyof {
and?: {
field?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} | undefined;
filterString?: {
value?: string | undefined;
operator?: FilterStringOperator | undefined;
} | undefined;
}[] | undefined;
}[]>]: never; }) | undefined;
} & { [K_20 in Exclude<keyof I_1["filters"], "or">]: never; }) | undefined;
sort?: ({
fields?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] | undefined;
direction?: SortDirection | undefined;
} & {
fields?: ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] & ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} & {
applicationField?: ({
field?: ApplicationRawEnumField | undefined;
} & {
field?: ApplicationRawEnumField | undefined;
} & { [K_21 in Exclude<keyof I_1["sort"]["fields"][number]["applicationField"], "field">]: never; }) | undefined;
} & { [K_22 in Exclude<keyof I_1["sort"]["fields"][number], "applicationField">]: never; })[] & { [K_23 in Exclude<keyof I_1["sort"]["fields"], keyof {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[]>]: never; }) | undefined;
direction?: SortDirection | undefined;
} & { [K_24 in Exclude<keyof I_1["sort"], keyof ListApplicationsRequest_Sort>]: never; }) | undefined;
} & { [K_25 in Exclude<keyof I_1, keyof ListApplicationsRequest>]: never; }>(object: I_1): ListApplicationsRequest;
};
/** Represents the sort object. */
interface ListApplicationsRequest_Sort {
/** Fields to order by. */
fields: ApplicationField[];
/** The order direction. */
direction: SortDirection;
}
declare const ListApplicationsRequest_Sort: {
encode(message: ListApplicationsRequest_Sort, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ListApplicationsRequest_Sort;
fromJSON(object: any): ListApplicationsRequest_Sort;
toJSON(message: ListApplicationsRequest_Sort): unknown;
create<I extends {
fields?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] | undefined;
direction?: SortDirection | undefined;
} & {
fields?: ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] & ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} & {
applicationField?: ({
field?: ApplicationRawEnumField | undefined;
} & {
field?: ApplicationRawEnumField | undefined;
} & { [K in Exclude<keyof I["fields"][number]["applicationField"], "field">]: never; }) | undefined;
} & { [K_1 in Exclude<keyof I["fields"][number], "applicationField">]: never; })[] & { [K_2 in Exclude<keyof I["fields"], keyof {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[]>]: never; }) | undefined;
direction?: SortDirection | undefined;
} & { [K_3 in Exclude<keyof I, keyof ListApplicationsRequest_Sort>]: never; }>(base?: I | undefined): ListApplicationsRequest_Sort;
fromPartial<I_1 extends {
fields?: {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] | undefined;
direction?: SortDirection | undefined;
} & {
fields?: ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[] & ({
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
} & {
applicationField?: ({
field?: ApplicationRawEnumField | undefined;
} & {
field?: ApplicationRawEnumField | undefined;
} & { [K_4 in Exclude<keyof I_1["fields"][number]["applicationField"], "field">]: never; }) | undefined;
} & { [K_5 in Exclude<keyof I_1["fields"][number], "applicationField">]: never; })[] & { [K_6 in Exclude<keyof I_1["fields"], keyof {
applicationField?: {
field?: ApplicationRawEnumField | undefined;
} | undefined;
}[]>]: never; }) | undefined;
direction?: SortDirection | undefined;
} & { [K_7 in Exclude<keyof I_1, keyof ListApplicationsRequest_Sort>]: never; }>(object: I_1): ListApplicationsRequest_Sort;
};
/**
* Response to list applications.
*
* Use pagination, filtering and sorting from the request.
* Return a list of raw applications.
*/
interface ListApplicationsResponse {
applications: ApplicationRaw[];
/** The current page. Start at 0. */
page: number;
/** Number of items per page. */
pageSize: number;
/** Total number of items. */
total: number;
}
declare const ListApplicationsResponse: {
encode(message: ListApplicationsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ListApplicationsResponse;
fromJSON(object: any): ListApplicationsResponse;
toJSON(message: ListApplicationsResponse): unknown;
create<I extends {
applications?: {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
}[] | undefined;
page?: number | undefined;
pageSize?: number | undefined;
total?: number | undefined;
} & {
applications?: ({
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
}[] & ({
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & { [K in Exclude<keyof I["applications"][number], keyof ApplicationRaw>]: never; })[] & { [K_1 in Exclude<keyof I["applications"], keyof {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
}[]>]: never; }) | undefined;
page?: number | undefined;
pageSize?: number | undefined;
total?: number | undefined;
} & { [K_2 in Exclude<keyof I, keyof ListApplicationsResponse>]: never; }>(base?: I | undefined): ListApplicationsResponse;
fromPartial<I_1 extends {
applications?: {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
}[] | undefined;
page?: number | undefined;
pageSize?: number | undefined;
total?: number | undefined;
} & {
applications?: ({
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
}[] & ({
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
} & { [K_3 in Exclude<keyof I_1["applications"][number], keyof ApplicationRaw>]: never; })[] & { [K_4 in Exclude<keyof I_1["applications"], keyof {
name?: string | undefined;
version?: string | undefined;
namespace?: string | undefined;
service?: string | undefined;
}[]>]: never; }) | undefined;
page?: number | undefined;
pageSize?: number | undefined;
total?: number | undefined;
} & { [K_5 in Exclude<keyof I_1, keyof ListApplicationsResponse>]: never; }>(object: I_1): ListApplicationsResponse;
};
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 { ApplicationRaw, DeepPartial, Exact, ListApplicationsRequest, ListApplicationsRequest_Sort, ListApplicationsResponse, protobufPackage };