@toshicloud/sdk 0.3.0 → 0.3.2

package/dist/gen/toshi/workspace/v1/storage_providers_pb.d.ts

@@ -0,0 +1,717 @@
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file toshi/workspace/v1/storage_providers.proto.
+ */
+export declare const file_toshi_workspace_v1_storage_providers: GenFile;
+/**
+ * StorageProvider is one bucket Toshi keeps the workspace's objects in.
+ *
+ * @generated from message toshi.workspace.v1.StorageProvider
+ */
+export type StorageProvider = Message<"toshi.workspace.v1.StorageProvider"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name: string;
+    /**
+     * "operator", "tenant_bucket" or "local_disk".
+     *
+     * @generated from field: string mode = 3;
+     */
+    mode: string;
+    /**
+     * @generated from field: string endpoint = 4;
+     */
+    endpoint: string;
+    /**
+     * @generated from field: string region = 5;
+     */
+    region: string;
+    /**
+     * @generated from field: string bucket = 6;
+     */
+    bucket: string;
+    /**
+     * @generated from field: string root_prefix = 7;
+     */
+    rootPrefix: string;
+    /**
+     * @generated from field: bool path_style = 8;
+     */
+    pathStyle: boolean;
+    /**
+     * @generated from field: bool cap_lifecycle = 9;
+     */
+    capLifecycle: boolean;
+    /**
+     * @generated from field: bool cap_guest_presign = 10;
+     */
+    capGuestPresign: boolean;
+    /**
+     * @generated from field: bool cap_global_replication = 11;
+     */
+    capGlobalReplication: boolean;
+    /**
+     * @generated from field: int64 egress_price_micros_per_gb = 12;
+     */
+    egressPriceMicrosPerGb: bigint;
+    /**
+     * Whether the row holds a wrapped key; its value is never sent.
+     *
+     * @generated from field: bool credentials_wrapped = 13;
+     */
+    credentialsWrapped: boolean;
+    /**
+     * @generated from field: google.protobuf.Timestamp last_check_at = 14;
+     */
+    lastCheckAt?: Timestamp | undefined;
+    /**
+     * Why the last check failed. For a row the operator set, which may name
+     * the operator's own references, only that it failed.
+     *
+     * @generated from field: string last_check_error = 15;
+     */
+    lastCheckError: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 16;
+     */
+    createdAt?: Timestamp | undefined;
+    /**
+     * @generated from field: google.protobuf.Timestamp updated_at = 17;
+     */
+    updatedAt?: Timestamp | undefined;
+};
+/**
+ * StorageProvider is one bucket Toshi keeps the workspace's objects in.
+ *
+ * @generated from message toshi.workspace.v1.StorageProvider
+ */
+export type StorageProviderJson = {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name?: string;
+    /**
+     * "operator", "tenant_bucket" or "local_disk".
+     *
+     * @generated from field: string mode = 3;
+     */
+    mode?: string;
+    /**
+     * @generated from field: string endpoint = 4;
+     */
+    endpoint?: string;
+    /**
+     * @generated from field: string region = 5;
+     */
+    region?: string;
+    /**
+     * @generated from field: string bucket = 6;
+     */
+    bucket?: string;
+    /**
+     * @generated from field: string root_prefix = 7;
+     */
+    rootPrefix?: string;
+    /**
+     * @generated from field: bool path_style = 8;
+     */
+    pathStyle?: boolean;
+    /**
+     * @generated from field: bool cap_lifecycle = 9;
+     */
+    capLifecycle?: boolean;
+    /**
+     * @generated from field: bool cap_guest_presign = 10;
+     */
+    capGuestPresign?: boolean;
+    /**
+     * @generated from field: bool cap_global_replication = 11;
+     */
+    capGlobalReplication?: boolean;
+    /**
+     * @generated from field: int64 egress_price_micros_per_gb = 12;
+     */
+    egressPriceMicrosPerGb?: string;
+    /**
+     * Whether the row holds a wrapped key; its value is never sent.
+     *
+     * @generated from field: bool credentials_wrapped = 13;
+     */
+    credentialsWrapped?: boolean;
+    /**
+     * @generated from field: google.protobuf.Timestamp last_check_at = 14;
+     */
+    lastCheckAt?: TimestampJson;
+    /**
+     * Why the last check failed. For a row the operator set, which may name
+     * the operator's own references, only that it failed.
+     *
+     * @generated from field: string last_check_error = 15;
+     */
+    lastCheckError?: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 16;
+     */
+    createdAt?: TimestampJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp updated_at = 17;
+     */
+    updatedAt?: TimestampJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.StorageProvider.
+ * Use `create(StorageProviderSchema)` to create a new message.
+ */
+export declare const StorageProviderSchema: GenMessage<StorageProvider, {
+    jsonType: StorageProviderJson;
+}>;
+/**
+ * CreateStorageProviderRequest describes the workspace's own bucket.
+ *
+ * @generated from message toshi.workspace.v1.CreateStorageProviderRequest
+ */
+export type CreateStorageProviderRequest = Message<"toshi.workspace.v1.CreateStorageProviderRequest"> & {
+    /**
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     * An https URL.
+     *
+     * @generated from field: string endpoint = 2;
+     */
+    endpoint: string;
+    /**
+     * @generated from field: string region = 3;
+     */
+    region: string;
+    /**
+     * @generated from field: string bucket = 4;
+     */
+    bucket: string;
+    /**
+     * @generated from field: string root_prefix = 5;
+     */
+    rootPrefix: string;
+    /**
+     * @generated from field: bool path_style = 6;
+     */
+    pathStyle: boolean;
+    /**
+     * @generated from field: bool cap_lifecycle = 7;
+     */
+    capLifecycle: boolean;
+    /**
+     * @generated from field: bool cap_guest_presign = 8;
+     */
+    capGuestPresign: boolean;
+    /**
+     * The bucket's key. The control plane wraps it before the row exists and
+     * never returns, logs or audits it. Required.
+     *
+     * @generated from field: toshi.workspace.v1.StorageCredential credential = 9;
+     */
+    credential?: StorageCredential | undefined;
+    /**
+     * "tenant_bucket", the only mode a workspace stores; empty means it.
+     * Another mode fails with INVALID_ARGUMENT.
+     *
+     * @generated from field: string mode = 10;
+     */
+    mode: string;
+};
+/**
+ * CreateStorageProviderRequest describes the workspace's own bucket.
+ *
+ * @generated from message toshi.workspace.v1.CreateStorageProviderRequest
+ */
+export type CreateStorageProviderRequestJson = {
+    /**
+     * @generated from field: string name = 1;
+     */
+    name?: string;
+    /**
+     * An https URL.
+     *
+     * @generated from field: string endpoint = 2;
+     */
+    endpoint?: string;
+    /**
+     * @generated from field: string region = 3;
+     */
+    region?: string;
+    /**
+     * @generated from field: string bucket = 4;
+     */
+    bucket?: string;
+    /**
+     * @generated from field: string root_prefix = 5;
+     */
+    rootPrefix?: string;
+    /**
+     * @generated from field: bool path_style = 6;
+     */
+    pathStyle?: boolean;
+    /**
+     * @generated from field: bool cap_lifecycle = 7;
+     */
+    capLifecycle?: boolean;
+    /**
+     * @generated from field: bool cap_guest_presign = 8;
+     */
+    capGuestPresign?: boolean;
+    /**
+     * The bucket's key. The control plane wraps it before the row exists and
+     * never returns, logs or audits it. Required.
+     *
+     * @generated from field: toshi.workspace.v1.StorageCredential credential = 9;
+     */
+    credential?: StorageCredentialJson;
+    /**
+     * "tenant_bucket", the only mode a workspace stores; empty means it.
+     * Another mode fails with INVALID_ARGUMENT.
+     *
+     * @generated from field: string mode = 10;
+     */
+    mode?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.CreateStorageProviderRequest.
+ * Use `create(CreateStorageProviderRequestSchema)` to create a new message.
+ */
+export declare const CreateStorageProviderRequestSchema: GenMessage<CreateStorageProviderRequest, {
+    jsonType: CreateStorageProviderRequestJson;
+}>;
+/**
+ * StorageCredential is an S3 access key. It is write-only: no response
+ * carries it.
+ *
+ * @generated from message toshi.workspace.v1.StorageCredential
+ */
+export type StorageCredential = Message<"toshi.workspace.v1.StorageCredential"> & {
+    /**
+     * @generated from field: string access_key_id = 1;
+     */
+    accessKeyId: string;
+    /**
+     * @generated from field: string secret_access_key = 2;
+     */
+    secretAccessKey: string;
+    /**
+     * Set for a temporary key.
+     *
+     * @generated from field: string session_token = 3;
+     */
+    sessionToken: string;
+};
+/**
+ * StorageCredential is an S3 access key. It is write-only: no response
+ * carries it.
+ *
+ * @generated from message toshi.workspace.v1.StorageCredential
+ */
+export type StorageCredentialJson = {
+    /**
+     * @generated from field: string access_key_id = 1;
+     */
+    accessKeyId?: string;
+    /**
+     * @generated from field: string secret_access_key = 2;
+     */
+    secretAccessKey?: string;
+    /**
+     * Set for a temporary key.
+     *
+     * @generated from field: string session_token = 3;
+     */
+    sessionToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.StorageCredential.
+ * Use `create(StorageCredentialSchema)` to create a new message.
+ */
+export declare const StorageCredentialSchema: GenMessage<StorageCredential, {
+    jsonType: StorageCredentialJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CreateStorageProviderResponse
+ */
+export type CreateStorageProviderResponse = Message<"toshi.workspace.v1.CreateStorageProviderResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.StorageProvider provider = 1;
+     */
+    provider?: StorageProvider | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.CreateStorageProviderResponse
+ */
+export type CreateStorageProviderResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.StorageProvider provider = 1;
+     */
+    provider?: StorageProviderJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.CreateStorageProviderResponse.
+ * Use `create(CreateStorageProviderResponseSchema)` to create a new message.
+ */
+export declare const CreateStorageProviderResponseSchema: GenMessage<CreateStorageProviderResponse, {
+    jsonType: CreateStorageProviderResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListStorageProvidersRequest
+ */
+export type ListStorageProvidersRequest = Message<"toshi.workspace.v1.ListStorageProvidersRequest"> & {
+    /**
+     * Also answer default_provider.
+     *
+     * @generated from field: bool include_default = 1;
+     */
+    includeDefault: boolean;
+    /**
+     * The most providers in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 2;
+     */
+    pageSize: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 3;
+     */
+    pageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListStorageProvidersRequest
+ */
+export type ListStorageProvidersRequestJson = {
+    /**
+     * Also answer default_provider.
+     *
+     * @generated from field: bool include_default = 1;
+     */
+    includeDefault?: boolean;
+    /**
+     * The most providers in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 2;
+     */
+    pageSize?: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 3;
+     */
+    pageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListStorageProvidersRequest.
+ * Use `create(ListStorageProvidersRequestSchema)` to create a new message.
+ */
+export declare const ListStorageProvidersRequestSchema: GenMessage<ListStorageProvidersRequest, {
+    jsonType: ListStorageProvidersRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListStorageProvidersResponse
+ */
+export type ListStorageProvidersResponse = Message<"toshi.workspace.v1.ListStorageProvidersResponse"> & {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.StorageProvider providers = 1;
+     */
+    providers: StorageProvider[];
+    /**
+     * With include_default, the operator's provider that serves the
+     * workspace's uploads while it has no tenant_bucket provider; unset when
+     * none is configured. Every page holds it.
+     *
+     * @generated from field: toshi.workspace.v1.StorageProvider default_provider = 2;
+     */
+    defaultProvider?: StorageProvider | undefined;
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 3;
+     */
+    nextPageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListStorageProvidersResponse
+ */
+export type ListStorageProvidersResponseJson = {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.StorageProvider providers = 1;
+     */
+    providers?: StorageProviderJson[];
+    /**
+     * With include_default, the operator's provider that serves the
+     * workspace's uploads while it has no tenant_bucket provider; unset when
+     * none is configured. Every page holds it.
+     *
+     * @generated from field: toshi.workspace.v1.StorageProvider default_provider = 2;
+     */
+    defaultProvider?: StorageProviderJson;
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 3;
+     */
+    nextPageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListStorageProvidersResponse.
+ * Use `create(ListStorageProvidersResponseSchema)` to create a new message.
+ */
+export declare const ListStorageProvidersResponseSchema: GenMessage<ListStorageProvidersResponse, {
+    jsonType: ListStorageProvidersResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CheckStorageProviderRequest
+ */
+export type CheckStorageProviderRequest = Message<"toshi.workspace.v1.CheckStorageProviderRequest"> & {
+    /**
+     * The provider to check: one is required.
+     *
+     * @generated from oneof toshi.workspace.v1.CheckStorageProviderRequest.target
+     */
+    target: {
+        /**
+         * A saved provider's id.
+         *
+         * @generated from field: string id = 1;
+         */
+        value: string;
+        case: "id";
+    } | {
+        /**
+         * A provider that is not saved, as CreateStorageProvider would take
+         * it, with its key.
+         *
+         * @generated from field: toshi.workspace.v1.CreateStorageProviderRequest provider = 2;
+         */
+        value: CreateStorageProviderRequest;
+        case: "provider";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * @generated from message toshi.workspace.v1.CheckStorageProviderRequest
+ */
+export type CheckStorageProviderRequestJson = {
+    /**
+     * A saved provider's id.
+     *
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * A provider that is not saved, as CreateStorageProvider would take
+     * it, with its key.
+     *
+     * @generated from field: toshi.workspace.v1.CreateStorageProviderRequest provider = 2;
+     */
+    provider?: CreateStorageProviderRequestJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.CheckStorageProviderRequest.
+ * Use `create(CheckStorageProviderRequestSchema)` to create a new message.
+ */
+export declare const CheckStorageProviderRequestSchema: GenMessage<CheckStorageProviderRequest, {
+    jsonType: CheckStorageProviderRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CheckStorageProviderResponse
+ */
+export type CheckStorageProviderResponse = Message<"toshi.workspace.v1.CheckStorageProviderResponse"> & {
+    /**
+     * The saved provider as stored after the check; unset for one that is
+     * not saved.
+     *
+     * @generated from field: toshi.workspace.v1.StorageProvider provider = 1;
+     */
+    provider?: StorageProvider | undefined;
+    /**
+     * Whether every step of the check passed.
+     *
+     * @generated from field: bool ok = 2;
+     */
+    ok: boolean;
+    /**
+     * Why the check failed, naming the step; empty when ok.
+     *
+     * @generated from field: string error = 3;
+     */
+    error: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp checked_at = 4;
+     */
+    checkedAt?: Timestamp | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.CheckStorageProviderResponse
+ */
+export type CheckStorageProviderResponseJson = {
+    /**
+     * The saved provider as stored after the check; unset for one that is
+     * not saved.
+     *
+     * @generated from field: toshi.workspace.v1.StorageProvider provider = 1;
+     */
+    provider?: StorageProviderJson;
+    /**
+     * Whether every step of the check passed.
+     *
+     * @generated from field: bool ok = 2;
+     */
+    ok?: boolean;
+    /**
+     * Why the check failed, naming the step; empty when ok.
+     *
+     * @generated from field: string error = 3;
+     */
+    error?: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp checked_at = 4;
+     */
+    checkedAt?: TimestampJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.CheckStorageProviderResponse.
+ * Use `create(CheckStorageProviderResponseSchema)` to create a new message.
+ */
+export declare const CheckStorageProviderResponseSchema: GenMessage<CheckStorageProviderResponse, {
+    jsonType: CheckStorageProviderResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.DeleteStorageProviderRequest
+ */
+export type DeleteStorageProviderRequest = Message<"toshi.workspace.v1.DeleteStorageProviderRequest"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.DeleteStorageProviderRequest
+ */
+export type DeleteStorageProviderRequestJson = {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.DeleteStorageProviderRequest.
+ * Use `create(DeleteStorageProviderRequestSchema)` to create a new message.
+ */
+export declare const DeleteStorageProviderRequestSchema: GenMessage<DeleteStorageProviderRequest, {
+    jsonType: DeleteStorageProviderRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.DeleteStorageProviderResponse
+ */
+export type DeleteStorageProviderResponse = Message<"toshi.workspace.v1.DeleteStorageProviderResponse"> & {};
+/**
+ * @generated from message toshi.workspace.v1.DeleteStorageProviderResponse
+ */
+export type DeleteStorageProviderResponseJson = {};
+/**
+ * Describes the message toshi.workspace.v1.DeleteStorageProviderResponse.
+ * Use `create(DeleteStorageProviderResponseSchema)` to create a new message.
+ */
+export declare const DeleteStorageProviderResponseSchema: GenMessage<DeleteStorageProviderResponse, {
+    jsonType: DeleteStorageProviderResponseJson;
+}>;
+/**
+ * StorageProviderService manages the buckets the workspace keeps its
+ * objects in: its own bucket, with a key the control plane wraps, and the
+ * rows the operator set for it. No call returns a credential or the
+ * operator's reference to one.
+ *
+ * Only a signed-in session may call these: a token is refused with
+ * PERMISSION_DENIED. The session names one of its workspaces in the
+ * Toshi-Workspace header. A suspended workspace lists its providers, and so does a
+ * closed one during its read-only period; every other call is refused for
+ * a suspended workspace with FAILED_PRECONDITION.
+ *
+ * @generated from service toshi.workspace.v1.StorageProviderService
+ */
+export declare const StorageProviderService: GenService<{
+    /**
+     * ListStorageProviders returns the workspace's providers, ordered by
+     * name. With include_default it also returns the operator's provider the
+     * workspace uses while it has none of its own.
+     *
+     * A page holds 100 providers when page_size is zero, and 1000 at most.
+     *
+     * @generated from rpc toshi.workspace.v1.StorageProviderService.ListStorageProviders
+     */
+    listStorageProviders: {
+        methodKind: "unary";
+        input: typeof ListStorageProvidersRequestSchema;
+        output: typeof ListStorageProvidersResponseSchema;
+    };
+    /**
+     * CreateStorageProvider stores the workspace's own bucket: the control
+     * plane wraps the key, checks the bucket with it as CheckStorageProvider
+     * does and stores the row only when the check passes, else
+     * FAILED_PRECONDITION with the check's error. A workspace has one such
+     * provider; a second fails with ALREADY_EXISTS, as does a second provider
+     * with the lifecycle capability on the same endpoint and bucket. A bad
+     * field fails with INVALID_ARGUMENT.
+     *
+     * @generated from rpc toshi.workspace.v1.StorageProviderService.CreateStorageProvider
+     */
+    createStorageProvider: {
+        methodKind: "unary";
+        input: typeof CreateStorageProviderRequestSchema;
+        output: typeof CreateStorageProviderResponseSchema;
+    };
+    /**
+     * CheckStorageProvider checks a provider's bucket: it heads the bucket,
+     * refuses a versioned one, then uploads, heads and deletes a probe
+     * object. A check that fails is an answer, not an error: ok is false and
+     * error names the failing step.
+     *
+     * With id it checks a provider the workspace saved, records the result
+     * and returns the provider as stored; an unknown ID, and another
+     * workspace's, fails with NOT_FOUND, and a row the operator set for the
+     * workspace, and the default provider, with PERMISSION_DENIED. With
+     * provider it checks one that is not saved, with the key in the request,
+     * as CreateStorageProvider would before it stores one; it stores and
+     * audits nothing, and a request CreateStorageProvider would refuse fails
+     * the same way before any connection.
+     *
+     * @generated from rpc toshi.workspace.v1.StorageProviderService.CheckStorageProvider
+     */
+    checkStorageProvider: {
+        methodKind: "unary";
+        input: typeof CheckStorageProviderRequestSchema;
+        output: typeof CheckStorageProviderResponseSchema;
+    };
+    /**
+     * DeleteStorageProvider removes a provider the workspace saved. An
+     * unknown ID, and another workspace's, fails with NOT_FOUND; a row the
+     * operator set for the workspace, and the default provider, with
+     * PERMISSION_DENIED.
+     *
+     * @generated from rpc toshi.workspace.v1.StorageProviderService.DeleteStorageProvider
+     */
+    deleteStorageProvider: {
+        methodKind: "unary";
+        input: typeof DeleteStorageProviderRequestSchema;
+        output: typeof DeleteStorageProviderResponseSchema;
+    };
+}>;