@causa/workspace-google 0.12.2 → 0.13.0-rc.1

package/dist/configurations/generated.d.ts

@@ -0,0 +1,725 @@
+/**
+ * The Cloud Storage configuration where Cloud Functions archives should be uploaded.
+ */
+export declare class GoogleCloudFunctionsArtefactStorage {
+    constructor(init: GoogleCloudFunctionsArtefactStorage);
+    /**
+     * The name of the Cloud Storage bucket.
+     */
+    readonly bucket?: string;
+    /**
+     * An optional prefix within the Cloud Storage bucket.
+     */
+    readonly prefix?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for Cloud Functions.
+ */
+export declare class GoogleCloudFunctions {
+    constructor(init: GoogleCloudFunctions);
+    /**
+     * The Cloud Storage configuration where Cloud Functions archives should be uploaded.
+     */
+    readonly artefactStorage?: GoogleCloudFunctionsArtefactStorage;
+    [property: string]: any;
+}
+/**
+ * The type of allowed ingress that can reach the container.
+ * See https://cloud.google.com/run/docs/securing/ingress#settings for more details.
+ */
+export declare enum GoogleCloudRunIngress {
+    All = "all",
+    Internal = "internal",
+    InternalAndCloudLoadBalancing = "internal-and-cloud-load-balancing"
+}
+/**
+ * The setting for egress traffic that goes through the VPC access connector.
+ * See https://cloud.google.com/run/docs/configuring/connecting-vpc#manage for more details.
+ */
+export declare enum GoogleCloudRunVpcAccessConnectorEgressSettings {
+    AllTraffic = "all-traffic",
+    PrivateRangesOnly = "private-ranges-only"
+}
+/**
+ * Configuration for Cloud Run containers.
+ */
+export declare class GoogleCloudRun {
+    constructor(init: GoogleCloudRun);
+    /**
+     * Whether the container is running between requests and can perform background operations.
+     */
+    readonly cpuAlwaysAllocated?: boolean;
+    /**
+     * The Docker repository where Cloud Run containers should be uploaded.
+     */
+    readonly dockerRepository?: string;
+    /**
+     * The type of allowed ingress that can reach the container.
+     * See https://cloud.google.com/run/docs/securing/ingress#settings for more details.
+     */
+    readonly ingress?: GoogleCloudRunIngress;
+    /**
+     * The location where Cloud Run services should be deployed.
+     */
+    readonly location?: string;
+    /**
+     * The maximum allowed in-flight (concurrent) requests per container.
+     */
+    readonly requestConcurrency?: number;
+    /**
+     * A map where keys are the name of environment variables, and values are secret versions IDs (e.g.
+     * `projects/my-project/secrets/my-secret/versions/1`).
+     */
+    readonly secretEnvironmentVariables?: {
+        [key: string]: string;
+    };
+    /**
+     * Whether to enable CPU boost during instance startup.
+     */
+    readonly startupCpuBoost?: boolean;
+    /**
+     * The max duration the instance is allowed for responding to a request, in seconds.
+     */
+    readonly timeout?: number;
+    /**
+     * The name of the VPC access connector through which egress traffic should be routed.
+     */
+    readonly vpcAccessConnector?: string;
+    /**
+     * The setting for egress traffic that goes through the VPC access connector.
+     * See https://cloud.google.com/run/docs/configuring/connecting-vpc#manage for more details.
+     */
+    readonly vpcAccessConnectorEgressSettings?: GoogleCloudRunVpcAccessConnectorEgressSettings;
+    [property: string]: any;
+}
+/**
+ * Configuration for Firebase tools (the CLI).
+ * This applies to Dockerized calls to the `firebase` CLI.
+ */
+export declare class GoogleFirebaseTools {
+    constructor(init: GoogleFirebaseTools);
+    /**
+     * The version of the CLI to use.
+     */
+    readonly version?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Firebase project.
+ */
+export declare class GoogleFirebase {
+    constructor(init: GoogleFirebase);
+    /**
+     * An existing service account that can be used to sign Identity Platform custom token.
+     * Generating custom tokens by signing them using end-user credentials does not work with Identity Platform.
+     * A good choice is usually the service account automatically created by Firebase:
+     * `firebase-adminsdk-<random ID>@<GCP project>.iam.gserviceaccount.com`
+     * If this is not set and is needed by an operation, an attempt will be made to find this service account in the
+     * current `google.project`.
+     */
+    readonly adminServiceAccount?: string;
+    /**
+     * The Firebase API key used by clients. Used to perform requests to Firebase as an end user.
+     * This can be found in the GCP or Firebase Console.
+     * If this is not set and is needed by an operation, an attempt will be made to find the key automatically using
+     * the API.
+     */
+    readonly apiKey?: string;
+    /**
+     * The Firebase app ID used by clients.
+     * This can be found in the Firebase Console. Each platform (Android, iOS, Web) has its own app ID.
+     * If this is not set and is needed by an operation, an attempt will be made to find the first eligible app ID
+     * using the Firebase API.
+     */
+    readonly appId?: string;
+    /**
+     * The domain name for the project.
+     * If not set, this default to `<GCP project>.firebaseapp.com`.
+     */
+    readonly authDomain?: string;
+    /**
+     * Configuration for Firebase tools (the CLI).
+     * This applies to Dockerized calls to the `firebase` CLI.
+     */
+    readonly tools?: GoogleFirebaseTools;
+    [property: string]: any;
+}
+/**
+ * Configuration for the emulator.
+ */
+export declare class GoogleFirebaseStorageEmulator {
+    constructor(init: GoogleFirebaseStorageEmulator);
+    /**
+     * The name of the local Docker container running the emulator.
+     */
+    readonly containerName?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Firebase Storage service.
+ */
+export declare class GoogleFirebaseStorage {
+    constructor(init: GoogleFirebaseStorage);
+    /**
+     * Configuration for the emulator.
+     */
+    readonly emulator?: GoogleFirebaseStorageEmulator;
+    /**
+     * The file path, relative to the workspace root, where the merged security rules file is written.
+     */
+    readonly securityRuleFile?: string;
+    /**
+     * A list of glob patterns to find files in the workspace defining Firebase Storage security rules.
+     */
+    readonly securityRuleFiles?: string[];
+    [property: string]: any;
+}
+/**
+ * Configuration for the emulator.
+ */
+export declare class GoogleFirestoreEmulator {
+    constructor(init: GoogleFirestoreEmulator);
+    /**
+     * The name of the local Docker container running the emulator.
+     */
+    readonly containerName?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Firestore service.
+ */
+export declare class GoogleFirestore {
+    constructor(init: GoogleFirestore);
+    /**
+     * Configuration for the emulator.
+     */
+    readonly emulator?: GoogleFirestoreEmulator;
+    /**
+     * The file path, relative to the workspace root, where the merged security rules file is written.
+     */
+    readonly securityRuleFile?: string;
+    /**
+     * A list of glob patterns to find files in the workspace defining Firestore security rules.
+     */
+    readonly securityRuleFiles?: string[];
+    [property: string]: any;
+}
+/**
+ * Configuration for the `gcloud` command.
+ * This applies to Dockerized calls to `gcloud` using the official `gcloud` Docker image.
+ */
+export declare class GoogleGcloud {
+    constructor(init: GoogleGcloud);
+    /**
+     * The version of the `gcloud` command.
+     */
+    readonly version?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the emulator.
+ */
+export declare class GoogleIdentityPlatformEmulator {
+    constructor(init: GoogleIdentityPlatformEmulator);
+    /**
+     * The name of the local Docker container running the emulator.
+     */
+    readonly containerName?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Identity Platform (formerly Firebase Auth) service.
+ */
+export declare class GoogleIdentityPlatform {
+    constructor(init: GoogleIdentityPlatform);
+    /**
+     * Configuration for the emulator.
+     */
+    readonly emulator?: GoogleIdentityPlatformEmulator;
+    [property: string]: any;
+}
+/**
+ * Configuration for Google Cloud load balancing.
+ */
+export declare class GoogleLoadBalancing {
+    constructor(init: GoogleLoadBalancing);
+    /**
+     * A list of custom request headers to add to load-balanced requests.
+     */
+    readonly customRequestHeaders?: string[];
+    [property: string]: any;
+}
+/**
+ * Configuration for the storage of Pub/Sub events in BigQuery.
+ */
+export declare class GooglePubSubBigQueryStorage {
+    constructor(init: GooglePubSubBigQueryStorage);
+    /**
+     * The BigQuery location for the datasets.
+     * See https://cloud.google.com/bigquery/docs/locations for more details.
+     */
+    readonly location?: string;
+    /**
+     * The ID of the BigQuery dataset where raw Pub/Sub events should be stored.
+     */
+    readonly rawEventsDatasetId?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the emulator.
+ */
+export declare class GooglePubSubEmulator {
+    constructor(init: GooglePubSubEmulator);
+    /**
+     * The name of the local Docker container running the emulator.
+     */
+    readonly containerName?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Pub/Sub service.
+ */
+export declare class GooglePubSub {
+    constructor(init: GooglePubSub);
+    /**
+     * Configuration for the storage of Pub/Sub events in BigQuery.
+     */
+    readonly bigQueryStorage?: GooglePubSubBigQueryStorage;
+    /**
+     * Configuration for the emulator.
+     */
+    readonly emulator?: GooglePubSubEmulator;
+    /**
+     * The default maximum backoff for Pub/Sub push subscription retry policy.
+     */
+    readonly maximumBackoff?: string;
+    /**
+     * The default minimum backoff for Pub/Sub push subscription retry policy.
+     */
+    readonly minimumBackoff?: string;
+    /**
+     * The directory where the topic configuration files are written by the `GooglePubSubWriteTopics` processor.
+     */
+    readonly topicConfigurationsDirectory?: string;
+    [property: string]: any;
+}
+/**
+ * Default configuration for Cloud Scheduler jobs.
+ */
+export declare class GoogleScheduler {
+    constructor(init: GoogleScheduler);
+    /**
+     * The default deadline for Cloud Scheduler job attempts.
+     */
+    readonly attemptDeadline?: string;
+    /**
+     * The default maximum backoff duration for Cloud Scheduler job retries.
+     */
+    readonly maxBackoffDuration?: string;
+    /**
+     * The default maximum number of times the backoff duration is doubled for Cloud Scheduler job retries.
+     */
+    readonly maxDoublings?: number;
+    /**
+     * The default maximum duration for retrying a failed Cloud Scheduler job.
+     */
+    readonly maxRetryDuration?: string;
+    /**
+     * The default minimum backoff duration for Cloud Scheduler job retries.
+     */
+    readonly minBackoffDuration?: string;
+    /**
+     * The default number of retry attempts for Cloud Scheduler jobs.
+     */
+    readonly retryCount?: number;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Secret Manager service.
+ */
+export declare class GoogleSecretManager {
+    constructor(init: GoogleSecretManager);
+    /**
+     * The ID of the default GCP project referenced when fetching secrets.
+     */
+    readonly project?: string;
+    [property: string]: any;
+}
+/**
+ * Defines how DDLs are found for the Spanner databases in the workspace.
+ */
+export declare class GoogleSpannerDdls {
+    constructor(init: GoogleSpannerDdls);
+    /**
+     * The format string using groups from the regular expression used to make the database names.
+     */
+    readonly format?: string;
+    /**
+     * A list of glob patterns used to find SQL files containing DDL statements for the Spanner databases.
+     */
+    readonly globs?: string[];
+    /**
+     * The regular expression used to extract groups from the SQL file paths.
+     */
+    readonly regularExpression?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for the emulator.
+ */
+export declare class GoogleSpannerEmulator {
+    constructor(init: GoogleSpannerEmulator);
+    /**
+     * The name of the local Docker container running the emulator.
+     */
+    readonly containerName?: string;
+    /**
+     * The name of the Spanner instance that will automatically be created in the emulator.
+     */
+    readonly instanceName?: string;
+    /**
+     * The version of the Spanner emulator Docker image to use.
+     */
+    readonly version?: string;
+    [property: string]: any;
+}
+/**
+ * Autoscaling configuration for the Spanner instance.
+ */
+export declare class GoogleSpannerInstanceAutoscaling {
+    constructor(init: GoogleSpannerInstanceAutoscaling);
+    /**
+     * The target high-priority CPU utilization percentage for autoscaling.
+     */
+    readonly highPriorityCpuUtilizationTarget?: number;
+    /**
+     * The maximum number of processing units for autoscaling.
+     */
+    readonly maxProcessingUnits?: number;
+    /**
+     * The minimum number of processing units for autoscaling.
+     */
+    readonly minProcessingUnits?: number;
+    /**
+     * The target storage utilization percentage for autoscaling.
+     */
+    readonly storageUtilizationTarget?: number;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Spanner instance.
+ */
+export declare class GoogleSpannerInstance {
+    constructor(init: GoogleSpannerInstance);
+    /**
+     * Autoscaling configuration for the Spanner instance.
+     */
+    readonly autoscaling?: GoogleSpannerInstanceAutoscaling;
+    /**
+     * The instance geographic configuration.
+     * See https://cloud.google.com/spanner/docs/instance-configurations for more details.
+     */
+    readonly configuration?: string;
+    /**
+     * The edition of the Spanner instance (e.g. STANDARD, ENTERPRISE).
+     */
+    readonly edition?: string;
+    /**
+     * The name of the Spanner instance.
+     */
+    readonly name?: string;
+    /**
+     * The compute capacity of the instance.
+     * See https://cloud.google.com/spanner/docs/compute-capacity for more details.
+     */
+    readonly processingUnits?: number;
+    [property: string]: any;
+}
+/**
+ * Configuration for the Spanner service.
+ */
+export declare class GoogleSpanner {
+    constructor(init: GoogleSpanner);
+    /**
+     * The directory where the database configuration files are written by the `GoogleSpannerWriteDatabases` processor.
+     */
+    readonly databaseConfigurationsDirectory?: string;
+    /**
+     * The timeout for Spanner database DDL operations.
+     */
+    readonly databaseDdlTimeout?: string;
+    /**
+     * Defines how DDLs are found for the Spanner databases in the workspace.
+     */
+    readonly ddls?: GoogleSpannerDdls;
+    /**
+     * Configuration for the emulator.
+     */
+    readonly emulator?: GoogleSpannerEmulator;
+    /**
+     * Configuration for the Spanner instance.
+     */
+    readonly instance?: GoogleSpannerInstance;
+    /**
+     * The default version retention period for Spanner databases.
+     */
+    readonly versionRetentionPeriod?: string;
+    [property: string]: any;
+}
+/**
+ * Configuration for everything Google / GCP-related.
+ */
+export declare class Google {
+    constructor(init: Google);
+    /**
+     * Configuration for Cloud Functions.
+     */
+    readonly cloudFunctions?: GoogleCloudFunctions;
+    /**
+     * Configuration for Cloud Run containers.
+     */
+    readonly cloudRun?: GoogleCloudRun;
+    /**
+     * Configuration for the Firebase project.
+     */
+    readonly firebase?: GoogleFirebase;
+    /**
+     * Configuration for the Firebase Storage service.
+     */
+    readonly firebaseStorage?: GoogleFirebaseStorage;
+    /**
+     * Configuration for the Firestore service.
+     */
+    readonly firestore?: GoogleFirestore;
+    /**
+     * Configuration for the `gcloud` command.
+     * This applies to Dockerized calls to `gcloud` using the official `gcloud` Docker image.
+     */
+    readonly gcloud?: GoogleGcloud;
+    /**
+     * Configuration for the Identity Platform (formerly Firebase Auth) service.
+     */
+    readonly identityPlatform?: GoogleIdentityPlatform;
+    /**
+     * Configuration for Google Cloud load balancing.
+     */
+    readonly loadBalancing?: GoogleLoadBalancing;
+    /**
+     * The ID of a local GCP project (which does not exist on GCP).
+     * This is for example used by emulators. It should usually start with `demo-` to be compatible with some emulators.
+     */
+    readonly localProject?: string;
+    /**
+     * The ID of the default GCP project used when performing operations.
+     */
+    readonly project?: string;
+    /**
+     * Configuration for the Pub/Sub service.
+     */
+    readonly pubSub?: GooglePubSub;
+    /**
+     * The GCP region in which resource should be created and managed.
+     */
+    readonly region?: string;
+    /**
+     * Default configuration for Cloud Scheduler jobs.
+     */
+    readonly scheduler?: GoogleScheduler;
+    /**
+     * Configuration for the Secret Manager service.
+     */
+    readonly secretManager?: GoogleSecretManager;
+    /**
+     * The list of GCP services on which the project depends.
+     * This is useful to automatically enable those services in the GCP project.
+     */
+    readonly services?: string[];
+    /**
+     * Configuration for the Spanner service.
+     */
+    readonly spanner?: GoogleSpanner;
+    [property: string]: any;
+}
+/**
+ * The schema for Google / GCP configuration.
+ */
+export declare class GoogleConfiguration {
+    constructor(init: GoogleConfiguration);
+    /**
+     * Configuration for everything Google / GCP-related.
+     */
+    readonly google?: Google;
+    [property: string]: any;
+}
+export declare class Outputs {
+    constructor(init: Outputs);
+    /**
+     * The list of Firestore collections this service produces data into.
+     */
+    readonly 'google.firestore'?: string[];
+    /**
+     * The list of Spanner databases this service produces data into.
+     * Each entry should be in the format `instance.database`.
+     */
+    readonly 'google.spanner'?: string[];
+    [property: string]: any;
+}
+export declare class ServiceContainerGoogleEventarcTriggerFilter {
+    constructor(init: ServiceContainerGoogleEventarcTriggerFilter);
+    /**
+     * The event attribute to filter on.
+     */
+    readonly attribute: string;
+    /**
+     * The operator for matching the filter.
+     */
+    readonly operator?: string;
+    /**
+     * The value to match for the attribute.
+     */
+    readonly value: string;
+    [property: string]: any;
+}
+/**
+ * Google Eventarc-specific options for the trigger.
+ */
+export declare class ServiceContainerGoogleEventarcTriggerOptions {
+    constructor(init: ServiceContainerGoogleEventarcTriggerOptions);
+    /**
+     * The content type of event data.
+     */
+    readonly contentType: string;
+    /**
+     * The list of matching criteria for the Eventarc trigger.
+     */
+    readonly filters: ServiceContainerGoogleEventarcTriggerFilter[];
+    /**
+     * The location of the Eventarc trigger.
+     */
+    readonly location?: string;
+    [property: string]: any;
+}
+/**
+ * Google Pub/Sub-specific options for the trigger.
+ */
+export declare class ServiceContainerGooglePubSubTriggerOptions {
+    constructor(init: ServiceContainerGooglePubSubTriggerOptions);
+    /**
+     * A Pub/Sub filter expression for the subscription.
+     */
+    readonly filter?: string;
+    /**
+     * The maximum backoff for the Pub/Sub push subscription retry policy.
+     */
+    readonly maximumBackoff?: string;
+    /**
+     * The minimum backoff for the Pub/Sub push subscription retry policy.
+     */
+    readonly minimumBackoff?: string;
+    [property: string]: any;
+}
+/**
+ * Google Cloud Scheduler-specific options for the trigger.
+ */
+export declare class ServiceContainerGoogleSchedulerTriggerOptions {
+    constructor(init: ServiceContainerGoogleSchedulerTriggerOptions);
+    /**
+     * The deadline for job attempts.
+     */
+    readonly attemptDeadline?: string;
+    /**
+     * The maximum backoff duration for job retries.
+     */
+    readonly maxBackoffDuration?: string;
+    /**
+     * The maximum number of times the backoff duration is doubled.
+     */
+    readonly maxDoublings?: number;
+    /**
+     * The maximum duration for retrying a failed job.
+     */
+    readonly maxRetryDuration?: string;
+    /**
+     * The minimum backoff duration for job retries.
+     */
+    readonly minBackoffDuration?: string;
+    /**
+     * The number of retry attempts for the Cloud Scheduler job.
+     */
+    readonly retryCount?: number;
+    [property: string]: any;
+}
+/**
+ * The retry policy for the Cloud Tasks queue.
+ */
+export declare class ServiceContainerGoogleTaskTriggerRetryPolicy {
+    constructor(init: ServiceContainerGoogleTaskTriggerRetryPolicy);
+    /**
+     * The maximum number of attempts for a task.
+     */
+    readonly maxAttempts?: number;
+    /**
+     * The maximum backoff duration for task retries.
+     */
+    readonly maxBackoff?: string;
+    /**
+     * The maximum number of times the backoff duration is doubled.
+     */
+    readonly maxDoublings?: number;
+    /**
+     * The maximum duration for retrying a failed task.
+     */
+    readonly maxRetryDuration?: string;
+    /**
+     * The minimum backoff duration for task retries.
+     */
+    readonly minBackoff?: string;
+    [property: string]: any;
+}
+/**
+ * A trigger backed by a Google Eventarc trigger.
+ */
+export declare class ServiceContainerGoogleTrigger {
+    constructor(init: ServiceContainerGoogleTrigger);
+    /**
+     * The type of trigger.
+     */
+    readonly type: string;
+    /**
+     * Google Pub/Sub-specific options for the trigger.
+     */
+    readonly 'google.pubSub'?: ServiceContainerGooglePubSubTriggerOptions;
+    /**
+     * Google Cloud Scheduler-specific options for the trigger.
+     */
+    readonly 'google.scheduler'?: ServiceContainerGoogleSchedulerTriggerOptions;
+    /**
+     * The retry policy for the Cloud Tasks queue.
+     */
+    readonly retryPolicy?: ServiceContainerGoogleTaskTriggerRetryPolicy;
+    /**
+     * Google Eventarc-specific options for the trigger.
+     */
+    readonly 'google.eventarc'?: ServiceContainerGoogleEventarcTriggerOptions;
+    [property: string]: any;
+}
+export declare class ServiceContainer {
+    constructor(init: ServiceContainer);
+    readonly outputs?: Outputs;
+    /**
+     * A map of triggers that call the service's endpoints when they occur.
+     */
+    readonly triggers?: {
+        [key: string]: ServiceContainerGoogleTrigger;
+    };
+    [property: string]: any;
+}
+/**
+ * Google-specific extensions to the service container configuration.
+ */
+export declare class GoogleServiceContainerConfiguration {
+    constructor(init: GoogleServiceContainerConfiguration);
+    readonly serviceContainer?: ServiceContainer;
+    [property: string]: any;
+}