/** * Qovery API * - Qovery is the fastest way to deploy your full-stack apps on any Cloud provider. - ℹ️ The API is stable and still in development. * * The version of the OpenAPI document: 1.0.4 * Contact: support+api+documentation@qovery.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @enum {string} */ export declare const APIVariableScopeEnum: { readonly APPLICATION: "APPLICATION"; readonly BUILT_IN: "BUILT_IN"; readonly ENVIRONMENT: "ENVIRONMENT"; readonly PROJECT: "PROJECT"; readonly CONTAINER: "CONTAINER"; readonly JOB: "JOB"; readonly HELM: "HELM"; readonly TERRAFORM: "TERRAFORM"; }; export type APIVariableScopeEnum = typeof APIVariableScopeEnum[keyof typeof APIVariableScopeEnum]; /** * type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE, BUIT_IN, EXTERNAL_SECRET) * @export * @enum {string} */ export declare const APIVariableTypeEnum: { readonly VALUE: "VALUE"; readonly ALIAS: "ALIAS"; readonly OVERRIDE: "OVERRIDE"; readonly BUILT_IN: "BUILT_IN"; readonly FILE: "FILE"; readonly EXTERNAL_SECRET: "EXTERNAL_SECRET"; }; export type APIVariableTypeEnum = typeof APIVariableTypeEnum[keyof typeof APIVariableTypeEnum]; /** * * @export * @interface AccountInfo */ export interface AccountInfo { /** * * @type {string} * @memberof AccountInfo */ 'id'?: string; /** * * @type {string} * @memberof AccountInfo */ 'created_at'?: string; /** * * @type {string} * @memberof AccountInfo */ 'nickname'?: string; /** * * @type {string} * @memberof AccountInfo */ 'first_name'?: string; /** * * @type {string} * @memberof AccountInfo */ 'last_name'?: string; /** * * @type {string} * @memberof AccountInfo */ 'profile_picture_url'?: string; /** * * @type {string} * @memberof AccountInfo */ 'communication_email'?: string; } /** * * @export * @interface AccountInfoEditRequest */ export interface AccountInfoEditRequest { /** * The email to be used for official Qovery communications * @type {string} * @memberof AccountInfoEditRequest */ 'communication_email'?: string; } /** * * @export * @interface AksInfrastructureOutputs */ export interface AksInfrastructureOutputs { /** * * @type {string} * @memberof AksInfrastructureOutputs */ 'kind': AksInfrastructureOutputsKindEnum; /** * * @type {string} * @memberof AksInfrastructureOutputs */ 'cluster_name': string; /** * * @type {string} * @memberof AksInfrastructureOutputs */ 'cluster_oidc_issuer': string; } export declare const AksInfrastructureOutputsKindEnum: { readonly AKS: "AKS"; }; export type AksInfrastructureOutputsKindEnum = typeof AksInfrastructureOutputsKindEnum[keyof typeof AksInfrastructureOutputsKindEnum]; /** * * @export * @interface AlertPresentation */ export interface AlertPresentation { /** * * @type {string} * @memberof AlertPresentation */ 'summary'?: string | null; /** * URL to runbook with remediation steps * @type {string} * @memberof AlertPresentation */ 'runbook_url'?: string | null; } /** * * @export * @interface AlertPresentationResponse */ export interface AlertPresentationResponse { /** * Alert summary template * @type {string} * @memberof AlertPresentationResponse */ 'summary'?: string | null; /** * URL to runbook with remediation steps * @type {string} * @memberof AlertPresentationResponse */ 'runbook_url'?: string | null; } /** * @type AlertReceiverCreationRequest * @export */ export type AlertReceiverCreationRequest = { type: 'EMAIL'; } & EmailAlertReceiverCreationRequest | { type: 'SLACK'; } & SlackAlertReceiverCreationRequest; /** * * @export * @interface AlertReceiverCreationRequestBase */ export interface AlertReceiverCreationRequestBase { /** * * @type {string} * @memberof AlertReceiverCreationRequestBase */ 'organization_id': string; /** * * @type {string} * @memberof AlertReceiverCreationRequestBase */ 'name': string; /** * * @type {string} * @memberof AlertReceiverCreationRequestBase */ 'description': string; /** * * @type {AlertReceiverType} * @memberof AlertReceiverCreationRequestBase */ 'type': AlertReceiverType; /** * * @type {boolean} * @memberof AlertReceiverCreationRequestBase */ 'send_resolved': boolean; /** * * @type {string} * @memberof AlertReceiverCreationRequestBase */ 'owner'?: string | null; /** * * @type {string} * @memberof AlertReceiverCreationRequestBase */ 'severity'?: string | null; } /** * * @export * @interface AlertReceiverCreationValidationRequest */ export interface AlertReceiverCreationValidationRequest { /** * * @type {AlertReceiverCreationRequest} * @memberof AlertReceiverCreationValidationRequest */ 'alert_receiver': AlertReceiverCreationRequest; /** * * @type {string} * @memberof AlertReceiverCreationValidationRequest */ 'message'?: string; } /** * @type AlertReceiverEditRequest * @export */ export type AlertReceiverEditRequest = { type: 'EMAIL'; } & EmailAlertReceiverEditRequest | { type: 'SLACK'; } & SlackAlertReceiverEditRequest; /** * * @export * @interface AlertReceiverEditRequestBase */ export interface AlertReceiverEditRequestBase { /** * * @type {string} * @memberof AlertReceiverEditRequestBase */ 'name': string; /** * * @type {string} * @memberof AlertReceiverEditRequestBase */ 'description': string; /** * * @type {AlertReceiverType} * @memberof AlertReceiverEditRequestBase */ 'type': AlertReceiverType; /** * * @type {boolean} * @memberof AlertReceiverEditRequestBase */ 'send_resolved': boolean; /** * * @type {string} * @memberof AlertReceiverEditRequestBase */ 'owner'?: string | null; /** * * @type {string} * @memberof AlertReceiverEditRequestBase */ 'severity'?: string | null; } /** * * @export * @interface AlertReceiverList */ export interface AlertReceiverList { /** * * @type {Array} * @memberof AlertReceiverList */ 'results': Array; } /** * @type AlertReceiverResponse * @export */ export type AlertReceiverResponse = { type: 'EMAIL'; } & EmailAlertReceiverResponse | { type: 'SLACK'; } & SlackAlertReceiverResponse; /** * * @export * @enum {string} */ export declare const AlertReceiverType: { readonly SLACK: "SLACK"; readonly EMAIL: "EMAIL"; }; export type AlertReceiverType = typeof AlertReceiverType[keyof typeof AlertReceiverType]; /** * * @export * @interface AlertReceiverValidationRequest */ export interface AlertReceiverValidationRequest { /** * * @type {string} * @memberof AlertReceiverValidationRequest */ 'message'?: string; } /** * * @export * @interface AlertRuleCondition */ export interface AlertRuleCondition { /** * * @type {AlertRuleConditionKind} * @memberof AlertRuleCondition */ 'kind': AlertRuleConditionKind; /** * * @type {AlertRuleConditionOperator} * @memberof AlertRuleCondition */ 'operator'?: AlertRuleConditionOperator; /** * * @type {number} * @memberof AlertRuleCondition */ 'threshold'?: number; /** * * @type {AlertRuleConditionFunction} * @memberof AlertRuleCondition */ 'function'?: AlertRuleConditionFunction; /** * * @type {string} * @memberof AlertRuleCondition */ 'promql': string; } /** * * @export * @enum {string} */ export declare const AlertRuleConditionFunction: { readonly NONE: "NONE"; readonly AVG: "AVG"; readonly MAX: "MAX"; readonly MIN: "MIN"; readonly SUM: "SUM"; readonly COUNT: "COUNT"; }; export type AlertRuleConditionFunction = typeof AlertRuleConditionFunction[keyof typeof AlertRuleConditionFunction]; /** * * @export * @enum {string} */ export declare const AlertRuleConditionKind: { readonly CUSTOM: "CUSTOM"; readonly BUILT: "BUILT"; }; export type AlertRuleConditionKind = typeof AlertRuleConditionKind[keyof typeof AlertRuleConditionKind]; /** * * @export * @enum {string} */ export declare const AlertRuleConditionOperator: { readonly NONE: "NONE"; readonly ABOVE: "ABOVE"; readonly BELOW: "BELOW"; readonly ABOVE_OR_EQUAL: "ABOVE_OR_EQUAL"; readonly BELOW_OR_EQUAL: "BELOW_OR_EQUAL"; readonly EQUAL: "EQUAL"; }; export type AlertRuleConditionOperator = typeof AlertRuleConditionOperator[keyof typeof AlertRuleConditionOperator]; /** * * @export * @interface AlertRuleCreationRequest */ export interface AlertRuleCreationRequest { /** * Organization identifier * @type {string} * @memberof AlertRuleCreationRequest */ 'organization_id': string; /** * Cluster identifier where the rule will be deployed * @type {string} * @memberof AlertRuleCreationRequest */ 'cluster_id': string; /** * Name of the alert rule * @type {string} * @memberof AlertRuleCreationRequest */ 'name': string; /** * Description of what the alert monitors * @type {string} * @memberof AlertRuleCreationRequest */ 'description': string; /** * * @type {string} * @memberof AlertRuleCreationRequest */ 'tag': string; /** * * @type {AlertRuleCondition} * @memberof AlertRuleCreationRequest */ 'condition': AlertRuleCondition; /** * Duration the condition must be true before firing (ISO-8601 duration format) * @type {string} * @memberof AlertRuleCreationRequest */ 'for_duration': string; /** * * @type {AlertSeverity} * @memberof AlertRuleCreationRequest */ 'severity': AlertSeverity; /** * * @type {AlertPresentation} * @memberof AlertRuleCreationRequest */ 'presentation': AlertPresentation; /** * Whether the alert rule is enabled * @type {boolean} * @memberof AlertRuleCreationRequest */ 'enabled': boolean; /** * List of alert receiver IDs to send notifications to * @type {Array} * @memberof AlertRuleCreationRequest */ 'alert_receiver_ids': Array; /** * * @type {AlertTarget} * @memberof AlertRuleCreationRequest */ 'target': AlertTarget; } /** * * @export * @interface AlertRuleEditRequest */ export interface AlertRuleEditRequest { /** * Name of the alert rule * @type {string} * @memberof AlertRuleEditRequest */ 'name': string; /** * Description of what the alert monitors * @type {string} * @memberof AlertRuleEditRequest */ 'description': string; /** * * @type {string} * @memberof AlertRuleEditRequest */ 'tag': string; /** * * @type {AlertRuleCondition} * @memberof AlertRuleEditRequest */ 'condition': AlertRuleCondition; /** * Duration the condition must be true before firing (ISO-8601 duration format) * @type {string} * @memberof AlertRuleEditRequest */ 'for_duration': string; /** * * @type {AlertSeverity} * @memberof AlertRuleEditRequest */ 'severity': AlertSeverity; /** * Whether the alert rule is enabled * @type {boolean} * @memberof AlertRuleEditRequest */ 'enabled': boolean; /** * List of alert receiver IDs to send notifications to * @type {Array} * @memberof AlertRuleEditRequest */ 'alert_receiver_ids': Array; /** * * @type {AlertPresentation} * @memberof AlertRuleEditRequest */ 'presentation': AlertPresentation; } /** * * @export * @interface AlertRuleList */ export interface AlertRuleList { /** * * @type {Array} * @memberof AlertRuleList */ 'results': Array; } /** * @type AlertRuleListResultsInner * @export */ export type AlertRuleListResultsInner = { source: 'GHOST'; } & GhostAlertRuleResponse | { source: 'MANAGED'; } & AlertRuleResponse; /** * * @export * @interface AlertRuleResponse */ export interface AlertRuleResponse extends AlertRuleResponseBase { /** * * @type {string} * @memberof AlertRuleResponse */ 'id': string; /** * * @type {string} * @memberof AlertRuleResponse */ 'created_at': string; /** * * @type {string} * @memberof AlertRuleResponse */ 'updated_at'?: string; /** * Organization identifier * @type {string} * @memberof AlertRuleResponse */ 'organization_id': string; /** * Cluster identifier * @type {string} * @memberof AlertRuleResponse */ 'cluster_id': string; /** * Description of what the alert monitors * @type {string} * @memberof AlertRuleResponse */ 'description': string; /** * * @type {string} * @memberof AlertRuleResponse */ 'tag': string; /** * * @type {AlertRuleCondition} * @memberof AlertRuleResponse */ 'condition': AlertRuleCondition; /** * Duration the condition must be true before firing (ISO-8601 duration format) * @type {string} * @memberof AlertRuleResponse */ 'for_duration': string; /** * * @type {AlertSeverity} * @memberof AlertRuleResponse */ 'severity': AlertSeverity; /** * Whether the alert rule is enabled * @type {boolean} * @memberof AlertRuleResponse */ 'enabled': boolean; /** * List of alert receiver IDs to send notifications to * @type {Array} * @memberof AlertRuleResponse */ 'alert_receiver_ids': Array; /** * * @type {AlertPresentationResponse} * @memberof AlertRuleResponse */ 'presentation': AlertPresentationResponse; /** * * @type {AlertTarget} * @memberof AlertRuleResponse */ 'target': AlertTarget; /** * Indicates whether the current version of the alert has been synced with the alerting system. If false, an outdated version is currently deployed. * @type {boolean} * @memberof AlertRuleResponse */ 'is_up_to_date': boolean; /** * when the alert starts firing * @type {string} * @memberof AlertRuleResponse */ 'starts_at'?: string; } /** * Base schema for alert rule responses with discriminator * @export * @interface AlertRuleResponseBase */ export interface AlertRuleResponseBase { /** * * @type {AlertRuleSource} * @memberof AlertRuleResponseBase */ 'source': AlertRuleSource; /** * Name of the alert rule * @type {string} * @memberof AlertRuleResponseBase */ 'name': string; /** * * @type {AlertRuleState} * @memberof AlertRuleResponseBase */ 'state': AlertRuleState; } /** * Source of the alert rule: - MANAGED: Alert rule created and managed through the Qovery API - GHOST: Alert rule that exists in Prometheus but has been deleted from the database * @export * @enum {string} */ export declare const AlertRuleSource: { readonly MANAGED: "MANAGED"; readonly GHOST: "GHOST"; }; export type AlertRuleSource = typeof AlertRuleSource[keyof typeof AlertRuleSource]; /** * * @export * @enum {string} */ export declare const AlertRuleState: { readonly UNDEPLOYED: "UNDEPLOYED"; readonly OK: "OK"; readonly TRIGGERED: "TRIGGERED"; readonly PENDING_NOTIFICATION: "PENDING_NOTIFICATION"; readonly NOTIFIED: "NOTIFIED"; readonly SUPPRESSED: "SUPPRESSED"; readonly UNROUTED: "UNROUTED"; }; export type AlertRuleState = typeof AlertRuleState[keyof typeof AlertRuleState]; /** * Alert severity level: - LOW: Minor issues or informational alerts that don\'t require immediate attention. Can be addressed during normal business hours. - MEDIUM: Moderate issues that should be investigated soon but don\'t impact critical services. May cause degraded performance or minor service disruption. - HIGH: Serious issues affecting service quality or availability. Requires prompt attention and resolution within hours. - CRITICAL: Critical issue requiring immediate action. Service outage, data loss risk, or severe performance degradation affecting users. * @export * @enum {string} */ export declare const AlertSeverity: { readonly LOW: "LOW"; readonly MEDIUM: "MEDIUM"; readonly HIGH: "HIGH"; readonly CRITICAL: "CRITICAL"; }; export type AlertSeverity = typeof AlertSeverity[keyof typeof AlertSeverity]; /** * * @export * @interface AlertTarget */ export interface AlertTarget { /** * * @type {AlertTargetType} * @memberof AlertTarget */ 'target_type': AlertTargetType; /** * * @type {string} * @memberof AlertTarget */ 'target_id': string; /** * * @type {ServiceLightResponse} * @memberof AlertTarget */ 'service'?: ServiceLightResponse; } /** * The target of an alert * @export * @enum {string} */ export declare const AlertTargetType: { readonly CLUSTER: " CLUSTER"; readonly ENVIRONMENT: "ENVIRONMENT"; readonly APPLICATION: "APPLICATION"; readonly CONTAINER: "CONTAINER"; readonly JOB: "JOB"; readonly CRONJOB: "CRONJOB"; readonly HELM: "HELM"; readonly TERRAFORM: "TERRAFORM"; }; export type AlertTargetType = typeof AlertTargetType[keyof typeof AlertTargetType]; /** * * @export * @interface AlertingConfig */ export interface AlertingConfig { /** * * @type {boolean} * @memberof AlertingConfig */ 'enabled': boolean; /** * Key-value pairs of default labels to be applied to alert rules * @type {{ [key: string]: string; }} * @memberof AlertingConfig */ 'default_rule_labels'?: { [key: string]: string; } | null; /** * * @type {string} * @memberof AlertingConfig */ 'spec_config_secret'?: string; /** * * @type {string} * @memberof AlertingConfig */ 'spec_external_url'?: string; /** * * @type {string} * @memberof AlertingConfig */ 'config_name'?: string; } /** * * @export * @interface Annotation */ export interface Annotation { /** * * @type {string} * @memberof Annotation */ 'key': string; /** * * @type {string} * @memberof Annotation */ 'value': string; } /** * Annotations Group Associated Item Type * @export * @enum {string} */ export declare const AnnotationsGroupAssociatedItemType: { readonly APPLICATION: "APPLICATION"; readonly DATABASE: "DATABASE"; readonly CONTAINER: "CONTAINER"; readonly LIFECYCLE: "LIFECYCLE"; readonly ENVIRONMENT: "ENVIRONMENT"; readonly CLUSTER: "CLUSTER"; readonly CRON: "CRON"; }; export type AnnotationsGroupAssociatedItemType = typeof AnnotationsGroupAssociatedItemType[keyof typeof AnnotationsGroupAssociatedItemType]; /** * * @export * @interface Application */ export interface Application { /** * * @type {string} * @memberof Application */ 'id': string; /** * * @type {string} * @memberof Application */ 'created_at': string; /** * * @type {string} * @memberof Application */ 'updated_at'?: string; /** * * @type {Array} * @memberof Application */ 'storage'?: Array; /** * * @type {ReferenceObject} * @memberof Application */ 'environment': ReferenceObject; /** * * @type {ApplicationGitRepository} * @memberof Application */ 'git_repository'?: ApplicationGitRepository; /** * Maximum cpu that can be allocated to the application based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof Application */ 'maximum_cpu'?: number; /** * Maximum memory that can be allocated to the application based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof Application */ 'maximum_memory'?: number; /** * * @type {number} * @memberof Application */ 'maximun_gpu'?: number; /** * name is case insensitive * @type {string} * @memberof Application */ 'name': string; /** * give a description to this application * @type {string} * @memberof Application */ 'description'?: string; /** * * @type {BuildModeEnum} * @memberof Application */ 'build_mode'?: BuildModeEnum; /** * The path of the associated Dockerfile. Only if you are using build_mode = DOCKER * @type {string} * @memberof Application */ 'dockerfile_path'?: string | null; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof Application */ 'cpu'?: number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof Application */ 'memory'?: number; /** * * @type {number} * @memberof Application */ 'gpu'?: number; /** * Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running. * @type {number} * @memberof Application */ 'min_running_instances'?: number; /** * Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. * @type {number} * @memberof Application */ 'max_running_instances'?: number; /** * * @type {Healthcheck} * @memberof Application */ 'healthchecks': Healthcheck; /** * Specify if the environment preview option is activated or not for this application. If activated, a preview environment will be automatically cloned at each pull request. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof Application */ 'auto_preview'?: boolean; /** * * @type {Array} * @memberof Application */ 'ports'?: Array; /** * * @type {Array} * @memberof Application */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof Application */ 'entrypoint'?: string; /** * Specify if the application will be automatically updated after receiving a new commit. * @type {boolean} * @memberof Application */ 'auto_deploy'?: boolean; /** * * @type {Array} * @memberof Application */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof Application */ 'labels_groups'?: Array; /** * Icon URI representing the application. * @type {string} * @memberof Application */ 'icon_uri': string; /** * * @type {ServiceTypeEnum} * @memberof Application */ 'service_type': ServiceTypeEnum; /** * The target build stage in the Dockerfile to build * @type {string} * @memberof Application */ 'docker_target_build_stage'?: string | null; /** * * @type {AutoscalingPolicyResponse} * @memberof Application */ 'autoscaling'?: AutoscalingPolicyResponse; } /** * * @export * @interface ApplicationAdvancedSettings */ export interface ApplicationAdvancedSettings { /** * disable custom domain check when deploying an application * @type {boolean} * @memberof ApplicationAdvancedSettings */ 'deployment.custom_domain_check_enabled'?: boolean; /** * define how long in seconds an application is supposed to be stopped gracefully * @type {number} * @memberof ApplicationAdvancedSettings */ 'deployment.termination_grace_period_seconds'?: number; /** * Set pod placement on specific Kubernetes nodes labels * @type {{ [key: string]: string; }} * @memberof ApplicationAdvancedSettings */ 'deployment.affinity.node.required'?: { [key: string]: string; }; /** * Define how you want pods affinity to behave: * `Preferred` allows, but does not require, pods of a given service are not co-located (or co-hosted) on a single node * `Requirred` ensures that the pods of a given service are not co-located (or co-hosted) on a single node (safer in term of availability but can be expensive depending on the number of replicas) * @type {string} * @memberof ApplicationAdvancedSettings */ 'deployment.antiaffinity.pod'?: ApplicationAdvancedSettingsDeploymentAntiaffinityPodEnum; /** * Define how you want pods to be spread across availability zones: * `Disabled` no topology spread constraints are applied * `ScheduleAnyway` pods are spread across zones on a best-effort basis (soft constraint) * `DoNotSchedule` pods must be evenly spread across zones with a maxSkew of 1 (hard constraint) * @type {string} * @memberof ApplicationAdvancedSettings */ 'deployment.topology_spread.zone'?: ApplicationAdvancedSettingsDeploymentTopologySpreadZoneEnum; /** * Allows you to run a command after the application is started. The command should be a shell command or script. * @type {Array} * @memberof ApplicationAdvancedSettings */ 'deployment.lifecycle.post_start_exec_command'?: Array; /** * Allows you to run a command before the application is stopped. The command should be a shell command or script. Qovery requires the sh shell by default and sets a sleep of 15 seconds to let Nginx update its config. Avoiding error codes returned during a rolling update. * @type {Array} * @memberof ApplicationAdvancedSettings */ 'deployment.lifecycle.pre_stop_exec_command'?: Array; /** * * `RollingUpdate` gracefully rollout new versions, and automatically rollback if the new version fails to start * `Recreate` stop all current versions and create new ones once all old ones have been shutdown * @type {string} * @memberof ApplicationAdvancedSettings */ 'deployment.update_strategy.type'?: ApplicationAdvancedSettingsDeploymentUpdateStrategyTypeEnum; /** * Define the percentage of a maximum number of pods that can be unavailable during the update process * @type {number} * @memberof ApplicationAdvancedSettings */ 'deployment.update_strategy.rolling_update.max_unavailable_percent'?: number; /** * Define the percentage of the maximum number of pods that can be created over the desired number of pods * @type {number} * @memberof ApplicationAdvancedSettings */ 'deployment.update_strategy.rolling_update.max_surge_percent'?: number; /** * * @type {number} * @memberof ApplicationAdvancedSettings */ 'build.timeout_max_sec'?: number; /** * define the max cpu resources (in milli) * @type {number} * @memberof ApplicationAdvancedSettings */ 'build.cpu_max_in_milli'?: number; /** * define the max ram resources (in gib) * @type {number} * @memberof ApplicationAdvancedSettings */ 'build.ram_max_in_gib'?: number; /** * disable buildkit registry cache during build * @type {boolean} * @memberof ApplicationAdvancedSettings */ 'build.disable_buildkit_cache'?: boolean; /** * * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.proxy_body_size_mb'?: number; /** * When using SSL offloading outside of cluster, you can enforce a redirect to HTTPS even when there is no TLS certificate available * @type {boolean} * @memberof ApplicationAdvancedSettings */ 'network.ingress.force_ssl_redirect'?: boolean; /** * * @type {boolean} * @memberof ApplicationAdvancedSettings */ 'network.ingress.enable_cors'?: boolean; /** * * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.cors_allow_origin'?: string; /** * * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.cors_allow_methods'?: string; /** * * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.cors_allow_headers'?: string; /** * header buffer size used while reading response header from upstream * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.proxy_buffer_size_kb'?: number; /** * Limits the maximum time (in seconds) during which requests can be processed through one keepalive connection * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.keepalive_time_seconds'?: number; /** * Sets a timeout (in seconds) during which an idle keepalive connection to an upstream server will stay open. * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.keepalive_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a response to the client * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for establishing a connection to a proxied server * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.proxy_connect_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a request to the proxied server * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.proxy_send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for reading a response from the proxied server * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.proxy_read_timeout_seconds'?: number; /** * Allows to enable or disable nginx `proxy-request-buffering` * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.proxy_buffering'?: string; /** * list of source ranges to allow access to ingress proxy. This property can be used to whitelist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 To allow all source ranges, set 0.0.0.0/0. * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.whitelist_source_range'?: string; /** * list of source ranges to deny access to ingress proxy. This property can be used to blacklist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.denylist_source_range'?: string; /** * Set the name of an environment variable to use as a basic authentication (`login:crypted_password`) from `htpasswd` command. * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.basic_auth_env_var'?: string; /** * Enable the load balancer to bind a user\'s session to a specific target. This ensures that all requests from the user during the session are sent to the same target * @type {boolean} * @memberof ApplicationAdvancedSettings */ 'network.ingress.enable_sticky_session'?: boolean; /** * Sets a timeout (in seconds) for transmitting a request to the grpc server * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.grpc_send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a request to the grpc server * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.ingress.grpc_read_timeout_seconds'?: number; /** * Allows to define response headers * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.ingress.extra_headers'?: string; /** * Sets a timeout (in seconds) for requests proxied through the Gateway API route. * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.gateway_api.http_request_timeout_seconds'?: number | null; /** * Sets the idle timeout (in seconds) for HTTP connections proxied through the Gateway API route. * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.gateway_api.http_connection_idle_timeout_seconds'?: number | null; /** * Sets the number of retry attempts for requests proxied through the Gateway API route. * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.gateway_api.retry.num_retries'?: number | null; /** * Comma-separated retry triggers (for example connect-failure,reset,refused-stream,retriable-status-codes) for requests proxied through the Gateway API route. * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.gateway_api.retry.retry_on'?: string | null; /** * Comma-separated HTTP status codes (100..599) retried when retry_on includes retriable-status-codes. * @type {string} * @memberof ApplicationAdvancedSettings */ 'network.gateway_api.retry.http_status_codes'?: string | null; /** * Sets the timeout (in seconds) applied to each retry attempt for requests proxied through the Gateway API route. * @type {number} * @memberof ApplicationAdvancedSettings */ 'network.gateway_api.retry.per_try_timeout_seconds'?: number | null; /** * Percentage value of cpu usage at which point pods should scale up. * @type {number} * @memberof ApplicationAdvancedSettings */ 'hpa.cpu.average_utilization_percent'?: number; /** * Percentage value of memory usage at which point pods should scale up. * @type {number} * @memberof ApplicationAdvancedSettings */ 'hpa.memory.average_utilization_percent'?: number | null; /** * Allows you to set an existing Kubernetes service account name * @type {string} * @memberof ApplicationAdvancedSettings */ 'security.service_account_name'?: string; /** * Automount Kubernetes service account token to have access to Kubernetes API from pods * @type {boolean} * @memberof ApplicationAdvancedSettings */ 'security.automount_service_account_token'?: boolean; /** * Mounts the container\'s root filesystem as read-only * @type {boolean} * @memberof ApplicationAdvancedSettings */ 'security.read_only_root_filesystem'?: boolean; } export declare const ApplicationAdvancedSettingsDeploymentAntiaffinityPodEnum: { readonly PREFERRED: "Preferred"; readonly REQUIRRED: "Requirred"; }; export type ApplicationAdvancedSettingsDeploymentAntiaffinityPodEnum = typeof ApplicationAdvancedSettingsDeploymentAntiaffinityPodEnum[keyof typeof ApplicationAdvancedSettingsDeploymentAntiaffinityPodEnum]; export declare const ApplicationAdvancedSettingsDeploymentTopologySpreadZoneEnum: { readonly DISABLED: "Disabled"; readonly SCHEDULE_ANYWAY: "ScheduleAnyway"; readonly DO_NOT_SCHEDULE: "DoNotSchedule"; }; export type ApplicationAdvancedSettingsDeploymentTopologySpreadZoneEnum = typeof ApplicationAdvancedSettingsDeploymentTopologySpreadZoneEnum[keyof typeof ApplicationAdvancedSettingsDeploymentTopologySpreadZoneEnum]; export declare const ApplicationAdvancedSettingsDeploymentUpdateStrategyTypeEnum: { readonly ROLLING_UPDATE: "RollingUpdate"; readonly RECREATE: "Recreate"; }; export type ApplicationAdvancedSettingsDeploymentUpdateStrategyTypeEnum = typeof ApplicationAdvancedSettingsDeploymentUpdateStrategyTypeEnum[keyof typeof ApplicationAdvancedSettingsDeploymentUpdateStrategyTypeEnum]; /** * * @export * @interface ApplicationDeploymentRestriction */ export interface ApplicationDeploymentRestriction { /** * * @type {string} * @memberof ApplicationDeploymentRestriction */ 'id': string; /** * * @type {string} * @memberof ApplicationDeploymentRestriction */ 'created_at': string; /** * * @type {string} * @memberof ApplicationDeploymentRestriction */ 'updated_at'?: string; /** * * @type {DeploymentRestrictionModeEnum} * @memberof ApplicationDeploymentRestriction */ 'mode': DeploymentRestrictionModeEnum; /** * * @type {DeploymentRestrictionTypeEnum} * @memberof ApplicationDeploymentRestriction */ 'type': DeploymentRestrictionTypeEnum; /** * For `PATH` restrictions, the value must not start with `/` * @type {string} * @memberof ApplicationDeploymentRestriction */ 'value': string; } /** * * @export * @interface ApplicationDeploymentRestrictionRequest */ export interface ApplicationDeploymentRestrictionRequest { /** * * @type {DeploymentRestrictionModeEnum} * @memberof ApplicationDeploymentRestrictionRequest */ 'mode': DeploymentRestrictionModeEnum; /** * * @type {DeploymentRestrictionTypeEnum} * @memberof ApplicationDeploymentRestrictionRequest */ 'type': DeploymentRestrictionTypeEnum; /** * For `PATH` restrictions, the value must not start with `/` * @type {string} * @memberof ApplicationDeploymentRestrictionRequest */ 'value': string; } /** * * @export * @interface ApplicationDeploymentRestrictionResponseList */ export interface ApplicationDeploymentRestrictionResponseList { /** * * @type {Array} * @memberof ApplicationDeploymentRestrictionResponseList */ 'results'?: Array; } /** * * @export * @interface ApplicationEditRequest */ export interface ApplicationEditRequest { /** * * @type {Array} * @memberof ApplicationEditRequest */ 'storage'?: Array; /** * name is case insensitive * @type {string} * @memberof ApplicationEditRequest */ 'name'?: string; /** * give a description to this application * @type {string} * @memberof ApplicationEditRequest */ 'description'?: string; /** * * @type {ApplicationGitRepositoryRequest} * @memberof ApplicationEditRequest */ 'git_repository'?: ApplicationGitRepositoryRequest; /** * * @type {BuildModeEnum} * @memberof ApplicationEditRequest */ 'build_mode'?: BuildModeEnum; /** * The path of the associated Dockerfile * @type {string} * @memberof ApplicationEditRequest */ 'dockerfile_path'?: string | null; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof ApplicationEditRequest */ 'cpu'?: number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof ApplicationEditRequest */ 'memory'?: number; /** * * @type {number} * @memberof ApplicationEditRequest */ 'gpu'?: number; /** * Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running. * @type {number} * @memberof ApplicationEditRequest */ 'min_running_instances'?: number; /** * Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. * @type {number} * @memberof ApplicationEditRequest */ 'max_running_instances'?: number; /** * * @type {Healthcheck} * @memberof ApplicationEditRequest */ 'healthchecks': Healthcheck; /** * Specify if the environment preview option is activated or not for this application. If activated, a preview environment will be automatically cloned at each pull request. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof ApplicationEditRequest */ 'auto_preview'?: boolean; /** * * @type {Array} * @memberof ApplicationEditRequest */ 'ports'?: Array; /** * * @type {Array} * @memberof ApplicationEditRequest */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof ApplicationEditRequest */ 'entrypoint'?: string; /** * Specify if the application will be automatically updated after receiving a new commit. * @type {boolean} * @memberof ApplicationEditRequest */ 'auto_deploy'?: boolean | null; /** * * @type {Array} * @memberof ApplicationEditRequest */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof ApplicationEditRequest */ 'labels_groups'?: Array; /** * Icon URI representing the application. * @type {string} * @memberof ApplicationEditRequest */ 'icon_uri'?: string; /** * The target build stage in the Dockerfile to build * @type {string} * @memberof ApplicationEditRequest */ 'docker_target_build_stage'?: string | null; /** * * @type {AutoscalingPolicyRequest} * @memberof ApplicationEditRequest */ 'autoscaling'?: AutoscalingPolicyRequest; } /** * * @export * @interface ApplicationGitRepository */ export interface ApplicationGitRepository { /** * * @type {boolean} * @memberof ApplicationGitRepository */ 'has_access'?: boolean; /** * * @type {GitProviderEnum} * @memberof ApplicationGitRepository */ 'provider': GitProviderEnum; /** * * @type {string} * @memberof ApplicationGitRepository */ 'owner': string; /** * * @type {string} * @memberof ApplicationGitRepository */ 'url': string; /** * repository name * @type {string} * @memberof ApplicationGitRepository */ 'name': string; /** * * @type {string} * @memberof ApplicationGitRepository */ 'branch'?: string; /** * * @type {string} * @memberof ApplicationGitRepository */ 'root_path'?: string; /** * Git commit ID corresponding to the deployed version of the app * @type {string} * @memberof ApplicationGitRepository */ 'deployed_commit_id'?: string; /** * Git commit date corresponding to the deployed version of the app * @type {string} * @memberof ApplicationGitRepository */ 'deployed_commit_date'?: string; /** * Git commit user corresponding to the deployed version of the app * @type {string} * @memberof ApplicationGitRepository */ 'deployed_commit_contributor'?: string; /** * * @type {string} * @memberof ApplicationGitRepository */ 'deployed_commit_tag'?: string; /** * * @type {string} * @memberof ApplicationGitRepository */ 'git_token_id'?: string | null; /** * * @type {string} * @memberof ApplicationGitRepository */ 'git_token_name'?: string | null; } /** * * @export * @interface ApplicationGitRepositoryRequest */ export interface ApplicationGitRepositoryRequest { /** * application git repository URL * @type {string} * @memberof ApplicationGitRepositoryRequest */ 'url': string; /** * Name of the branch to use. This is optional If not specified, then the branch used is the `main` or `master` one * @type {string} * @memberof ApplicationGitRepositoryRequest */ 'branch'?: string; /** * indicates the root path of the application. * @type {string} * @memberof ApplicationGitRepositoryRequest */ 'root_path'?: string; /** * The git token id on Qovery side * @type {string} * @memberof ApplicationGitRepositoryRequest */ 'git_token_id'?: string | null; /** * * @type {GitProviderEnum} * @memberof ApplicationGitRepositoryRequest */ 'provider': GitProviderEnum; } /** * * @export * @interface ApplicationNetwork */ export interface ApplicationNetwork { /** * Specify if the sticky session option (also called persistant session) is activated or not for this application. If activated, user will be redirected by the load balancer to the same instance each time he access to the application. * @type {boolean} * @memberof ApplicationNetwork */ 'sticky_session'?: boolean; } /** * * @export * @interface ApplicationNetworkRequest */ export interface ApplicationNetworkRequest { /** * Specify if the sticky session option (also called persistant session) is activated or not for this application. If activated, user will be redirected by the load balancer to the same instance each time he access to the application. * @type {boolean} * @memberof ApplicationNetworkRequest */ 'sticky_session'?: boolean; } /** * * @export * @interface ApplicationRequest */ export interface ApplicationRequest { /** * * @type {Array} * @memberof ApplicationRequest */ 'storage'?: Array; /** * * @type {Array} * @memberof ApplicationRequest */ 'ports'?: Array; /** * name is case insensitive * @type {string} * @memberof ApplicationRequest */ 'name': string; /** * give a description to this application * @type {string} * @memberof ApplicationRequest */ 'description'?: string | null; /** * * @type {ApplicationGitRepositoryRequest} * @memberof ApplicationRequest */ 'git_repository': ApplicationGitRepositoryRequest; /** * * @type {BuildModeEnum} * @memberof ApplicationRequest */ 'build_mode'?: BuildModeEnum; /** * The path of the associated Dockerfile. Only if you are using build_mode = DOCKER * @type {string} * @memberof ApplicationRequest */ 'dockerfile_path'?: string | null; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof ApplicationRequest */ 'cpu'?: number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof ApplicationRequest */ 'memory'?: number; /** * * @type {number} * @memberof ApplicationRequest */ 'gpu'?: number; /** * Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running. * @type {number} * @memberof ApplicationRequest */ 'min_running_instances'?: number; /** * Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. * @type {number} * @memberof ApplicationRequest */ 'max_running_instances'?: number; /** * * @type {Healthcheck} * @memberof ApplicationRequest */ 'healthchecks': Healthcheck; /** * Specify if the environment preview option is activated or not for this application. If activated, a preview environment will be automatically cloned at each pull request. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof ApplicationRequest */ 'auto_preview'?: boolean; /** * * @type {Array} * @memberof ApplicationRequest */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof ApplicationRequest */ 'entrypoint'?: string; /** * Specify if the application will be automatically updated after receiving a new commit. * @type {boolean} * @memberof ApplicationRequest */ 'auto_deploy'?: boolean | null; /** * * @type {Array} * @memberof ApplicationRequest */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof ApplicationRequest */ 'labels_groups'?: Array; /** * Icon URI representing the application. * @type {string} * @memberof ApplicationRequest */ 'icon_uri'?: string; /** * The target build stage in the Dockerfile to build * @type {string} * @memberof ApplicationRequest */ 'docker_target_build_stage'?: string | null; /** * * @type {AutoscalingPolicyRequest} * @memberof ApplicationRequest */ 'autoscaling'?: AutoscalingPolicyRequest; } /** * * @export * @interface ApplicationResponseList */ export interface ApplicationResponseList { /** * * @type {Array} * @memberof ApplicationResponseList */ 'results'?: Array; } /** * * @export * @interface ArgoCdConnectionCheckResponse */ export interface ArgoCdConnectionCheckResponse { /** * * @type {ArgoCdConnectionStatusEnum} * @memberof ArgoCdConnectionCheckResponse */ 'status': ArgoCdConnectionStatusEnum; /** * Number of ArgoCD applications visible with the provided token. Present only when status is \"connected\". * @type {number} * @memberof ArgoCdConnectionCheckResponse */ 'app_count'?: number; /** * Failure reason. Present only when status is \"error\". * @type {string} * @memberof ArgoCdConnectionCheckResponse */ 'reason'?: ArgoCdConnectionCheckResponseReasonEnum; } export declare const ArgoCdConnectionCheckResponseReasonEnum: { readonly AUTHENTICATION_FAILED: "authentication_failed"; readonly UNREACHABLE: "unreachable"; readonly INSUFFICIENT_PERMISSIONS: "insufficient_permissions"; }; export type ArgoCdConnectionCheckResponseReasonEnum = typeof ArgoCdConnectionCheckResponseReasonEnum[keyof typeof ArgoCdConnectionCheckResponseReasonEnum]; /** * Connection status of an ArgoCD instance * @export * @enum {string} */ export declare const ArgoCdConnectionStatusEnum: { readonly CONNECTED: "connected"; readonly ERROR: "error"; }; export type ArgoCdConnectionStatusEnum = typeof ArgoCdConnectionStatusEnum[keyof typeof ArgoCdConnectionStatusEnum]; /** * * @export * @interface ArgoCdCredentialsRequest */ export interface ArgoCdCredentialsRequest { /** * The URL of the ArgoCD instance (e.g. https://argocd.example.com) * @type {string} * @memberof ArgoCdCredentialsRequest */ 'argocd_url': string; /** * ArgoCD API authentication token * @type {string} * @memberof ArgoCdCredentialsRequest */ 'argocd_token': string; } /** * * @export * @interface ArgoCdCredentialsResponse */ export interface ArgoCdCredentialsResponse { /** * * @type {string} * @memberof ArgoCdCredentialsResponse */ 'id': string; /** * * @type {string} * @memberof ArgoCdCredentialsResponse */ 'cluster_id': string; /** * * @type {string} * @memberof ArgoCdCredentialsResponse */ 'argocd_url': string; /** * Always returned as REDACTED * @type {string} * @memberof ArgoCdCredentialsResponse */ 'argocd_token': string; /** * * @type {string} * @memberof ArgoCdCredentialsResponse */ 'last_checked_at'?: string | null; /** * * @type {string} * @memberof ArgoCdCredentialsResponse */ 'created_at': string; /** * * @type {string} * @memberof ArgoCdCredentialsResponse */ 'updated_at': string; } /** * * @export * @interface ArgoCdDestinationClusterMappingRequest */ export interface ArgoCdDestinationClusterMappingRequest { /** * ID of the Qovery cluster where the ArgoCD instance is running * @type {string} * @memberof ArgoCdDestinationClusterMappingRequest */ 'agent_cluster_id': string; /** * ArgoCD destination cluster URL as reported by ArgoCD * @type {string} * @memberof ArgoCdDestinationClusterMappingRequest */ 'argocd_cluster_url': string; /** * ID of the Qovery cluster to map this ArgoCD destination to * @type {string} * @memberof ArgoCdDestinationClusterMappingRequest */ 'cluster_id': string; } /** * * @export * @interface ArgoCdDestinationClusterMappingResponse */ export interface ArgoCdDestinationClusterMappingResponse { /** * * @type {string} * @memberof ArgoCdDestinationClusterMappingResponse */ 'agent_cluster_id': string; /** * * @type {string} * @memberof ArgoCdDestinationClusterMappingResponse */ 'argocd_cluster_url': string; /** * * @type {string} * @memberof ArgoCdDestinationClusterMappingResponse */ 'cluster_id': string | null; } /** * * @export * @interface ArgoCdInstanceMappingResponse */ export interface ArgoCdInstanceMappingResponse { /** * ID of the Qovery cluster where the ArgoCD instance is running * @type {string} * @memberof ArgoCdInstanceMappingResponse */ 'agent_cluster_id': string; /** * Display name of the Qovery cluster where the ArgoCD instance is running * @type {string} * @memberof ArgoCdInstanceMappingResponse */ 'agent_cluster_name': string; /** * * @type {CloudVendorEnum} * @memberof ArgoCdInstanceMappingResponse */ 'agent_cluster_cloud_provider': CloudVendorEnum; /** * ID of the stored ArgoCD credentials for this instance * @type {string} * @memberof ArgoCdInstanceMappingResponse */ 'credentials_id': string; /** * URL of the ArgoCD instance * @type {string} * @memberof ArgoCdInstanceMappingResponse */ 'argocd_url': string; /** * * @type {ArgoCdConnectionStatusEnum} * @memberof ArgoCdInstanceMappingResponse */ 'status': ArgoCdConnectionStatusEnum; /** * Timestamp of the last configuration update (will use last connectivity check in future) * @type {string} * @memberof ArgoCdInstanceMappingResponse */ 'last_checked_at': string; /** * ArgoCD clusters detected and mapped to a Qovery cluster * @type {Array} * @memberof ArgoCdInstanceMappingResponse */ 'linked_clusters': Array; /** * ArgoCD clusters detected but mapping is missing * @type {Array} * @memberof ArgoCdInstanceMappingResponse */ 'unlinked_clusters': Array; } /** * * @export * @interface ArgoCdInstanceMappingResponseList */ export interface ArgoCdInstanceMappingResponseList { /** * * @type {Array} * @memberof ArgoCdInstanceMappingResponseList */ 'results': Array; } /** * * @export * @interface ArgoCdLinkedClusterDetails */ export interface ArgoCdLinkedClusterDetails { /** * ArgoCD destination cluster URL * @type {string} * @memberof ArgoCdLinkedClusterDetails */ 'argocd_cluster_url': string; /** * ArgoCD cluster name (currently same as URL; will use ArgoCD alias in future) * @type {string} * @memberof ArgoCdLinkedClusterDetails */ 'argocd_cluster_name': string; /** * ID of the Qovery cluster this destination is mapped to * @type {string} * @memberof ArgoCdLinkedClusterDetails */ 'qovery_cluster_id': string; /** * Display name of the mapped Qovery cluster * @type {string} * @memberof ArgoCdLinkedClusterDetails */ 'qovery_cluster_name': string; /** * * @type {CloudVendorEnum} * @memberof ArgoCdLinkedClusterDetails */ 'qovery_cluster_cloud_provider': CloudVendorEnum; /** * * @type {KubernetesEnum} * @memberof ArgoCdLinkedClusterDetails */ 'qovery_cluster_type': KubernetesEnum; /** * Number of ArgoCD applications targeting this destination * @type {number} * @memberof ArgoCdLinkedClusterDetails */ 'applications_count': number; } /** * * @export * @interface ArgoCdUnlinkedClusterDetails */ export interface ArgoCdUnlinkedClusterDetails { /** * ArgoCD destination cluster URL for this stale mapping * @type {string} * @memberof ArgoCdUnlinkedClusterDetails */ 'argocd_cluster_url': string; /** * ArgoCD cluster name (currently same as URL; will use ArgoCD alias in future) * @type {string} * @memberof ArgoCdUnlinkedClusterDetails */ 'argocd_cluster_name': string; /** * Number of ArgoCD applications targeting this destination * @type {number} * @memberof ArgoCdUnlinkedClusterDetails */ 'applications_count': number; } /** * * @export * @interface ArgocdAppManifestResponse */ export interface ArgocdAppManifestResponse { /** * Git revision the app is currently synced to * @type {string} * @memberof ArgocdAppManifestResponse */ 'manifest_revision'?: string | null; /** * * @type {ArgocdAppManifestResponseManifestMetadata} * @memberof ArgocdAppManifestResponse */ 'manifest_metadata': ArgocdAppManifestResponseManifestMetadata; } /** * Raw enrichment data fetched from the ArgoCD managed-resources API * @export * @interface ArgocdAppManifestResponseManifestMetadata */ export interface ArgocdAppManifestResponseManifestMetadata { /** * * @type {Array} * @memberof ArgocdAppManifestResponseManifestMetadata */ 'managed_resources'?: Array; } /** * An ArgoCD service * @export * @interface ArgocdAppResponse */ export interface ArgocdAppResponse { /** * * @type {string} * @memberof ArgocdAppResponse */ 'id': string; /** * * @type {string} * @memberof ArgocdAppResponse */ 'created_at': string; /** * * @type {string} * @memberof ArgocdAppResponse */ 'updated_at'?: string; /** * name is case insensitive * @type {string} * @memberof ArgocdAppResponse */ 'name': string; /** * * @type {ServiceTypeEnum} * @memberof ArgocdAppResponse */ 'service_type': ServiceTypeEnum; /** * * @type {string} * @memberof ArgocdAppResponse */ 'namespace': string; /** * * @type {ReferenceObject} * @memberof ArgocdAppResponse */ 'environment': ReferenceObject; /** * * @type {string} * @memberof ArgocdAppResponse */ 'environment_id': string; /** * * @type {string} * @memberof ArgocdAppResponse */ 'cluster_id': string; /** * Icon URI representing the ArgoCD service. * @type {string} * @memberof ArgocdAppResponse */ 'icon_uri': string; /** * * @type {string} * @memberof ArgocdAppResponse */ 'last_synced_at'?: string | null; /** * * @type {string} * @memberof ArgocdAppResponse */ 'manifest_revision'?: string | null; /** * * @type {ApplicationGitRepository} * @memberof ArgocdAppResponse */ 'git_repository'?: ApplicationGitRepository | null; } /** * * @export * @interface ArgocdManagedResource */ export interface ArgocdManagedResource { /** * Kubernetes resource kind (e.g. Deployment, Service) * @type {string} * @memberof ArgocdManagedResource */ 'kind'?: string; /** * * @type {string} * @memberof ArgocdManagedResource */ 'name'?: string; /** * * @type {string} * @memberof ArgocdManagedResource */ 'namespace'?: string; /** * JSON-encoded desired Kubernetes manifest * @type {string} * @memberof ArgocdManagedResource */ 'targetState'?: string; /** * JSON-encoded live Kubernetes manifest * @type {string} * @memberof ArgocdManagedResource */ 'liveState'?: string; } /** * * @export * @interface AttachServiceToDeploymentStageRequest */ export interface AttachServiceToDeploymentStageRequest { /** * When true, marks the service as skipped (excluded from environment-level bulk deployments) while keeping it in the specified stage. When false or omitted, the service is moved to the specified stage and un-skipped. * @type {boolean} * @memberof AttachServiceToDeploymentStageRequest */ 'is_skipped'?: boolean; } /** * * @export * @interface AutomaticallyConfiguredAuthDto */ export interface AutomaticallyConfiguredAuthDto { /** * * @type {string} * @memberof AutomaticallyConfiguredAuthDto */ 'mode': AutomaticallyConfiguredAuthDtoModeEnum; } export declare const AutomaticallyConfiguredAuthDtoModeEnum: { readonly AUTOMATICALLY_CONFIGURED: "AUTOMATICALLY_CONFIGURED"; }; export type AutomaticallyConfiguredAuthDtoModeEnum = typeof AutomaticallyConfiguredAuthDtoModeEnum[keyof typeof AutomaticallyConfiguredAuthDtoModeEnum]; /** * * @export * @enum {string} */ export declare const AutoscalingMode: { readonly KEDA: "KEDA"; }; export type AutoscalingMode = typeof AutoscalingMode[keyof typeof AutoscalingMode]; /** * @type AutoscalingPolicyRequest * @export */ export type AutoscalingPolicyRequest = { mode: 'KEDA'; } & KedaAutoscalingRequest; /** * @type AutoscalingPolicyResponse * @export */ export type AutoscalingPolicyResponse = { mode: 'KEDA'; } & KedaAutoscalingResponse; /** * * @export * @interface AvailableContainerRegistryResponse */ export interface AvailableContainerRegistryResponse { /** * * @type {ContainerRegistryKindEnum} * @memberof AvailableContainerRegistryResponse */ 'kind': ContainerRegistryKindEnum; /** * * @type {{ [key: string]: any; }} * @memberof AvailableContainerRegistryResponse */ 'required_config': { [key: string]: any; }; /** * * @type {boolean} * @memberof AvailableContainerRegistryResponse */ 'is_mandatory': boolean; } /** * * @export * @interface AvailableContainerRegistryResponseList */ export interface AvailableContainerRegistryResponseList { /** * * @type {Array} * @memberof AvailableContainerRegistryResponseList */ 'results'?: Array; } /** * * @export * @interface AvailableHelmRepositoryResponse */ export interface AvailableHelmRepositoryResponse { /** * * @type {HelmRepositoryKindEnum} * @memberof AvailableHelmRepositoryResponse */ 'kind': HelmRepositoryKindEnum; /** * * @type {{ [key: string]: any; }} * @memberof AvailableHelmRepositoryResponse */ 'required_config': { [key: string]: any; }; /** * * @type {boolean} * @memberof AvailableHelmRepositoryResponse */ 'is_mandatory': boolean; } /** * * @export * @interface AvailableHelmRepositoryResponseList */ export interface AvailableHelmRepositoryResponseList { /** * * @type {Array} * @memberof AvailableHelmRepositoryResponseList */ 'results'?: Array; } /** * @type AwsCredentialsRequest * @export */ export type AwsCredentialsRequest = { type: 'AWS_ROLE'; } & AwsRoleCredentialsRequest | { type: 'AWS_STATIC'; } & AwsStaticCredentialsRequest | { type: 'EKS_ANYWHERE_VSPHERE_ROLE'; } & EksAnywhereVsphereRoleCredentialsRequest | { type: 'EKS_ANYWHERE_VSPHERE_STATIC'; } & EksAnywhereVsphereStaticCredentialsRequest; /** * * @export * @interface AwsParameterStoreEndpointDto */ export interface AwsParameterStoreEndpointDto { /** * * @type {string} * @memberof AwsParameterStoreEndpointDto */ 'mode': AwsParameterStoreEndpointDtoModeEnum; /** * * @type {string} * @memberof AwsParameterStoreEndpointDto */ 'region': string; } export declare const AwsParameterStoreEndpointDtoModeEnum: { readonly AWS_PARAMETER_STORE: "AWS_PARAMETER_STORE"; }; export type AwsParameterStoreEndpointDtoModeEnum = typeof AwsParameterStoreEndpointDtoModeEnum[keyof typeof AwsParameterStoreEndpointDtoModeEnum]; /** * * @export * @interface AwsRoleArnAuthDto */ export interface AwsRoleArnAuthDto { /** * * @type {string} * @memberof AwsRoleArnAuthDto */ 'mode': AwsRoleArnAuthDtoModeEnum; /** * * @type {string} * @memberof AwsRoleArnAuthDto */ 'role_arn': string; } export declare const AwsRoleArnAuthDtoModeEnum: { readonly AWS_ROLE_ARN: "AWS_ROLE_ARN"; }; export type AwsRoleArnAuthDtoModeEnum = typeof AwsRoleArnAuthDtoModeEnum[keyof typeof AwsRoleArnAuthDtoModeEnum]; /** * * @export * @interface AwsRoleClusterCredentials */ export interface AwsRoleClusterCredentials { /** * * @type {string} * @memberof AwsRoleClusterCredentials */ 'id': string; /** * * @type {string} * @memberof AwsRoleClusterCredentials */ 'name': string; /** * * @type {string} * @memberof AwsRoleClusterCredentials */ 'role_arn': string; /** * * @type {string} * @memberof AwsRoleClusterCredentials */ 'object_type': AwsRoleClusterCredentialsObjectTypeEnum; } export declare const AwsRoleClusterCredentialsObjectTypeEnum: { readonly AWS_ROLE: "AWS_ROLE"; }; export type AwsRoleClusterCredentialsObjectTypeEnum = typeof AwsRoleClusterCredentialsObjectTypeEnum[keyof typeof AwsRoleClusterCredentialsObjectTypeEnum]; /** * * @export * @interface AwsRoleCredentialsRequest */ export interface AwsRoleCredentialsRequest { /** * * @type {string} * @memberof AwsRoleCredentialsRequest */ 'type': AwsRoleCredentialsRequestTypeEnum; /** * * @type {string} * @memberof AwsRoleCredentialsRequest */ 'name': string; /** * * @type {string} * @memberof AwsRoleCredentialsRequest */ 'role_arn': string; } export declare const AwsRoleCredentialsRequestTypeEnum: { readonly AWS_ROLE: "AWS_ROLE"; }; export type AwsRoleCredentialsRequestTypeEnum = typeof AwsRoleCredentialsRequestTypeEnum[keyof typeof AwsRoleCredentialsRequestTypeEnum]; /** * * @export * @interface AwsSecretManagerEndpointDto */ export interface AwsSecretManagerEndpointDto { /** * * @type {string} * @memberof AwsSecretManagerEndpointDto */ 'mode': AwsSecretManagerEndpointDtoModeEnum; /** * * @type {string} * @memberof AwsSecretManagerEndpointDto */ 'region': string; } export declare const AwsSecretManagerEndpointDtoModeEnum: { readonly AWS_SECRET_MANAGER: "AWS_SECRET_MANAGER"; }; export type AwsSecretManagerEndpointDtoModeEnum = typeof AwsSecretManagerEndpointDtoModeEnum[keyof typeof AwsSecretManagerEndpointDtoModeEnum]; /** * * @export * @interface AwsStaticClusterCredentials */ export interface AwsStaticClusterCredentials { /** * * @type {string} * @memberof AwsStaticClusterCredentials */ 'id': string; /** * * @type {string} * @memberof AwsStaticClusterCredentials */ 'name': string; /** * * @type {string} * @memberof AwsStaticClusterCredentials */ 'access_key_id': string; /** * * @type {string} * @memberof AwsStaticClusterCredentials */ 'object_type': AwsStaticClusterCredentialsObjectTypeEnum; } export declare const AwsStaticClusterCredentialsObjectTypeEnum: { readonly AWS: "AWS"; }; export type AwsStaticClusterCredentialsObjectTypeEnum = typeof AwsStaticClusterCredentialsObjectTypeEnum[keyof typeof AwsStaticClusterCredentialsObjectTypeEnum]; /** * * @export * @interface AwsStaticCredentialsAuthDto */ export interface AwsStaticCredentialsAuthDto { /** * * @type {string} * @memberof AwsStaticCredentialsAuthDto */ 'mode': AwsStaticCredentialsAuthDtoModeEnum; /** * * @type {string} * @memberof AwsStaticCredentialsAuthDto */ 'region': string; /** * * @type {string} * @memberof AwsStaticCredentialsAuthDto */ 'access_key': string; /** * * @type {string} * @memberof AwsStaticCredentialsAuthDto */ 'secret_key'?: string | null; } export declare const AwsStaticCredentialsAuthDtoModeEnum: { readonly AWS_STATIC_CREDENTIALS: "AWS_STATIC_CREDENTIALS"; }; export type AwsStaticCredentialsAuthDtoModeEnum = typeof AwsStaticCredentialsAuthDtoModeEnum[keyof typeof AwsStaticCredentialsAuthDtoModeEnum]; /** * * @export * @interface AwsStaticCredentialsRequest */ export interface AwsStaticCredentialsRequest { /** * * @type {string} * @memberof AwsStaticCredentialsRequest */ 'type': AwsStaticCredentialsRequestTypeEnum; /** * * @type {string} * @memberof AwsStaticCredentialsRequest */ 'name': string; /** * * @type {string} * @memberof AwsStaticCredentialsRequest */ 'access_key_id': string; /** * * @type {string} * @memberof AwsStaticCredentialsRequest */ 'secret_access_key': string; } export declare const AwsStaticCredentialsRequestTypeEnum: { readonly AWS_STATIC: "AWS_STATIC"; }; export type AwsStaticCredentialsRequestTypeEnum = typeof AwsStaticCredentialsRequestTypeEnum[keyof typeof AwsStaticCredentialsRequestTypeEnum]; /** * * @export * @interface AzureCredentialsRequest */ export interface AzureCredentialsRequest { /** * * @type {string} * @memberof AzureCredentialsRequest */ 'name': string; /** * * @type {string} * @memberof AzureCredentialsRequest */ 'azure_subscription_id': string; /** * * @type {string} * @memberof AzureCredentialsRequest */ 'azure_tenant_id': string; } /** * * @export * @interface AzureStaticClusterCredentials */ export interface AzureStaticClusterCredentials { /** * * @type {string} * @memberof AzureStaticClusterCredentials */ 'id': string; /** * * @type {string} * @memberof AzureStaticClusterCredentials */ 'name': string; /** * * @type {string} * @memberof AzureStaticClusterCredentials */ 'azure_subscription_id': string; /** * * @type {string} * @memberof AzureStaticClusterCredentials */ 'azure_tenant_id': string; /** * * @type {string} * @memberof AzureStaticClusterCredentials */ 'object_type': AzureStaticClusterCredentialsObjectTypeEnum; /** * * @type {string} * @memberof AzureStaticClusterCredentials */ 'azure_application_id': string; /** * * @type {string} * @memberof AzureStaticClusterCredentials */ 'azure_application_object_id': string; } export declare const AzureStaticClusterCredentialsObjectTypeEnum: { readonly AZURE: "AZURE"; }; export type AzureStaticClusterCredentialsObjectTypeEnum = typeof AzureStaticClusterCredentialsObjectTypeEnum[keyof typeof AzureStaticClusterCredentialsObjectTypeEnum]; /** * * @export * @interface Backup */ export interface Backup { /** * * @type {string} * @memberof Backup */ 'id': string; /** * * @type {string} * @memberof Backup */ 'created_at': string; /** * * @type {string} * @memberof Backup */ 'updated_at'?: string; /** * * @type {string} * @memberof Backup */ 'name': string; /** * * @type {string} * @memberof Backup */ 'message': string; /** * * @type {Status} * @memberof Backup */ 'status'?: Status; } /** * * @export * @interface BackupPaginatedResponseList */ export interface BackupPaginatedResponseList { /** * * @type {number} * @memberof BackupPaginatedResponseList */ 'page': number; /** * * @type {number} * @memberof BackupPaginatedResponseList */ 'page_size': number; /** * * @type {Array} * @memberof BackupPaginatedResponseList */ 'results'?: Array; } /** * * @export * @interface BackupRequest */ export interface BackupRequest { /** * * @type {string} * @memberof BackupRequest */ 'name': string; /** * * @type {string} * @memberof BackupRequest */ 'message': string; } /** * * @export * @interface BackupResponseList */ export interface BackupResponseList { /** * * @type {Array} * @memberof BackupResponseList */ 'results'?: Array; } /** * * @export * @interface Base */ export interface Base { /** * * @type {string} * @memberof Base */ 'id': string; /** * * @type {string} * @memberof Base */ 'created_at': string; /** * * @type {string} * @memberof Base */ 'updated_at'?: string; } /** * * @export * @interface BaseJobResponse */ export interface BaseJobResponse { /** * * @type {string} * @memberof BaseJobResponse */ 'id': string; /** * * @type {string} * @memberof BaseJobResponse */ 'created_at': string; /** * * @type {string} * @memberof BaseJobResponse */ 'updated_at'?: string; /** * * @type {ReferenceObject} * @memberof BaseJobResponse */ 'environment': ReferenceObject; /** * Maximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof BaseJobResponse */ 'maximum_cpu': number; /** * Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof BaseJobResponse */ 'maximum_memory': number; /** * Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof BaseJobResponse */ 'maximum_gpu': number; /** * name is case insensitive * @type {string} * @memberof BaseJobResponse */ 'name': string; /** * * @type {string} * @memberof BaseJobResponse */ 'description'?: string; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof BaseJobResponse */ 'cpu': number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof BaseJobResponse */ 'memory': number; /** * * @type {number} * @memberof BaseJobResponse */ 'gpu': number; /** * Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed * @type {number} * @memberof BaseJobResponse */ 'max_nb_restart'?: number; /** * Maximum number of seconds allowed for the job to run before killing it and mark it as failed * @type {number} * @memberof BaseJobResponse */ 'max_duration_seconds'?: number; /** * Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof BaseJobResponse */ 'auto_preview': boolean; /** * Port where to run readiness and liveliness probes checks. The port will not be exposed externally * @type {number} * @memberof BaseJobResponse */ 'port'?: number | null; /** * * @type {BaseJobResponseAllOfSource} * @memberof BaseJobResponse */ 'source': BaseJobResponseAllOfSource; /** * * @type {Healthcheck} * @memberof BaseJobResponse */ 'healthchecks': Healthcheck; /** * Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the \"Auto Deploy job\" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments * @type {boolean} * @memberof BaseJobResponse */ 'auto_deploy'?: boolean; /** * Icon URI representing the job. * @type {string} * @memberof BaseJobResponse */ 'icon_uri': string; /** * * @type {ServiceTypeEnum} * @memberof BaseJobResponse */ 'service_type': ServiceTypeEnum; } /** * @type BaseJobResponseAllOfSource * @export */ export type BaseJobResponseAllOfSource = BaseJobResponseAllOfSourceOneOf | BaseJobResponseAllOfSourceOneOf1; /** * * @export * @interface BaseJobResponseAllOfSourceOneOf */ export interface BaseJobResponseAllOfSourceOneOf { /** * * @type {ContainerSource} * @memberof BaseJobResponseAllOfSourceOneOf */ 'image': ContainerSource; } /** * * @export * @interface BaseJobResponseAllOfSourceOneOf1 */ export interface BaseJobResponseAllOfSourceOneOf1 { /** * * @type {JobSourceDockerResponse} * @memberof BaseJobResponseAllOfSourceOneOf1 */ 'docker': JobSourceDockerResponse; } /** * * @export * @interface BillingExternalId */ export interface BillingExternalId { /** * * @type {string} * @memberof BillingExternalId */ 'id'?: string; } /** * * @export * @interface BillingInfo */ export interface BillingInfo { /** * * @type {string} * @memberof BillingInfo */ 'first_name'?: string | null; /** * * @type {string} * @memberof BillingInfo */ 'last_name'?: string | null; /** * email used for billing, and to receive all invoices by email * @type {string} * @memberof BillingInfo */ 'email'?: string | null; /** * * @type {string} * @memberof BillingInfo */ 'address'?: string | null; /** * * @type {string} * @memberof BillingInfo */ 'city'?: string | null; /** * * @type {string} * @memberof BillingInfo */ 'zip'?: string | null; /** * only for US * @type {string} * @memberof BillingInfo */ 'state'?: string | null; /** * ISO code of the country * @type {string} * @memberof BillingInfo */ 'country_code'?: string | null; /** * name of the company to bill * @type {string} * @memberof BillingInfo */ 'company'?: string | null; /** * * @type {string} * @memberof BillingInfo */ 'vat_number'?: string | null; } /** * * @export * @interface BillingInfoRequest */ export interface BillingInfoRequest { /** * * @type {string} * @memberof BillingInfoRequest */ 'first_name': string; /** * * @type {string} * @memberof BillingInfoRequest */ 'last_name': string; /** * email used for billing, and to receive all invoices by email * @type {string} * @memberof BillingInfoRequest */ 'email': string; /** * * @type {string} * @memberof BillingInfoRequest */ 'address': string; /** * * @type {string} * @memberof BillingInfoRequest */ 'city': string; /** * * @type {string} * @memberof BillingInfoRequest */ 'zip': string; /** * only for US * @type {string} * @memberof BillingInfoRequest */ 'state'?: string; /** * ISO code of the country * @type {string} * @memberof BillingInfoRequest */ 'country_code': string; /** * name of the company to bill * @type {string} * @memberof BillingInfoRequest */ 'company'?: string; /** * * @type {string} * @memberof BillingInfoRequest */ 'vat_number'?: string; } /** * * @export * @interface BillingStatus */ export interface BillingStatus { /** * * @type {boolean} * @memberof BillingStatus */ 'is_valid'?: boolean; /** * * @type {string} * @memberof BillingStatus */ 'message'?: string; } /** * * @export * @interface Budget */ export interface Budget { /** * * @type {number} * @memberof Budget */ 'total_in_cents'?: number; /** * * @type {number} * @memberof Budget */ 'total'?: number; /** * * @type {string} * @memberof Budget */ 'currency_code'?: string; } /** * `DOCKER` requires `dockerfile_path` * @export * @enum {string} */ export declare const BuildModeEnum: { readonly DOCKER: "DOCKER"; }; export type BuildModeEnum = typeof BuildModeEnum[keyof typeof BuildModeEnum]; /** * * @export * @interface CancelEnvironmentDeploymentRequest */ export interface CancelEnvironmentDeploymentRequest { /** * Force cancel everything running in this environment if set to true (e.q lifecycle jobs triggered during the deployment). * @type {boolean} * @memberof CancelEnvironmentDeploymentRequest */ 'force_cancel'?: boolean; } /** * * @export * @interface CheckedCustomDomainResponse */ export interface CheckedCustomDomainResponse { /** * domain name checked * @type {string} * @memberof CheckedCustomDomainResponse */ 'domain_name': string; /** * * @type {CheckedCustomDomainStatus} * @memberof CheckedCustomDomainResponse */ 'status': CheckedCustomDomainStatus; /** * optional field containing information about failure check * @type {string} * @memberof CheckedCustomDomainResponse */ 'error_details'?: string | null; } /** * This enum represents the final status for your domain. There are 2 successful statuses: * `RESOLVES_TO_IP`: we succeeded to resolve an IP to your domain. This is the successful final status for custom domains where `use_cdn` is `true` * `MATCHES_LOAD_BALANCER_HOST`: we succeeded to lookup CNAMEs & found that it matches your cluser Load Balancer host. This is the successful final status for custom domain where `use_cdn` is `false` * `DOMAIN_NOT_CONFIGURED`: the domain is not configured, look at the `error_details` field for more information * `DOMAIN_LINKED_TO_WRONG_HOST`: the domain has CNAME(s) that matches a different host than your Load Balancer one * `GENERIC_FAILURE`: an error occured when attempting to validate your domain, look at the `error_details` field for more information * @export * @enum {string} */ export declare const CheckedCustomDomainStatus: { readonly RESOLVES_TO_IP: "RESOLVES_TO_IP"; readonly MATCHES_LOAD_BALANCER_HOST: "MATCHES_LOAD_BALANCER_HOST"; readonly DOMAIN_NOT_CONFIGURED: "DOMAIN_NOT_CONFIGURED"; readonly DOMAIN_LINKED_TO_WRONG_HOST: "DOMAIN_LINKED_TO_WRONG_HOST"; readonly GENERIC_FAILURE: "GENERIC_FAILURE"; }; export type CheckedCustomDomainStatus = typeof CheckedCustomDomainStatus[keyof typeof CheckedCustomDomainStatus]; /** * * @export * @interface CheckedCustomDomainsResponse */ export interface CheckedCustomDomainsResponse { /** * * @type {Array} * @memberof CheckedCustomDomainsResponse */ 'results': Array; } /** * * @export * @interface CleanFailedJob200Response */ export interface CleanFailedJob200Response { /** * * @type {Array} * @memberof CleanFailedJob200Response */ 'clean_kubernetes_jobs'?: Array; } /** * * @export * @interface CleanFailedJobs200Response */ export interface CleanFailedJobs200Response { /** * * @type {Array} * @memberof CleanFailedJobs200Response */ 'clean_job_ids'?: Array; /** * * @type {Array} * @memberof CleanFailedJobs200Response */ 'clean_kubernetes_jobs'?: Array; } /** * * @export * @interface CleanFailedJobsRequest */ export interface CleanFailedJobsRequest { /** * * @type {Array} * @memberof CleanFailedJobsRequest */ 'job_ids'?: Array; } /** * * @export * @interface CloneEnvironmentRequest */ export interface CloneEnvironmentRequest { /** * name is case insensitive * @type {string} * @memberof CloneEnvironmentRequest */ 'name': string; /** * * @type {string} * @memberof CloneEnvironmentRequest */ 'cluster_id'?: string; /** * * @type {EnvironmentModeEnum} * @memberof CloneEnvironmentRequest */ 'mode'?: EnvironmentModeEnum; /** * * @type {boolean} * @memberof CloneEnvironmentRequest */ 'apply_deployment_rule'?: boolean; /** * * @type {string} * @memberof CloneEnvironmentRequest */ 'project_id'?: string; } /** * * @export * @interface CloneServiceRequest */ export interface CloneServiceRequest { /** * * @type {string} * @memberof CloneServiceRequest */ 'name': string; /** * * @type {string} * @memberof CloneServiceRequest */ 'environment_id': string; } /** * * @export * @interface CloudProvider */ export interface CloudProvider { /** * * @type {string} * @memberof CloudProvider */ 'short_name'?: string; /** * * @type {string} * @memberof CloudProvider */ 'name'?: string; /** * * @type {string} * @memberof CloudProvider */ 'logo_url'?: string; /** * * @type {Array} * @memberof CloudProvider */ 'regions'?: Array; } /** * * @export * @enum {string} */ export declare const CloudProviderEnum: { readonly AWS: "AWS"; readonly SCW: "SCW"; readonly GCP: "GCP"; readonly ON_PREMISE: "ON_PREMISE"; readonly AZURE: "AZURE"; }; export type CloudProviderEnum = typeof CloudProviderEnum[keyof typeof CloudProviderEnum]; /** * * @export * @interface CloudProviderResponseList */ export interface CloudProviderResponseList { /** * * @type {Array} * @memberof CloudProviderResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const CloudVendorEnum: { readonly AWS: "AWS"; readonly SCW: "SCW"; readonly GCP: "GCP"; readonly DO: "DO"; readonly AZURE: "AZURE"; readonly OVH: "OVH"; readonly CIVO: "CIVO"; readonly HETZNER: "HETZNER"; readonly ORACLE: "ORACLE"; readonly IBM: "IBM"; readonly ON_PREMISE: "ON_PREMISE"; }; export type CloudVendorEnum = typeof CloudVendorEnum[keyof typeof CloudVendorEnum]; /** * * @export * @interface CloudWatchExportConfig */ export interface CloudWatchExportConfig { /** * To enable the cloudwatch exporter. * @type {boolean} * @memberof CloudWatchExportConfig */ 'enabled': boolean; } /** * * @export * @interface CloudflareDnsProviderRequest */ export interface CloudflareDnsProviderRequest { /** * * @type {string} * @memberof CloudflareDnsProviderRequest */ 'provider': CloudflareDnsProviderRequestProviderEnum; /** * * @type {string} * @memberof CloudflareDnsProviderRequest */ 'domain': string; /** * * @type {string} * @memberof CloudflareDnsProviderRequest */ 'email': string; /** * Cloudflare API token. Must be provided when editing Cloudflare DNS provider. * @type {string} * @memberof CloudflareDnsProviderRequest */ 'api_token': string; /** * * @type {boolean} * @memberof CloudflareDnsProviderRequest */ 'proxied'?: boolean; } export declare const CloudflareDnsProviderRequestProviderEnum: { readonly CLOUDFLARE: "CLOUDFLARE"; }; export type CloudflareDnsProviderRequestProviderEnum = typeof CloudflareDnsProviderRequestProviderEnum[keyof typeof CloudflareDnsProviderRequestProviderEnum]; /** * * @export * @interface CloudflareDnsProviderResponse */ export interface CloudflareDnsProviderResponse { /** * * @type {string} * @memberof CloudflareDnsProviderResponse */ 'provider': CloudflareDnsProviderResponseProviderEnum; /** * * @type {string} * @memberof CloudflareDnsProviderResponse */ 'domain': string; /** * * @type {string} * @memberof CloudflareDnsProviderResponse */ 'email': string; /** * * @type {boolean} * @memberof CloudflareDnsProviderResponse */ 'proxied': boolean; } export declare const CloudflareDnsProviderResponseProviderEnum: { readonly CLOUDFLARE: "CLOUDFLARE"; }; export type CloudflareDnsProviderResponseProviderEnum = typeof CloudflareDnsProviderResponseProviderEnum[keyof typeof CloudflareDnsProviderResponseProviderEnum]; /** * * @export * @interface Cluster */ export interface Cluster { /** * * @type {string} * @memberof Cluster */ 'id': string; /** * * @type {string} * @memberof Cluster */ 'created_at': string; /** * * @type {string} * @memberof Cluster */ 'updated_at'?: string; /** * * @type {ReferenceObject} * @memberof Cluster */ 'organization': ReferenceObject; /** * name is case-insensitive * @type {string} * @memberof Cluster */ 'name': string; /** * * @type {string} * @memberof Cluster */ 'description'?: string; /** * * @type {string} * @memberof Cluster */ 'region': string; /** * * @type {CloudVendorEnum} * @memberof Cluster */ 'cloud_provider': CloudVendorEnum; /** * * @type {number} * @memberof Cluster */ 'min_running_nodes'?: number; /** * * @type {number} * @memberof Cluster */ 'max_running_nodes'?: number; /** * Unit is in GB. The disk size to be used for the node configuration * @type {number} * @memberof Cluster */ 'disk_size'?: number; /** * Unit is operation/seconds. The disk IOPS to be used for the node configuration * @type {number} * @memberof Cluster */ 'disk_iops'?: number; /** * Unit is in MB/s. The disk thoughput to be used for the node configuration * @type {number} * @memberof Cluster */ 'disk_throughput'?: number; /** * the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType * @type {string} * @memberof Cluster */ 'instance_type'?: string; /** * * @type {KubernetesEnum} * @memberof Cluster */ 'kubernetes'?: KubernetesEnum; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof Cluster */ 'cpu'?: number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof Cluster */ 'memory'?: number; /** * This is an estimation of the cost this cluster will represent on your cloud proider bill, based on your current configuration * @type {number} * @memberof Cluster */ 'estimated_cloud_provider_cost'?: number; /** * * @type {ClusterStateEnum} * @memberof Cluster */ 'status'?: ClusterStateEnum; /** * * @type {boolean} * @memberof Cluster */ 'has_access'?: boolean; /** * * @type {string} * @memberof Cluster */ 'version'?: string; /** * * @type {boolean} * @memberof Cluster */ 'is_default'?: boolean; /** * specific flag to indicate that this cluster is a demo one * @type {boolean} * @memberof Cluster */ 'is_demo'?: boolean; /** * specific flag to indicate that this cluster is a production one * @type {boolean} * @memberof Cluster */ 'production'?: boolean; /** * Indicate your public ssh_key to remotely connect to your EC2 instance. * @type {Array} * @memberof Cluster */ 'ssh_keys'?: Array; /** * * @type {Array} * @memberof Cluster */ 'features'?: Array; /** * * @type {ClusterDeploymentStatusEnum} * @memberof Cluster */ 'deployment_status'?: ClusterDeploymentStatusEnum; /** * * @type {MetricsParameters} * @memberof Cluster */ 'metrics_parameters'?: MetricsParameters; /** * * @type {InfrastructureOutputs} * @memberof Cluster */ 'infrastructure_outputs'?: InfrastructureOutputs; /** * * @type {ClusterInfrastructureChartsParameters} * @memberof Cluster */ 'infrastructure_charts_parameters'?: ClusterInfrastructureChartsParameters; /** * * @type {ClusterKeda} * @memberof Cluster */ 'keda'?: ClusterKeda; /** * * @type {Array} * @memberof Cluster */ 'labels_groups'?: Array; /** * * @type {Array} * @memberof Cluster */ 'secret_manager_accesses'?: Array; } /** * * @export * @interface ClusterAdvancedSettings */ export interface ClusterAdvancedSettings { /** * Set the number of retention days for EKS Cloudwatch logs * @type {number} * @memberof ClusterAdvancedSettings */ 'aws.cloudwatch.eks_logs_retention_days'?: number; /** * Enable flow logs for on the VPC and store them in an S3 bucket * @type {boolean} * @memberof ClusterAdvancedSettings */ 'aws.vpc.enable_s3_flow_logs'?: boolean; /** * Set the number of retention days for flow logs. Disable with value \"0\" * @type {number} * @memberof ClusterAdvancedSettings */ 'aws.vpc.flow_logs_retention_days'?: number; /** * Enable a secondary Elastic IP per NAT Gateway, increasing the number of outbound public IPs. Useful for services with IP-based rate limits. * @type {boolean} * @memberof ClusterAdvancedSettings */ 'aws.vpc.enable_nat_gateway_secondary_eip'?: boolean; /** * For how long in week loki is going to keep logs of your applications * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.log_retention_in_week'?: number; /** * Loki deployment topology. \"single_binary\" runs Loki as one pod; \"simple_scalable\" splits it into separate write, read, and backend components for larger clusters. * @type {string} * @memberof ClusterAdvancedSettings */ 'loki.deployment_mode'?: ClusterAdvancedSettingsLokiDeploymentModeEnum; /** * CPU request (in milli-CPU) for the Loki pod when running in single_binary mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.single_binary.cpu_request_m'?: number; /** * CPU limit (in milli-CPU) for the Loki pod when running in single_binary mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.single_binary.cpu_limit_m'?: number; /** * Memory request (in MiB) for the Loki pod when running in single_binary mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.single_binary.memory_request_mib'?: number; /** * Memory limit (in MiB) for the Loki pod when running in single_binary mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.single_binary.memory_limit_mib'?: number; /** * CPU request (in milli-CPU) for the Loki write component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.write.cpu_request_m'?: number; /** * CPU limit (in milli-CPU) for the Loki write component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.write.cpu_limit_m'?: number; /** * Memory request (in MiB) for the Loki write component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.write.memory_request_mib'?: number; /** * Memory limit (in MiB) for the Loki write component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.write.memory_limit_mib'?: number; /** * CPU request (in milli-CPU) for the Loki read component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.read.cpu_request_m'?: number; /** * CPU limit (in milli-CPU) for the Loki read component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.read.cpu_limit_m'?: number; /** * Memory request (in MiB) for the Loki read component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.read.memory_request_mib'?: number; /** * Memory limit (in MiB) for the Loki read component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.read.memory_limit_mib'?: number; /** * CPU request (in milli-CPU) for the Loki backend component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.backend.cpu_request_m'?: number; /** * CPU limit (in milli-CPU) for the Loki backend component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.backend.cpu_limit_m'?: number; /** * Memory request (in MiB) for the Loki backend component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.backend.memory_request_mib'?: number; /** * Memory limit (in MiB) for the Loki backend component when running in simple_scalable mode. * @type {number} * @memberof ClusterAdvancedSettings */ 'loki.backend.memory_limit_mib'?: number; /** * Configure the number of seconds before cleaning images in the registry * @type {number} * @memberof ClusterAdvancedSettings */ 'registry.image_retention_time'?: number; /** * Add additional tags on the cluster dedicated registry * @type {{ [key: string]: string; }} * @memberof ClusterAdvancedSettings */ 'cloud_provider.container_registry.tags'?: { [key: string]: string; }; /** * Enable the AWS ALB controller to manage the load balancer for the cluster. Note: Changing this feature will create a 10 min max downtime on your application\'s public access (time to delete, replace and propagate DNS of the new load balancer) and will requiere to update all services with TCP/UDP open ports. * @type {boolean} * @memberof ClusterAdvancedSettings */ 'aws.eks.enable_alb_controller'?: boolean; /** * Enable the AWS EFS CSI driver EKS add-on to provision EFS-backed persistent volumes on the cluster. * @type {boolean} * @memberof ClusterAdvancedSettings */ 'aws.eks.enable_efs_addon'?: boolean; /** * EFS throughput mode. \"elastic\" scales automatically (pay-per-use), \"bursting\" uses burst credits based on file system size, \"provisioned\" requires a fixed throughput value. * @type {string} * @memberof ClusterAdvancedSettings */ 'aws.eks.efs.throughput_mode'?: ClusterAdvancedSettingsAwsEksEfsThroughputModeEnum; /** * EFS performance mode. \"generalPurpose\" offers lowest latency (recommended). \"maxIO\" provides higher aggregate throughput for highly parallelized workloads. Cannot be changed after creation. * @type {string} * @memberof ClusterAdvancedSettings */ 'aws.eks.efs.performance_mode'?: ClusterAdvancedSettingsAwsEksEfsPerformanceModeEnum; /** * Lifecycle policy to transition files to Infrequent Access (IA) storage after the specified period. IA storage costs less but has a per-read charge. Empty string disables the policy. * @type {string} * @memberof ClusterAdvancedSettings */ 'aws.eks.efs.transition_to_ia'?: ClusterAdvancedSettingsAwsEksEfsTransitionToIaEnum; /** * Select the size of the main load_balancer (only effective for Scaleway) * @type {string} * @memberof ClusterAdvancedSettings */ 'load_balancer.size'?: string; /** * Deny public access to any PostgreSQL database * @type {boolean} * @memberof ClusterAdvancedSettings */ 'database.postgresql.deny_any_access'?: boolean; /** * List of CIDRs allowed to access the PostgreSQL database * @type {Array} * @memberof ClusterAdvancedSettings */ 'database.postgresql.allowed_cidrs'?: Array; /** * Deny public access to any MySql database * @type {boolean} * @memberof ClusterAdvancedSettings */ 'database.mysql.deny_any_access'?: boolean; /** * List of CIDRs allowed to access the MySql database * @type {Array} * @memberof ClusterAdvancedSettings */ 'database.mysql.allowed_cidrs'?: Array; /** * Deny public access to any MongoDB/DocumentDB database * @type {boolean} * @memberof ClusterAdvancedSettings */ 'database.mongodb.deny_any_access'?: boolean; /** * List of CIDRs allowed to access the MongoDB/DocumentDB database * @type {Array} * @memberof ClusterAdvancedSettings */ 'database.mongodb.allowed_cidrs'?: Array; /** * Deny public access to any Redis database * @type {boolean} * @memberof ClusterAdvancedSettings */ 'database.redis.deny_any_access'?: boolean; /** * List of CIDRs allowed to access the Redis database * @type {Array} * @memberof ClusterAdvancedSettings */ 'database.redis.allowed_cidrs'?: Array; /** * AWS IAM group name with cluster access * @type {string} * @memberof ClusterAdvancedSettings */ 'aws.iam.admin_group'?: string; /** * Specify the [IMDS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) version you want to use: * `required`: IMDS V2 only * `optional`: IMDS V1 + V2 * @type {string} * @memberof ClusterAdvancedSettings */ 'aws.eks.ec2.metadata_imds'?: ClusterAdvancedSettingsAwsEksEc2MetadataImdsEnum; /** * Select the AMI to use for EKS worker nodes (Karpenter only): * `AmazonLinux2`: Amazon Linux 2 * `AmazonLinux2023`: Amazon Linux 2023 (default) * `Bottlerocket`: Bottlerocket OS * `ami-xxx` or `my-custom-ami-*`: A custom AMI ID or name pattern (assumes AL2023-based) * `al2:ami-xxx`: A custom AMI based on Amazon Linux 2 * `al2023:ami-xxx`: A custom AMI based on Amazon Linux 2023 * `bottlerocket:ami-xxx`: A custom AMI based on Bottlerocket * @type {string} * @memberof ClusterAdvancedSettings */ 'aws.eks.ec2.ami'?: string; /** * * @type {number} * @memberof ClusterAdvancedSettings * @deprecated */ 'pleco.resources_ttl'?: number; /** * * @type {RegistryMirroringModeEnum} * @memberof ClusterAdvancedSettings */ 'registry.mirroring_mode'?: RegistryMirroringModeEnum; /** * vcpu request in millicores * @type {number} * @memberof ClusterAdvancedSettings */ 'nginx.vcpu.request_in_milli_cpu'?: number; /** * vcpu limit in millicores * @type {number} * @memberof ClusterAdvancedSettings */ 'nginx.vcpu.limit_in_milli_cpu'?: number; /** * memory request in MiB * @type {number} * @memberof ClusterAdvancedSettings */ 'nginx.memory.request_in_mib'?: number; /** * memory limit in MiB * @type {number} * @memberof ClusterAdvancedSettings */ 'nginx.memory.limit_in_mib'?: number; /** * Sets the default request timeout (in seconds) applied to Gateway API routes when the service does not override it. * @type {number} * @memberof ClusterAdvancedSettings */ 'envoy.gateway_api.http_request_timeout_seconds'?: number | null; /** * Sets the default idle connection timeout (in seconds) applied to Gateway API routes when the service does not override it. * @type {number} * @memberof ClusterAdvancedSettings */ 'envoy.gateway_api.http_connection_idle_timeout_seconds'?: number | null; /** * Sets the default number of retry attempts applied to Gateway API routes when the service does not override it. * @type {number} * @memberof ClusterAdvancedSettings */ 'envoy.gateway_api.retry.num_retries'?: number | null; /** * Default comma-separated retry triggers applied to Gateway API routes when the service does not override them. * @type {string} * @memberof ClusterAdvancedSettings */ 'envoy.gateway_api.retry.retry_on'?: string | null; /** * Default comma-separated HTTP status codes (100..599) retried when retry_on includes retriable-status-codes. * @type {string} * @memberof ClusterAdvancedSettings */ 'envoy.gateway_api.retry.http_status_codes'?: string | null; /** * Sets the default timeout (in seconds) applied to each retry attempt when the service does not override it. * @type {number} * @memberof ClusterAdvancedSettings */ 'envoy.gateway_api.retry.per_try_timeout_seconds'?: number | null; /** * hpa cpu threshold in percentage * @type {number} * @memberof ClusterAdvancedSettings */ 'nginx.hpa.cpu_utilization_percentage_threshold'?: number; /** * hpa minimum number of instances * @type {number} * @memberof ClusterAdvancedSettings */ 'nginx.hpa.min_number_instances'?: number; /** * hpa maximum number of instances * @type {number} * @memberof ClusterAdvancedSettings */ 'nginx.hpa.max_number_instances'?: number; /** * storage class name to use to provision pvc * @type {string} * @memberof ClusterAdvancedSettings */ 'storageclass.fast_ssd'?: string; /** * To limit public access from the internet to your Kubernetes cluster endpoint. You can define whitelisted CIDR in k8s.api.allowed_public_access_cidrs. * @type {boolean} * @memberof ClusterAdvancedSettings */ 'qovery.static_ip_mode'?: boolean; /** * Set custom sources to public access endpoint. Use CIDR notation to specify an IP address range (for example, [\'203.0.113.5/32\',\'203.0.100/32\']) * @type {Array} * @memberof ClusterAdvancedSettings */ 'k8s.api.allowed_public_access_cidrs'?: Array; } export declare const ClusterAdvancedSettingsLokiDeploymentModeEnum: { readonly SINGLE_BINARY: "single_binary"; readonly SIMPLE_SCALABLE: "simple_scalable"; }; export type ClusterAdvancedSettingsLokiDeploymentModeEnum = typeof ClusterAdvancedSettingsLokiDeploymentModeEnum[keyof typeof ClusterAdvancedSettingsLokiDeploymentModeEnum]; export declare const ClusterAdvancedSettingsAwsEksEfsThroughputModeEnum: { readonly BURSTING: "bursting"; readonly ELASTIC: "elastic"; readonly PROVISIONED: "provisioned"; }; export type ClusterAdvancedSettingsAwsEksEfsThroughputModeEnum = typeof ClusterAdvancedSettingsAwsEksEfsThroughputModeEnum[keyof typeof ClusterAdvancedSettingsAwsEksEfsThroughputModeEnum]; export declare const ClusterAdvancedSettingsAwsEksEfsPerformanceModeEnum: { readonly GENERAL_PURPOSE: "generalPurpose"; readonly MAX_IO: "maxIO"; }; export type ClusterAdvancedSettingsAwsEksEfsPerformanceModeEnum = typeof ClusterAdvancedSettingsAwsEksEfsPerformanceModeEnum[keyof typeof ClusterAdvancedSettingsAwsEksEfsPerformanceModeEnum]; export declare const ClusterAdvancedSettingsAwsEksEfsTransitionToIaEnum: { readonly AFTER_1_DAY: "AFTER_1_DAY"; readonly AFTER_7_DAYS: "AFTER_7_DAYS"; readonly AFTER_14_DAYS: "AFTER_14_DAYS"; readonly AFTER_30_DAYS: "AFTER_30_DAYS"; readonly AFTER_60_DAYS: "AFTER_60_DAYS"; readonly AFTER_90_DAYS: "AFTER_90_DAYS"; readonly EMPTY: ""; }; export type ClusterAdvancedSettingsAwsEksEfsTransitionToIaEnum = typeof ClusterAdvancedSettingsAwsEksEfsTransitionToIaEnum[keyof typeof ClusterAdvancedSettingsAwsEksEfsTransitionToIaEnum]; export declare const ClusterAdvancedSettingsAwsEksEc2MetadataImdsEnum: { readonly OPTIONAL: "optional"; readonly REQUIRED: "required"; }; export type ClusterAdvancedSettingsAwsEksEc2MetadataImdsEnum = typeof ClusterAdvancedSettingsAwsEksEc2MetadataImdsEnum[keyof typeof ClusterAdvancedSettingsAwsEksEc2MetadataImdsEnum]; /** * * @export * @interface ClusterCloudProviderInfo */ export interface ClusterCloudProviderInfo { /** * * @type {CloudProviderEnum} * @memberof ClusterCloudProviderInfo */ 'cloud_provider'?: CloudProviderEnum; /** * * @type {ClusterCloudProviderInfoCredentials} * @memberof ClusterCloudProviderInfo */ 'credentials'?: ClusterCloudProviderInfoCredentials; /** * * @type {string} * @memberof ClusterCloudProviderInfo */ 'region'?: string; } /** * * @export * @interface ClusterCloudProviderInfoCredentials */ export interface ClusterCloudProviderInfoCredentials { /** * * @type {string} * @memberof ClusterCloudProviderInfoCredentials */ 'id'?: string; /** * * @type {string} * @memberof ClusterCloudProviderInfoCredentials */ 'name'?: string; } /** * * @export * @interface ClusterCloudProviderInfoRequest */ export interface ClusterCloudProviderInfoRequest { /** * * @type {CloudProviderEnum} * @memberof ClusterCloudProviderInfoRequest */ 'cloud_provider'?: CloudProviderEnum; /** * * @type {ClusterCloudProviderInfoCredentials} * @memberof ClusterCloudProviderInfoRequest */ 'credentials'?: ClusterCloudProviderInfoCredentials; /** * * @type {string} * @memberof ClusterCloudProviderInfoRequest */ 'region'?: string; } /** * @type ClusterCredentials * @export */ export type ClusterCredentials = { object_type: 'AWS'; } & AwsStaticClusterCredentials | { object_type: 'AWS_ROLE'; } & AwsRoleClusterCredentials | { object_type: 'AZURE'; } & AzureStaticClusterCredentials | { object_type: 'EKS_ANYWHERE_VSPHERE'; } & EksAnywhereVsphereClusterCredentials | { object_type: 'GCP'; } & GcpStaticClusterCredentials | { object_type: 'OTHER'; } & GenericClusterCredentials | { object_type: 'SCW'; } & ScalewayClusterCredentials; /** * * @export * @interface ClusterCredentialsResponseList */ export interface ClusterCredentialsResponseList { /** * * @type {Array} * @memberof ClusterCredentialsResponseList */ 'results'?: Array; } /** * Indicates the mode to apply on cluster deletion **\"hard delete\"** means that we delete directly from our database, this is different from a **\"trigger delete\"** that cleans the resource - `DEFAULT`: this is the normal way, trigger delete the cluster only if no environment linked to this cluster remains - `DELETE_CLUSTER_AND_QOVERY_CONFIG`: hard delete environments linked to this cluster then trigger delete the cluster - `DELETE_QOVERY_CONFIG`: ⚠️ ⚠️ ⚠️ hard delete environments linked to this cluster then hard delete the cluster - whole cluster ressources **are not deleted** on our side and must be deleted on your side * @export * @enum {string} */ export declare const ClusterDeleteMode: { readonly DEFAULT: "DEFAULT"; readonly DELETE_CLUSTER_AND_QOVERY_CONFIG: "DELETE_CLUSTER_AND_QOVERY_CONFIG"; readonly DELETE_QOVERY_CONFIG: "DELETE_QOVERY_CONFIG"; }; export type ClusterDeleteMode = typeof ClusterDeleteMode[keyof typeof ClusterDeleteMode]; /** * * @export * @enum {string} */ export declare const ClusterDeploymentStatusEnum: { readonly NEVER_DEPLOYED: "NEVER_DEPLOYED"; readonly OUT_OF_DATE: "OUT_OF_DATE"; readonly UP_TO_DATE: "UP_TO_DATE"; }; export type ClusterDeploymentStatusEnum = typeof ClusterDeploymentStatusEnum[keyof typeof ClusterDeploymentStatusEnum]; /** * * @export * @interface ClusterDnsProviderRequest */ export interface ClusterDnsProviderRequest { /** * * @type {ClusterDnsProviderRequestProvider} * @memberof ClusterDnsProviderRequest */ 'dns_provider': ClusterDnsProviderRequestProvider; } /** * @type ClusterDnsProviderRequestProvider * @export */ export type ClusterDnsProviderRequestProvider = { provider: 'CLOUDFLARE'; } & CloudflareDnsProviderRequest | { provider: 'QOVERY'; } & QoveryDnsProviderRequest | { provider: 'ROUTE53'; } & Route53DnsProviderRequest; /** * * @export * @interface ClusterDnsProviderResponse */ export interface ClusterDnsProviderResponse { /** * * @type {ClusterDnsProviderResponseProvider} * @memberof ClusterDnsProviderResponse */ 'dns_provider': ClusterDnsProviderResponseProvider; } /** * @type ClusterDnsProviderResponseProvider * @export */ export type ClusterDnsProviderResponseProvider = { provider: 'CLOUDFLARE'; } & CloudflareDnsProviderResponse | { provider: 'QOVERY'; } & QoveryDnsProviderResponse | { provider: 'ROUTE53'; } & Route53DnsProviderResponse; /** * * @export * @interface ClusterEksAnywhereGitRepository */ export interface ClusterEksAnywhereGitRepository { /** * EKS Anywhere git repository URL * @type {string} * @memberof ClusterEksAnywhereGitRepository */ 'url': string; /** * Name of the branch to use. This is optional. If not specified, the default branch of the repository is used. * @type {string} * @memberof ClusterEksAnywhereGitRepository */ 'branch'?: string; /** * Optional git commit SHA to pin EKS Anywhere configuration on a specific revision. If omitted, the latest commit from the selected branch is used. * @type {string} * @memberof ClusterEksAnywhereGitRepository */ 'commit_id'?: string; /** * Qovery git token id used to access the repository * @type {string} * @memberof ClusterEksAnywhereGitRepository */ 'git_token_id': string; /** * * @type {GitProviderEnum} * @memberof ClusterEksAnywhereGitRepository */ 'provider'?: GitProviderEnum; } /** * * @export * @interface ClusterEnvironmentResponse */ export interface ClusterEnvironmentResponse { /** * * @type {string} * @memberof ClusterEnvironmentResponse */ 'environment_id': string; /** * * @type {string} * @memberof ClusterEnvironmentResponse */ 'environment_name': string; /** * * @type {string} * @memberof ClusterEnvironmentResponse */ 'project_id': string; /** * * @type {string} * @memberof ClusterEnvironmentResponse */ 'project_name': string; /** * * @type {Array} * @memberof ClusterEnvironmentResponse */ 'services': Array; } /** * * @export * @interface ClusterEnvironmentResponseList */ export interface ClusterEnvironmentResponseList { /** * * @type {Array} * @memberof ClusterEnvironmentResponseList */ 'results'?: Array; } /** * * @export * @interface ClusterEnvironmentServiceResponse */ export interface ClusterEnvironmentServiceResponse { /** * * @type {string} * @memberof ClusterEnvironmentServiceResponse */ 'id': string; /** * * @type {string} * @memberof ClusterEnvironmentServiceResponse */ 'name': string; /** * * @type {LinkedServiceTypeEnum} * @memberof ClusterEnvironmentServiceResponse */ 'type': LinkedServiceTypeEnum; } /** * * @export * @interface ClusterFeatureAwsExistingVpc */ export interface ClusterFeatureAwsExistingVpc { /** * * @type {string} * @memberof ClusterFeatureAwsExistingVpc */ 'aws_vpc_eks_id': string; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'eks_subnets_zone_a_ids': Array; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'eks_subnets_zone_b_ids': Array; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'eks_subnets_zone_c_ids': Array; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'documentdb_subnets_zone_a_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'documentdb_subnets_zone_b_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'documentdb_subnets_zone_c_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'elasticache_subnets_zone_a_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'elasticache_subnets_zone_b_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'elasticache_subnets_zone_c_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'rds_subnets_zone_a_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'rds_subnets_zone_b_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'rds_subnets_zone_c_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'eks_karpenter_fargate_subnets_zone_a_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'eks_karpenter_fargate_subnets_zone_b_ids'?: Array | null; /** * * @type {Array} * @memberof ClusterFeatureAwsExistingVpc */ 'eks_karpenter_fargate_subnets_zone_c_ids'?: Array | null; /** * * @type {boolean} * @memberof ClusterFeatureAwsExistingVpc */ 'eks_create_nodes_in_private_subnet'?: boolean; } /** * * @export * @interface ClusterFeatureAwsExistingVpcResponse */ export interface ClusterFeatureAwsExistingVpcResponse { /** * * @type {ClusterFeatureResponseTypeEnum} * @memberof ClusterFeatureAwsExistingVpcResponse */ 'type': ClusterFeatureResponseTypeEnum; /** * * @type {ClusterFeatureAwsExistingVpc} * @memberof ClusterFeatureAwsExistingVpcResponse */ 'value': ClusterFeatureAwsExistingVpc; } /** * * @export * @interface ClusterFeatureBooleanResponse */ export interface ClusterFeatureBooleanResponse { /** * * @type {ClusterFeatureResponseTypeEnum} * @memberof ClusterFeatureBooleanResponse */ 'type': ClusterFeatureResponseTypeEnum; /** * * @type {boolean} * @memberof ClusterFeatureBooleanResponse */ 'value': boolean; } /** * * @export * @interface ClusterFeatureGcpExistingVpc */ export interface ClusterFeatureGcpExistingVpc { /** * * @type {string} * @memberof ClusterFeatureGcpExistingVpc */ 'vpc_name': string; /** * * @type {string} * @memberof ClusterFeatureGcpExistingVpc */ 'vpc_project_id'?: string | null; /** * * @type {string} * @memberof ClusterFeatureGcpExistingVpc */ 'subnetwork_name'?: string | null; /** * * @type {string} * @memberof ClusterFeatureGcpExistingVpc */ 'ip_range_services_name'?: string | null; /** * * @type {string} * @memberof ClusterFeatureGcpExistingVpc */ 'ip_range_pods_name'?: string | null; /** * * @type {Array} * @memberof ClusterFeatureGcpExistingVpc */ 'additional_ip_range_pods_names'?: Array; } /** * * @export * @interface ClusterFeatureGcpExistingVpcResponse */ export interface ClusterFeatureGcpExistingVpcResponse { /** * * @type {ClusterFeatureResponseTypeEnum} * @memberof ClusterFeatureGcpExistingVpcResponse */ 'type': ClusterFeatureResponseTypeEnum; /** * * @type {ClusterFeatureGcpExistingVpc} * @memberof ClusterFeatureGcpExistingVpcResponse */ 'value': ClusterFeatureGcpExistingVpc; } /** * * @export * @interface ClusterFeatureKarpenterParameters */ export interface ClusterFeatureKarpenterParameters { /** * * @type {boolean} * @memberof ClusterFeatureKarpenterParameters */ 'spot_enabled': boolean; /** * * @type {number} * @memberof ClusterFeatureKarpenterParameters */ 'disk_size_in_gib': number; /** * Unit is operation/seconds. The disk IOPS to be used for the node configuration * @type {number} * @memberof ClusterFeatureKarpenterParameters */ 'disk_iops'?: number; /** * Unit is in MB/s. The disk throughput to be used for the node configuration * @type {number} * @memberof ClusterFeatureKarpenterParameters */ 'disk_throughput'?: number; /** * * @type {CpuArchitectureEnum} * @memberof ClusterFeatureKarpenterParameters */ 'default_service_architecture': CpuArchitectureEnum; /** * * @type {KarpenterNodePool} * @memberof ClusterFeatureKarpenterParameters */ 'qovery_node_pools': KarpenterNodePool; } /** * * @export * @interface ClusterFeatureKarpenterParametersResponse */ export interface ClusterFeatureKarpenterParametersResponse { /** * * @type {ClusterFeatureResponseTypeEnum} * @memberof ClusterFeatureKarpenterParametersResponse */ 'type': ClusterFeatureResponseTypeEnum; /** * * @type {ClusterFeatureKarpenterParameters} * @memberof ClusterFeatureKarpenterParametersResponse */ 'value': ClusterFeatureKarpenterParameters; } /** * * @export * @interface ClusterFeatureNatGatewayParameters */ export interface ClusterFeatureNatGatewayParameters { /** * * @type {ClusterFeatureNatGatewayParametersNatGatewayType} * @memberof ClusterFeatureNatGatewayParameters */ 'nat_gateway_type'?: ClusterFeatureNatGatewayParametersNatGatewayType | null; } /** * @type ClusterFeatureNatGatewayParametersNatGatewayType * @export */ export type ClusterFeatureNatGatewayParametersNatGatewayType = { provider: 'gcp'; } & ClusterFeatureNatGatewayTypeGcp | { provider: 'scaleway'; } & ClusterFeatureNatGatewayTypeScaleway; /** * * @export * @interface ClusterFeatureNatGatewayParametersResponse */ export interface ClusterFeatureNatGatewayParametersResponse { /** * * @type {ClusterFeatureResponseTypeEnum} * @memberof ClusterFeatureNatGatewayParametersResponse */ 'type': ClusterFeatureResponseTypeEnum; /** * * @type {ClusterFeatureNatGatewayParameters} * @memberof ClusterFeatureNatGatewayParametersResponse */ 'value': ClusterFeatureNatGatewayParameters | null; } /** * * @export * @interface ClusterFeatureNatGatewayTypeGcp */ export interface ClusterFeatureNatGatewayTypeGcp { /** * * @type {string} * @memberof ClusterFeatureNatGatewayTypeGcp */ 'provider': ClusterFeatureNatGatewayTypeGcpProviderEnum; /** * * @type {boolean} * @memberof ClusterFeatureNatGatewayTypeGcp */ 'static_ips_enabled': boolean; /** * Number of static IPs to allocate. Must be >= 1 when static_ips_enabled is true. * @type {number} * @memberof ClusterFeatureNatGatewayTypeGcp */ 'static_ips_count': number; } export declare const ClusterFeatureNatGatewayTypeGcpProviderEnum: { readonly GCP: "gcp"; }; export type ClusterFeatureNatGatewayTypeGcpProviderEnum = typeof ClusterFeatureNatGatewayTypeGcpProviderEnum[keyof typeof ClusterFeatureNatGatewayTypeGcpProviderEnum]; /** * * @export * @interface ClusterFeatureNatGatewayTypeScaleway */ export interface ClusterFeatureNatGatewayTypeScaleway { /** * * @type {string} * @memberof ClusterFeatureNatGatewayTypeScaleway */ 'provider': ClusterFeatureNatGatewayTypeScalewayProviderEnum; /** * * @type {string} * @memberof ClusterFeatureNatGatewayTypeScaleway */ 'type': ClusterFeatureNatGatewayTypeScalewayTypeEnum; } export declare const ClusterFeatureNatGatewayTypeScalewayProviderEnum: { readonly SCALEWAY: "scaleway"; }; export type ClusterFeatureNatGatewayTypeScalewayProviderEnum = typeof ClusterFeatureNatGatewayTypeScalewayProviderEnum[keyof typeof ClusterFeatureNatGatewayTypeScalewayProviderEnum]; export declare const ClusterFeatureNatGatewayTypeScalewayTypeEnum: { readonly S: "VPC-GW-S"; readonly M: "VPC-GW-M"; readonly L: "VPC-GW-L"; readonly XL: "VPC-GW-XL"; }; export type ClusterFeatureNatGatewayTypeScalewayTypeEnum = typeof ClusterFeatureNatGatewayTypeScalewayTypeEnum[keyof typeof ClusterFeatureNatGatewayTypeScalewayTypeEnum]; /** * * @export * @interface ClusterFeatureResponse */ export interface ClusterFeatureResponse { /** * * @type {string} * @memberof ClusterFeatureResponse */ 'id'?: string; /** * * @type {string} * @memberof ClusterFeatureResponse */ 'title'?: string; /** * * @type {string} * @memberof ClusterFeatureResponse */ 'description'?: string | null; /** * * @type {number} * @memberof ClusterFeatureResponse * @deprecated */ 'cost_per_month_in_cents'?: number | null; /** * * @type {number} * @memberof ClusterFeatureResponse * @deprecated */ 'cost_per_month'?: number | null; /** * * @type {string} * @memberof ClusterFeatureResponse * @deprecated */ 'currency_code'?: string | null; /** * * @type {boolean} * @memberof ClusterFeatureResponse */ 'is_cloud_provider_paying_feature'?: boolean; /** * * @type {string} * @memberof ClusterFeatureResponse */ 'cloud_provider_feature_documentation'?: string | null; /** * * @type {boolean} * @memberof ClusterFeatureResponse */ 'is_qovery_paying_feature'?: boolean; /** * * @type {string} * @memberof ClusterFeatureResponse */ 'qovery_feature_documentation'?: string | null; /** * * @type {string} * @memberof ClusterFeatureResponse */ 'value_type'?: ClusterFeatureResponseValueTypeEnum; /** * * @type {ClusterFeatureResponseValueObject} * @memberof ClusterFeatureResponse */ 'value_object'?: ClusterFeatureResponseValueObject | null; /** * * @type {boolean} * @memberof ClusterFeatureResponse */ 'is_value_updatable'?: boolean; /** * * @type {Array} * @memberof ClusterFeatureResponse */ 'accepted_values'?: Array; } export declare const ClusterFeatureResponseValueTypeEnum: { readonly BOOLEAN: "BOOLEAN"; }; export type ClusterFeatureResponseValueTypeEnum = typeof ClusterFeatureResponseValueTypeEnum[keyof typeof ClusterFeatureResponseValueTypeEnum]; /** * @type ClusterFeatureResponseAcceptedValuesInner * @export */ export type ClusterFeatureResponseAcceptedValuesInner = boolean | string; /** * * @export * @interface ClusterFeatureResponseList */ export interface ClusterFeatureResponseList { /** * * @type {Array} * @memberof ClusterFeatureResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const ClusterFeatureResponseTypeEnum: { readonly STRING: "STRING"; readonly BOOLEAN: "BOOLEAN"; readonly AWS_USER_PROVIDED_NETWORK: "AWS_USER_PROVIDED_NETWORK"; readonly GCP_USER_PROVIDED_NETWORK: "GCP_USER_PROVIDED_NETWORK"; readonly KARPENTER: "KARPENTER"; readonly NAT_GATEWAY: "NAT_GATEWAY"; }; export type ClusterFeatureResponseTypeEnum = typeof ClusterFeatureResponseTypeEnum[keyof typeof ClusterFeatureResponseTypeEnum]; /** * @type ClusterFeatureResponseValueObject * @export */ export type ClusterFeatureResponseValueObject = { type: 'AWS_USER_PROVIDED_NETWORK'; } & ClusterFeatureAwsExistingVpcResponse | { type: 'BOOLEAN'; } & ClusterFeatureBooleanResponse | { type: 'GCP_USER_PROVIDED_NETWORK'; } & ClusterFeatureGcpExistingVpcResponse | { type: 'KARPENTER'; } & ClusterFeatureKarpenterParametersResponse | { type: 'NAT_GATEWAY'; } & ClusterFeatureNatGatewayParametersResponse | { type: 'STRING'; } & ClusterFeatureStringResponse; /** * * @export * @interface ClusterFeatureStringResponse */ export interface ClusterFeatureStringResponse { /** * * @type {ClusterFeatureResponseTypeEnum} * @memberof ClusterFeatureStringResponse */ 'type': ClusterFeatureResponseTypeEnum; /** * * @type {string} * @memberof ClusterFeatureStringResponse */ 'value': string; } /** * * @export * @interface ClusterInfrastructureCertManagerChartParameters */ export interface ClusterInfrastructureCertManagerChartParameters { /** * * @type {string} * @memberof ClusterInfrastructureCertManagerChartParameters */ 'kubernetes_namespace'?: string; } /** * * @export * @interface ClusterInfrastructureChartsParameters */ export interface ClusterInfrastructureChartsParameters { /** * * @type {ClusterInfrastructureNginxChartParameters} * @memberof ClusterInfrastructureChartsParameters */ 'nginx_parameters'?: ClusterInfrastructureNginxChartParameters; /** * * @type {ClusterInfrastructureCertManagerChartParameters} * @memberof ClusterInfrastructureChartsParameters */ 'cert_manager_parameters'?: ClusterInfrastructureCertManagerChartParameters; /** * * @type {ClusterInfrastructureMetalLbChartParameters} * @memberof ClusterInfrastructureChartsParameters */ 'metal_lb_parameters'?: ClusterInfrastructureMetalLbChartParameters; /** * * @type {ClusterInfrastructureEksAnywhereParameters} * @memberof ClusterInfrastructureChartsParameters */ 'eks_anywhere_parameters'?: ClusterInfrastructureEksAnywhereParameters; } /** * * @export * @interface ClusterInfrastructureEksAnywhereBackupParameters */ export interface ClusterInfrastructureEksAnywhereBackupParameters { /** * Enable or disable EKS Anywhere cluster backup. * @type {boolean} * @memberof ClusterInfrastructureEksAnywhereBackupParameters */ 'enabled'?: boolean; /** * Timeout in seconds for backup operations. * @type {number} * @memberof ClusterInfrastructureEksAnywhereBackupParameters */ 'timeout_seconds'?: number; /** * Optional Kubernetes secret name holding etcd certificates. * @type {string} * @memberof ClusterInfrastructureEksAnywhereBackupParameters */ 'certs_secret_name'?: string; /** * * @type {ClusterInfrastructureEksAnywhereBackupS3Parameters} * @memberof ClusterInfrastructureEksAnywhereBackupParameters */ 's3': ClusterInfrastructureEksAnywhereBackupS3Parameters; } /** * * @export * @interface ClusterInfrastructureEksAnywhereBackupS3Parameters */ export interface ClusterInfrastructureEksAnywhereBackupS3Parameters { /** * S3 bucket name used to store EKS Anywhere backup artifacts. * @type {string} * @memberof ClusterInfrastructureEksAnywhereBackupS3Parameters */ 'bucket': string; /** * AWS region where the backup bucket is hosted. * @type {string} * @memberof ClusterInfrastructureEksAnywhereBackupS3Parameters */ 'region': string; /** * IAM role ARN assumed to upload backup artifacts. * @type {string} * @memberof ClusterInfrastructureEksAnywhereBackupS3Parameters */ 'role_arn': string; /** * Optional S3 key prefix used for backup object keys. * @type {string} * @memberof ClusterInfrastructureEksAnywhereBackupS3Parameters */ 'key_prefix'?: string; } /** * * @export * @interface ClusterInfrastructureEksAnywhereParameters */ export interface ClusterInfrastructureEksAnywhereParameters { /** * * @type {ClusterEksAnywhereGitRepository} * @memberof ClusterInfrastructureEksAnywhereParameters */ 'git_repository': ClusterEksAnywhereGitRepository; /** * Path to the EKS Anywhere cluster YAML file in the git repository * @type {string} * @memberof ClusterInfrastructureEksAnywhereParameters */ 'yaml_file_path': string; /** * * @type {ClusterInfrastructureEksAnywhereBackupParameters} * @memberof ClusterInfrastructureEksAnywhereParameters */ 'cluster_backup'?: ClusterInfrastructureEksAnywhereBackupParameters; } /** * * @export * @interface ClusterInfrastructureMetalLbChartParameters */ export interface ClusterInfrastructureMetalLbChartParameters { /** * * @type {Array} * @memberof ClusterInfrastructureMetalLbChartParameters */ 'ip_address_pools'?: Array; } /** * * @export * @interface ClusterInfrastructureNginxChartParameters */ export interface ClusterInfrastructureNginxChartParameters { /** * * @type {number} * @memberof ClusterInfrastructureNginxChartParameters */ 'replica_count'?: number; /** * * @type {string} * @memberof ClusterInfrastructureNginxChartParameters */ 'default_ssl_certificate'?: string; /** * * @type {string} * @memberof ClusterInfrastructureNginxChartParameters */ 'publish_status_address'?: string; /** * * @type {string} * @memberof ClusterInfrastructureNginxChartParameters */ 'annotation_metal_lb_load_balancer_ips'?: string; /** * * @type {string} * @memberof ClusterInfrastructureNginxChartParameters */ 'annotation_external_dns_kubernetes_target'?: string; } /** * * @export * @interface ClusterInstanceAttributes */ export interface ClusterInstanceAttributes { /** * The category of the instance. * @type {string} * @memberof ClusterInstanceAttributes */ 'instance_category'?: string; /** * The generation of the instance. * @type {number} * @memberof ClusterInstanceAttributes */ 'instance_generation'?: number; /** * The family or series of the instance. * @type {string} * @memberof ClusterInstanceAttributes */ 'instance_family'?: string; /** * Specifies the size of the instance within its family. * @type {string} * @memberof ClusterInstanceAttributes */ 'instance_size'?: string; /** * The instance has sufficient resources to be chosen as a standalone instance in a cluster. * @type {boolean} * @memberof ClusterInstanceAttributes */ 'meets_resource_reqs'?: boolean; } /** * * @export * @interface ClusterInstanceGpuInfo */ export interface ClusterInstanceGpuInfo { /** * The number of GPUs included in the instance. * @type {number} * @memberof ClusterInstanceGpuInfo */ 'count'?: number; /** * The model name of the GPU. * @type {string} * @memberof ClusterInstanceGpuInfo */ 'name'?: string; /** * The manufacturer of the GPUs in the instance. * @type {string} * @memberof ClusterInstanceGpuInfo */ 'manufacturer'?: string; /** * The total GPU memory available. * @type {string} * @memberof ClusterInstanceGpuInfo */ 'memory_in_mib'?: string; } /** * * @export * @interface ClusterInstanceTypeResponseList */ export interface ClusterInstanceTypeResponseList { /** * * @type {Array} * @memberof ClusterInstanceTypeResponseList */ 'results'?: Array; } /** * * @export * @interface ClusterInstanceTypeResponseListResultsInner */ export interface ClusterInstanceTypeResponseListResultsInner { /** * * @type {string} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'type': string; /** * * @type {string} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'name': string; /** * * @type {number} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'cpu': number; /** * * @type {number} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'ram_in_gb': number; /** * * @type {string} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'bandwidth_in_gbps': string; /** * * @type {string} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'bandwidth_guarantee': string; /** * * @type {string} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'architecture'?: string; /** * * @type {ClusterInstanceGpuInfo} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'gpu_info'?: ClusterInstanceGpuInfo; /** * * @type {ClusterInstanceAttributes} * @memberof ClusterInstanceTypeResponseListResultsInner */ 'attributes'?: ClusterInstanceAttributes; } /** * * @export * @interface ClusterKarpenterPrivateSubnetIdsPutRequest */ export interface ClusterKarpenterPrivateSubnetIdsPutRequest { /** * * @type {Array} * @memberof ClusterKarpenterPrivateSubnetIdsPutRequest */ 'eks_karpenter_fargate_subnets_zone_a_ids'?: Array; /** * * @type {Array} * @memberof ClusterKarpenterPrivateSubnetIdsPutRequest */ 'eks_karpenter_fargate_subnets_zone_b_ids'?: Array; /** * * @type {Array} * @memberof ClusterKarpenterPrivateSubnetIdsPutRequest */ 'eks_karpenter_fargate_subnets_zone_c_ids'?: Array; } /** * * @export * @interface ClusterKeda */ export interface ClusterKeda { /** * * @type {boolean} * @memberof ClusterKeda */ 'enabled': boolean; } /** * * @export * @interface ClusterLabelsGroup */ export interface ClusterLabelsGroup { /** * * @type {string} * @memberof ClusterLabelsGroup */ 'id'?: string; } /** * * @export * @interface ClusterLock */ export interface ClusterLock { /** * * @type {string} * @memberof ClusterLock */ 'reason': string; /** * * @type {number} * @memberof ClusterLock */ 'ttl_in_days'?: number; /** * * @type {string} * @memberof ClusterLock */ 'cluster_id': string; /** * * @type {string} * @memberof ClusterLock */ 'locked_at': string; /** * * @type {string} * @memberof ClusterLock */ 'owner_name': string; } /** * * @export * @interface ClusterLockList */ export interface ClusterLockList { /** * * @type {Array} * @memberof ClusterLockList */ 'results'?: Array; } /** * * @export * @interface ClusterLockRequest */ export interface ClusterLockRequest { /** * * @type {string} * @memberof ClusterLockRequest */ 'reason': string; /** * * @type {number} * @memberof ClusterLockRequest */ 'ttl_in_days'?: number; } /** * * @export * @interface ClusterLogs */ export interface ClusterLogs { /** * log level * @type {string} * @memberof ClusterLogs */ 'type'?: string; /** * log date creation * @type {string} * @memberof ClusterLogs */ 'timestamp'?: string; /** * log step * @type {string} * @memberof ClusterLogs */ 'step'?: ClusterLogsStepEnum; /** * * @type {ClusterLogsMessage} * @memberof ClusterLogs */ 'message'?: ClusterLogsMessage; /** * * @type {ClusterLogsError} * @memberof ClusterLogs */ 'error'?: ClusterLogsError; /** * * @type {ClusterLogsDetails} * @memberof ClusterLogs */ 'details'?: ClusterLogsDetails; } export declare const ClusterLogsStepEnum: { readonly LOAD_CONFIGURATION: "LoadConfiguration"; readonly CREATE: "Create"; readonly CREATED: "Created"; readonly CREATE_ERROR: "CreateError"; readonly PAUSE: "Pause"; readonly PAUSED: "Paused"; readonly PAUSE_ERROR: "PauseError"; readonly DELETE: "Delete"; readonly DELETED: "Deleted"; readonly DELETE_ERROR: "DeleteError"; readonly RETRIEVE_CLUSTER_CONFIG: "RetrieveClusterConfig"; readonly RETRIEVE_CLUSTER_RESOURCES: "RetrieveClusterResources"; readonly VALIDATE_SYSTEM_REQUIREMENTS: "ValidateSystemRequirements"; readonly UNDER_MIGRATION: "UnderMigration"; readonly UNKNOWN: "Unknown"; }; export type ClusterLogsStepEnum = typeof ClusterLogsStepEnum[keyof typeof ClusterLogsStepEnum]; /** * Present only for `info`, `warning` and `debug` logs * @export * @interface ClusterLogsDetails */ export interface ClusterLogsDetails { /** * cloud provider used * @type {string} * @memberof ClusterLogsDetails */ 'provider_kind'?: string; /** * * @type {string} * @memberof ClusterLogsDetails */ 'region'?: string; /** * * @type {ClusterLogsErrorEventDetailsTransmitter} * @memberof ClusterLogsDetails */ 'transmitter'?: ClusterLogsErrorEventDetailsTransmitter; } /** * Present only for `error` log * @export * @interface ClusterLogsError */ export interface ClusterLogsError { /** * log error tag * @type {string} * @memberof ClusterLogsError */ 'tag'?: string; /** * log details about the error * @type {string} * @memberof ClusterLogsError */ 'user_log_message'?: string; /** * link to our documentation * @type {string} * @memberof ClusterLogsError */ 'link'?: string; /** * hint the user can follow * @type {string} * @memberof ClusterLogsError */ 'hint_message'?: string; /** * * @type {ClusterLogsErrorEventDetails} * @memberof ClusterLogsError */ 'event_details'?: ClusterLogsErrorEventDetails; /** * * @type {ClusterLogsErrorUnderlyingError} * @memberof ClusterLogsError */ 'underlying_error'?: ClusterLogsErrorUnderlyingError; } /** * * @export * @interface ClusterLogsErrorEventDetails */ export interface ClusterLogsErrorEventDetails { /** * cloud provider used * @type {string} * @memberof ClusterLogsErrorEventDetails */ 'provider_kind'?: string; /** * * @type {string} * @memberof ClusterLogsErrorEventDetails */ 'region'?: string; /** * * @type {ClusterLogsErrorEventDetailsTransmitter} * @memberof ClusterLogsErrorEventDetails */ 'transmitter'?: ClusterLogsErrorEventDetailsTransmitter; } /** * * @export * @interface ClusterLogsErrorEventDetailsTransmitter */ export interface ClusterLogsErrorEventDetailsTransmitter { /** * * @type {string} * @memberof ClusterLogsErrorEventDetailsTransmitter */ 'type'?: string; /** * * @type {string} * @memberof ClusterLogsErrorEventDetailsTransmitter */ 'id'?: string; /** * * @type {string} * @memberof ClusterLogsErrorEventDetailsTransmitter */ 'name'?: string; } /** * * @export * @interface ClusterLogsErrorUnderlyingError */ export interface ClusterLogsErrorUnderlyingError { /** * technical details about the error * @type {string} * @memberof ClusterLogsErrorUnderlyingError */ 'message'?: string; } /** * * @export * @interface ClusterLogsMessage */ export interface ClusterLogsMessage { /** * log global message * @type {string} * @memberof ClusterLogsMessage */ 'safe_message'?: string; } /** * * @export * @interface ClusterLogsResponse */ export interface ClusterLogsResponse { /** * * @type {string} * @memberof ClusterLogsResponse */ 'response'?: string; } /** * * @export * @interface ClusterLogsResponseList */ export interface ClusterLogsResponseList { /** * * @type {Array} * @memberof ClusterLogsResponseList */ 'results'?: Array; } /** * * @export * @interface ClusterMetricsResponse */ export interface ClusterMetricsResponse { /** * * @type {string} * @memberof ClusterMetricsResponse */ 'metrics'?: string; } /** * * @export * @interface ClusterOverviewResponse */ export interface ClusterOverviewResponse { /** * * @type {string} * @memberof ClusterOverviewResponse */ 'id': string; /** * * @type {string} * @memberof ClusterOverviewResponse */ 'name': string; /** * * @type {CloudVendorEnum} * @memberof ClusterOverviewResponse */ 'cloud_provider': CloudVendorEnum; /** * * @type {boolean} * @memberof ClusterOverviewResponse */ 'is_demo': boolean; } /** * * @export * @interface ClusterReadinessStatus */ export interface ClusterReadinessStatus { /** * * @type {boolean} * @memberof ClusterReadinessStatus */ 'is_ready'?: boolean; } /** * * @export * @interface ClusterRegion */ export interface ClusterRegion { /** * * @type {string} * @memberof ClusterRegion */ 'name': string; /** * * @type {string} * @memberof ClusterRegion */ 'country_code': string; /** * * @type {string} * @memberof ClusterRegion */ 'country': string; /** * * @type {string} * @memberof ClusterRegion */ 'city': string; /** * List of availability zones supported by this region * @type {Array} * @memberof ClusterRegion */ 'zones'?: Array; } /** * * @export * @interface ClusterRegionResponseList */ export interface ClusterRegionResponseList { /** * * @type {Array} * @memberof ClusterRegionResponseList */ 'results'?: Array; } /** * * @export * @interface ClusterRequest */ export interface ClusterRequest { /** * name is case-insensitive * @type {string} * @memberof ClusterRequest */ 'name': string; /** * * @type {string} * @memberof ClusterRequest */ 'description'?: string; /** * * @type {string} * @memberof ClusterRequest */ 'region': string; /** * * @type {CloudVendorEnum} * @memberof ClusterRequest */ 'cloud_provider': CloudVendorEnum; /** * * @type {ClusterCloudProviderInfoRequest} * @memberof ClusterRequest */ 'cloud_provider_credentials'?: ClusterCloudProviderInfoRequest; /** * * @type {number} * @memberof ClusterRequest */ 'min_running_nodes'?: number; /** * * @type {number} * @memberof ClusterRequest */ 'max_running_nodes'?: number; /** * Unit is in GB. The disk size to be used for the node configuration * @type {number} * @memberof ClusterRequest */ 'disk_size'?: number; /** * Unit is operation/seconds. The disk IOPS to be used for the node configuration * @type {number} * @memberof ClusterRequest */ 'disk_iops'?: number; /** * Unit is in MB/s. The disk thoughput to be used for the node configuration * @type {number} * @memberof ClusterRequest */ 'disk_throughput'?: number; /** * the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType * @type {string} * @memberof ClusterRequest */ 'instance_type'?: string; /** * * @type {KubernetesEnum} * @memberof ClusterRequest */ 'kubernetes'?: KubernetesEnum; /** * specific flag to indicate that this cluster is a production one * @type {boolean} * @memberof ClusterRequest */ 'production'?: boolean; /** * Indicate your public ssh_key to remotely connect to your EC2 instance. * @type {Array} * @memberof ClusterRequest */ 'ssh_keys'?: Array; /** * * @type {Array} * @memberof ClusterRequest */ 'features'?: Array; /** * * @type {MetricsParameters} * @memberof ClusterRequest */ 'metrics_parameters'?: MetricsParameters; /** * * @type {ClusterInfrastructureChartsParameters} * @memberof ClusterRequest */ 'infrastructure_charts_parameters'?: ClusterInfrastructureChartsParameters; /** * * @type {ClusterKeda} * @memberof ClusterRequest */ 'keda'?: ClusterKeda; /** * * @type {Array} * @memberof ClusterRequest */ 'labels_groups'?: Array; /** * * @type {Array} * @memberof ClusterRequest */ 'secret_manager_accesses'?: Array; } /** * * @export * @interface ClusterRequestFeaturesInner */ export interface ClusterRequestFeaturesInner { /** * * @type {string} * @memberof ClusterRequestFeaturesInner */ 'id'?: string; /** * * @type {ClusterRequestFeaturesInnerValue} * @memberof ClusterRequestFeaturesInner */ 'value'?: ClusterRequestFeaturesInnerValue | null; } /** * @type ClusterRequestFeaturesInnerValue * @export */ export type ClusterRequestFeaturesInnerValue = ClusterFeatureAwsExistingVpc | ClusterFeatureGcpExistingVpc | ClusterFeatureKarpenterParameters | ClusterFeatureNatGatewayParameters | boolean | string; /** * * @export * @interface ClusterResponseList */ export interface ClusterResponseList { /** * * @type {Array} * @memberof ClusterResponseList */ 'results'?: Array; } /** * * @export * @interface ClusterRoutingTable */ export interface ClusterRoutingTable { /** * * @type {Array} * @memberof ClusterRoutingTable */ 'results'?: Array; } /** * * @export * @interface ClusterRoutingTableRequest */ export interface ClusterRoutingTableRequest { /** * * @type {Array} * @memberof ClusterRoutingTableRequest */ 'routes': Array; } /** * * @export * @interface ClusterRoutingTableResultsInner */ export interface ClusterRoutingTableResultsInner { /** * * @type {string} * @memberof ClusterRoutingTableResultsInner */ 'destination': string; /** * * @type {string} * @memberof ClusterRoutingTableResultsInner */ 'target': string; /** * * @type {string} * @memberof ClusterRoutingTableResultsInner */ 'description': string; } /** * * @export * @enum {string} */ export declare const ClusterStateEnum: { readonly BUILDING: "BUILDING"; readonly BUILD_ERROR: "BUILD_ERROR"; readonly CANCELED: "CANCELED"; readonly CANCELING: "CANCELING"; readonly DELETED: "DELETED"; readonly DELETE_ERROR: "DELETE_ERROR"; readonly DELETE_QUEUED: "DELETE_QUEUED"; readonly DELETING: "DELETING"; readonly DEPLOYED: "DEPLOYED"; readonly DEPLOYING: "DEPLOYING"; readonly DEPLOYMENT_ERROR: "DEPLOYMENT_ERROR"; readonly DEPLOYMENT_QUEUED: "DEPLOYMENT_QUEUED"; readonly DRY_RUN: "DRY_RUN"; readonly QUEUED: "QUEUED"; readonly READY: "READY"; readonly STOPPED: "STOPPED"; readonly STOPPING: "STOPPING"; readonly STOP_ERROR: "STOP_ERROR"; readonly STOP_QUEUED: "STOP_QUEUED"; readonly RESTART_QUEUED: "RESTART_QUEUED"; readonly RESTARTING: "RESTARTING"; readonly RESTARTED: "RESTARTED"; readonly RESTART_ERROR: "RESTART_ERROR"; readonly INVALID_CREDENTIALS: "INVALID_CREDENTIALS"; }; export type ClusterStateEnum = typeof ClusterStateEnum[keyof typeof ClusterStateEnum]; /** * * @export * @interface ClusterStatus */ export interface ClusterStatus { /** * * @type {string} * @memberof ClusterStatus */ 'cluster_id': string; /** * * @type {ClusterStateEnum} * @memberof ClusterStatus */ 'status': ClusterStateEnum; /** * * @type {boolean} * @memberof ClusterStatus */ 'is_deployed': boolean; /** * * @type {string} * @memberof ClusterStatus */ 'next_k8s_available_version'?: string | null; /** * * @type {string} * @memberof ClusterStatus */ 'last_execution_id'?: string | null; /** * * @type {ClusterLock} * @memberof ClusterStatus */ 'cluster_lock'?: ClusterLock | null; /** * * @type {string} * @memberof ClusterStatus */ 'last_deployment_date'?: string | null; /** * * @type {DeploymentInfraReason} * @memberof ClusterStatus */ 'reason': DeploymentInfraReason; } /** * * @export * @interface ClusterStatusResponseList */ export interface ClusterStatusResponseList { /** * * @type {Array} * @memberof ClusterStatusResponseList */ 'results'?: Array; } /** * * @export * @interface Commit */ export interface Commit { /** * * @type {string} * @memberof Commit */ 'created_at': string; /** * * @type {string} * @memberof Commit */ 'git_commit_id': string; /** * * @type {string} * @memberof Commit */ 'tag': string; /** * * @type {string} * @memberof Commit */ 'message': string; /** * * @type {string} * @memberof Commit */ 'author_name': string; /** * * @type {string} * @memberof Commit */ 'author_avatar_url'?: string; /** * * @type {string} * @memberof Commit */ 'commit_page_url'?: string; } /** * * @export * @interface CommitResponseList */ export interface CommitResponseList { /** * * @type {Array} * @memberof CommitResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const CompanySizeEnum: { readonly _1_10: "1-10"; readonly _11_50: "11-50"; readonly _51_200: "51-200"; readonly _201_500: "201-500"; readonly _500: "500+"; }; export type CompanySizeEnum = typeof CompanySizeEnum[keyof typeof CompanySizeEnum]; /** * * @export * @interface ContainerAdvancedSettings */ export interface ContainerAdvancedSettings { /** * disable custom domain check when deploying an application * @type {boolean} * @memberof ContainerAdvancedSettings */ 'deployment.custom_domain_check_enabled'?: boolean; /** * define how long in seconds an application is supposed to be stopped gracefully * @type {number} * @memberof ContainerAdvancedSettings */ 'deployment.termination_grace_period_seconds'?: number; /** * Set pod placement on specific Kubernetes nodes labels * @type {{ [key: string]: string; }} * @memberof ContainerAdvancedSettings */ 'deployment.affinity.node.required'?: { [key: string]: string; }; /** * Define how you want pods affinity to behave: * `Preferred` allows, but does not require, pods of a given service are not co-located (or co-hosted) on a single node * `Requirred` ensures that the pods of a given service are not co-located (or co-hosted) on a single node (safer in term of availability but can be expensive depending on the number of replicas) * @type {string} * @memberof ContainerAdvancedSettings */ 'deployment.antiaffinity.pod'?: ContainerAdvancedSettingsDeploymentAntiaffinityPodEnum; /** * Define how you want pods to be spread across availability zones: * `Disabled` no topology spread constraints are applied * `ScheduleAnyway` pods are spread across zones on a best-effort basis (soft constraint) * `DoNotSchedule` pods must be evenly spread across zones with a maxSkew of 1 (hard constraint) * @type {string} * @memberof ContainerAdvancedSettings */ 'deployment.topology_spread.zone'?: ContainerAdvancedSettingsDeploymentTopologySpreadZoneEnum; /** * * `RollingUpdate` gracefully rollout new versions, and automatically rollback if the new version fails to start * `Recreate` stop all current versions and create new ones once all old ones have been shutdown * @type {string} * @memberof ContainerAdvancedSettings */ 'deployment.update_strategy.type'?: ContainerAdvancedSettingsDeploymentUpdateStrategyTypeEnum; /** * Define the percentage of a maximum number of pods that can be unavailable during the update process * @type {number} * @memberof ContainerAdvancedSettings */ 'deployment.update_strategy.rolling_update.max_unavailable_percent'?: number; /** * Define the percentage of the maximum number of pods that can be created over the desired number of pods * @type {number} * @memberof ContainerAdvancedSettings */ 'deployment.update_strategy.rolling_update.max_surge_percent'?: number; /** * * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.proxy_body_size_mb'?: number; /** * When using SSL offloading outside of cluster, you can enforce a redirect to HTTPS even when there is no TLS certificate available * @type {boolean} * @memberof ContainerAdvancedSettings */ 'network.ingress.force_ssl_redirect'?: boolean; /** * * @type {boolean} * @memberof ContainerAdvancedSettings */ 'network.ingress.enable_cors'?: boolean; /** * * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.cors_allow_origin'?: string; /** * * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.cors_allow_methods'?: string; /** * * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.cors_allow_headers'?: string; /** * header buffer size used while reading response header from upstream * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.proxy_buffer_size_kb'?: number; /** * Limits the maximum time (in seconds) during which requests can be processed through one keepalive connection * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.keepalive_time_seconds'?: number; /** * Sets a timeout (in seconds) during which an idle keepalive connection to an upstream server will stay open. * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.keepalive_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a response to the client * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for establishing a connection to a proxied server * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.proxy_connect_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a request to the proxied server * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.proxy_send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for reading a response from the proxied server * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.proxy_read_timeout_seconds'?: number; /** * Allows to enable or disable nginx `proxy-buffering` * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.proxy_buffering'?: string; /** * Allows to enable or disable nginx `proxy-request-buffering` * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.proxy_request_buffering'?: string; /** * Sets a timeout (in seconds) for transmitting a request to the grpc server * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.grpc_send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a request to the grpc server * @type {number} * @memberof ContainerAdvancedSettings */ 'network.ingress.grpc_read_timeout_seconds'?: number; /** * list of source ranges to allow access to ingress proxy. This property can be used to whitelist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 To allow all source ranges, set 0.0.0.0/0. * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.whitelist_source_range'?: string; /** * list of source ranges to deny access to ingress proxy. This property can be used to blacklist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.denylist_source_range'?: string; /** * Allows to define response headers * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.extra_headers'?: string; /** * Sets a timeout (in seconds) for requests proxied through the Gateway API route. * @type {number} * @memberof ContainerAdvancedSettings */ 'network.gateway_api.http_request_timeout_seconds'?: number | null; /** * Sets the idle timeout (in seconds) for HTTP connections proxied through the Gateway API route. * @type {number} * @memberof ContainerAdvancedSettings */ 'network.gateway_api.http_connection_idle_timeout_seconds'?: number | null; /** * Sets the number of retry attempts for requests proxied through the Gateway API route. * @type {number} * @memberof ContainerAdvancedSettings */ 'network.gateway_api.retry.num_retries'?: number | null; /** * Comma-separated retry triggers (for example connect-failure,reset,refused-stream,retriable-status-codes) for requests proxied through the Gateway API route. * @type {string} * @memberof ContainerAdvancedSettings */ 'network.gateway_api.retry.retry_on'?: string | null; /** * Comma-separated HTTP status codes (100..599) retried when retry_on includes retriable-status-codes. * @type {string} * @memberof ContainerAdvancedSettings */ 'network.gateway_api.retry.http_status_codes'?: string | null; /** * Sets the timeout (in seconds) applied to each retry attempt for requests proxied through the Gateway API route. * @type {number} * @memberof ContainerAdvancedSettings */ 'network.gateway_api.retry.per_try_timeout_seconds'?: number | null; /** * Set the name of an environment variable to use as a basic authentication (`login:crypted_password`) from `htpasswd` command. You can add multiples comma separated values. * @type {string} * @memberof ContainerAdvancedSettings */ 'network.ingress.basic_auth_env_var'?: string; /** * Enable the load balancer to bind a user\'s session to a specific target. This ensures that all requests from the user during the session are sent to the same target * @type {boolean} * @memberof ContainerAdvancedSettings */ 'network.ingress.enable_sticky_session'?: boolean; /** * Allows you to set an existing Kubernetes service account name * @type {string} * @memberof ContainerAdvancedSettings */ 'security.service_account_name'?: string; /** * Percentage value of cpu usage at which point pods should scale up. * @type {number} * @memberof ContainerAdvancedSettings */ 'hpa.cpu.average_utilization_percent'?: number; /** * Percentage value of memory usage at which point pods should scale up. * @type {number} * @memberof ContainerAdvancedSettings */ 'hpa.memory.average_utilization_percent'?: number | null; /** * Automount Kubernetes service account token to have access to Kubernetes API from pods * @type {boolean} * @memberof ContainerAdvancedSettings */ 'security.automount_service_account_token'?: boolean; /** * Mounts the container\'s root filesystem as read-only * @type {boolean} * @memberof ContainerAdvancedSettings */ 'security.read_only_root_filesystem'?: boolean; } export declare const ContainerAdvancedSettingsDeploymentAntiaffinityPodEnum: { readonly PREFERRED: "Preferred"; readonly REQUIRRED: "Requirred"; }; export type ContainerAdvancedSettingsDeploymentAntiaffinityPodEnum = typeof ContainerAdvancedSettingsDeploymentAntiaffinityPodEnum[keyof typeof ContainerAdvancedSettingsDeploymentAntiaffinityPodEnum]; export declare const ContainerAdvancedSettingsDeploymentTopologySpreadZoneEnum: { readonly DISABLED: "Disabled"; readonly SCHEDULE_ANYWAY: "ScheduleAnyway"; readonly DO_NOT_SCHEDULE: "DoNotSchedule"; }; export type ContainerAdvancedSettingsDeploymentTopologySpreadZoneEnum = typeof ContainerAdvancedSettingsDeploymentTopologySpreadZoneEnum[keyof typeof ContainerAdvancedSettingsDeploymentTopologySpreadZoneEnum]; export declare const ContainerAdvancedSettingsDeploymentUpdateStrategyTypeEnum: { readonly ROLLING_UPDATE: "RollingUpdate"; readonly RECREATE: "Recreate"; }; export type ContainerAdvancedSettingsDeploymentUpdateStrategyTypeEnum = typeof ContainerAdvancedSettingsDeploymentUpdateStrategyTypeEnum[keyof typeof ContainerAdvancedSettingsDeploymentUpdateStrategyTypeEnum]; /** * * @export * @interface ContainerDeployRequest */ export interface ContainerDeployRequest { /** * Image tag to deploy * @type {string} * @memberof ContainerDeployRequest */ 'image_tag': string; } /** * * @export * @interface ContainerImageCheckRequest */ export interface ContainerImageCheckRequest { /** * * @type {string} * @memberof ContainerImageCheckRequest */ 'registry_id'?: string; /** * * @type {string} * @memberof ContainerImageCheckRequest */ 'image_name': string; /** * * @type {string} * @memberof ContainerImageCheckRequest */ 'tag': string; } /** * * @export * @interface ContainerNetwork */ export interface ContainerNetwork { /** * Specify if the sticky session option (also called persistant session) is activated or not for this container. If activated, user will be redirected by the load balancer to the same instance each time he access to the container. * @type {boolean} * @memberof ContainerNetwork */ 'sticky_session'?: boolean; } /** * * @export * @interface ContainerNetworkRequest */ export interface ContainerNetworkRequest { /** * Specify if the sticky session option (also called persistant session) is activated or not for this container. If activated, user will be redirected by the load balancer to the same instance each time he access to the container. * @type {boolean} * @memberof ContainerNetworkRequest */ 'sticky_session'?: boolean; } /** * * @export * @enum {string} */ export declare const ContainerRegistryAssociatedServiceType: { readonly CONTAINER: "CONTAINER"; readonly LIFECYCLE: "LIFECYCLE"; readonly CRON: "CRON"; }; export type ContainerRegistryAssociatedServiceType = typeof ContainerRegistryAssociatedServiceType[keyof typeof ContainerRegistryAssociatedServiceType]; /** * * @export * @interface ContainerRegistryAssociatedServicesResponse */ export interface ContainerRegistryAssociatedServicesResponse { /** * * @type {string} * @memberof ContainerRegistryAssociatedServicesResponse */ 'project_id': string; /** * * @type {string} * @memberof ContainerRegistryAssociatedServicesResponse */ 'project_name': string; /** * * @type {string} * @memberof ContainerRegistryAssociatedServicesResponse */ 'environment_id': string; /** * * @type {string} * @memberof ContainerRegistryAssociatedServicesResponse */ 'environment_name': string; /** * * @type {string} * @memberof ContainerRegistryAssociatedServicesResponse */ 'service_id': string; /** * * @type {string} * @memberof ContainerRegistryAssociatedServicesResponse */ 'service_name': string; /** * * @type {ContainerRegistryAssociatedServiceType} * @memberof ContainerRegistryAssociatedServicesResponse */ 'service_type': ContainerRegistryAssociatedServiceType; } /** * * @export * @interface ContainerRegistryAssociatedServicesResponseList */ export interface ContainerRegistryAssociatedServicesResponseList { /** * * @type {Array} * @memberof ContainerRegistryAssociatedServicesResponseList */ 'results'?: Array; } /** * The type of your container registry * @export * @enum {string} */ export declare const ContainerRegistryKindEnum: { readonly ECR: "ECR"; readonly SCALEWAY_CR: "SCALEWAY_CR"; readonly DOCKER_HUB: "DOCKER_HUB"; readonly GITHUB_CR: "GITHUB_CR"; readonly GITHUB_ENTERPRISE_CR: "GITHUB_ENTERPRISE_CR"; readonly GITLAB_CR: "GITLAB_CR"; readonly PUBLIC_ECR: "PUBLIC_ECR"; readonly DOCR: "DOCR"; readonly GENERIC_CR: "GENERIC_CR"; readonly GCP_ARTIFACT_REGISTRY: "GCP_ARTIFACT_REGISTRY"; readonly AZURE_CR: "AZURE_CR"; }; export type ContainerRegistryKindEnum = typeof ContainerRegistryKindEnum[keyof typeof ContainerRegistryKindEnum]; /** * * @export * @interface ContainerRegistryProviderDetailsResponse */ export interface ContainerRegistryProviderDetailsResponse { /** * * @type {string} * @memberof ContainerRegistryProviderDetailsResponse */ 'id': string; /** * * @type {string} * @memberof ContainerRegistryProviderDetailsResponse */ 'name': string; /** * URL of the container registry * @type {string} * @memberof ContainerRegistryProviderDetailsResponse */ 'url': string; /** * * @type {ContainerRegistryKindEnum} * @memberof ContainerRegistryProviderDetailsResponse */ 'kind': ContainerRegistryKindEnum; } /** * * @export * @interface ContainerRegistryRequest */ export interface ContainerRegistryRequest { /** * * @type {string} * @memberof ContainerRegistryRequest */ 'name': string; /** * * @type {ContainerRegistryKindEnum} * @memberof ContainerRegistryRequest */ 'kind': ContainerRegistryKindEnum; /** * * @type {string} * @memberof ContainerRegistryRequest */ 'description'?: string; /** * URL of the container registry: * For `DOCKER_HUB`: it must be `https://docker.io` (default with \'https://docker.io\' if no url provided for `DOCKER_HUB`) * For `GITHUB_CR`: it must be `https://ghcr.io` (default with \'https://ghcr.io\' if no url provided for `GITHUB_CR`) * For `GITLAB_CR`: it must be `https://registry.gitlab.com` (default with \'https://registry.gitlab.com\' if no url provided for `GITLAB_CR`) * For others: it\'s required and must start by `https://` * @type {string} * @memberof ContainerRegistryRequest */ 'url'?: string; /** * * @type {ContainerRegistryRequestConfig} * @memberof ContainerRegistryRequest */ 'config': ContainerRegistryRequestConfig; } /** * This field is dependent of the container registry kind: * `ECR` needs in the config: region, access_key_id, secret_access_key * `SCALEWAY_CR` needs in the config: region, scaleway_access_key, scaleway_secret_key * `GCP_ARTIFACT_REGISTRY` needs in the config: region, json_credentials * `DOCKER_HUB` needs in the config (optional): username, password * `GITHUB_CR` needs in the config (optional): username, password * `GITLAB_CR` needs in the config (optional): username, password * `PUBLIC_ECR` doesn\'t need credentials info * `GENERIC_CR` needs in the config (optional): username, password * `DOCR` is not supported anymore * @export * @interface ContainerRegistryRequestConfig */ export interface ContainerRegistryRequestConfig { /** * Required if kind is `ECR` or `PUBLIC_ECR` * @type {string} * @memberof ContainerRegistryRequestConfig */ 'access_key_id'?: string; /** * Required if kind is `ECR` or `PUBLIC_ECR` * @type {string} * @memberof ContainerRegistryRequestConfig */ 'secret_access_key'?: string; /** * Required if kind is `ECR` or `SCALEWAY_CR` * @type {string} * @memberof ContainerRegistryRequestConfig */ 'region'?: string; /** * Required if kind is `SCALEWAY_CR` * @type {string} * @memberof ContainerRegistryRequestConfig */ 'scaleway_access_key'?: string; /** * Required if kind is `SCALEWAY_CR` * @type {string} * @memberof ContainerRegistryRequestConfig */ 'scaleway_secret_key'?: string; /** * Required if kind is `SCALEWAY_CR` * @type {string} * @memberof ContainerRegistryRequestConfig */ 'scaleway_project_id'?: string; /** * Required if kind is `GCP_ARTIFACT_REGISTRY` * @type {string} * @memberof ContainerRegistryRequestConfig */ 'json_credentials'?: string; /** * optional, for kind `DOCKER_HUB` We encourage you to set credentials for Docker Hub due to the limits on the pull rate * @type {string} * @memberof ContainerRegistryRequestConfig */ 'username'?: string; /** * optional, for kind `DOCKER_HUB` We encourage you to set credentials for Docker Hub due to the limits on the pull rate * @type {string} * @memberof ContainerRegistryRequestConfig */ 'password'?: string; /** * For ECR, you can either set a static access_key or use a role arn that we are going to assume * @type {string} * @memberof ContainerRegistryRequestConfig */ 'role_arn'?: string; /** * Required if kind is `AZURE_CR`. * @type {string} * @memberof ContainerRegistryRequestConfig */ 'azure_tenant_id'?: string; /** * Required if kind is `AZURE_CR`. * @type {string} * @memberof ContainerRegistryRequestConfig */ 'azure_subscription_id'?: string; } /** * * @export * @interface ContainerRegistryResponse */ export interface ContainerRegistryResponse { /** * * @type {string} * @memberof ContainerRegistryResponse */ 'id': string; /** * * @type {string} * @memberof ContainerRegistryResponse */ 'created_at': string; /** * * @type {string} * @memberof ContainerRegistryResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof ContainerRegistryResponse */ 'name'?: string; /** * * @type {ContainerRegistryKindEnum} * @memberof ContainerRegistryResponse */ 'kind'?: ContainerRegistryKindEnum; /** * * @type {string} * @memberof ContainerRegistryResponse */ 'description'?: string; /** * URL of the container registry * @type {string} * @memberof ContainerRegistryResponse */ 'url'?: string; /** * * @type {ContainerRegistryResponseAllOfCluster} * @memberof ContainerRegistryResponse */ 'cluster'?: ContainerRegistryResponseAllOfCluster; /** * The number of services using this container registry * @type {number} * @memberof ContainerRegistryResponse */ 'associated_services_count'?: number; /** * * @type {ContainerRegistryResponseAllOfConfig} * @memberof ContainerRegistryResponse */ 'config'?: ContainerRegistryResponseAllOfConfig; } /** * * @export * @interface ContainerRegistryResponseAllOfCluster */ export interface ContainerRegistryResponseAllOfCluster { /** * * @type {string} * @memberof ContainerRegistryResponseAllOfCluster */ 'id': string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfCluster */ 'name': string; } /** * * @export * @interface ContainerRegistryResponseAllOfConfig */ export interface ContainerRegistryResponseAllOfConfig { /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'username'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'region'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'scaleway_access_key'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'scaleway_project_id'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'access_key_id'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'role_arn'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'azure_tenant_id'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'azure_subscription_id'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'azure_application_id'?: string; /** * * @type {string} * @memberof ContainerRegistryResponseAllOfConfig */ 'azure_application_object_id'?: string; } /** * * @export * @interface ContainerRegistryResponseList */ export interface ContainerRegistryResponseList { /** * * @type {Array} * @memberof ContainerRegistryResponseList */ 'results'?: Array; } /** * * @export * @interface ContainerRequest */ export interface ContainerRequest { /** * * @type {Array} * @memberof ContainerRequest */ 'storage'?: Array; /** * * @type {Array} * @memberof ContainerRequest */ 'ports'?: Array; /** * name is case insensitive * @type {string} * @memberof ContainerRequest */ 'name': string; /** * give a description to this container * @type {string} * @memberof ContainerRequest */ 'description'?: string; /** * id of the linked registry * @type {string} * @memberof ContainerRequest */ 'registry_id': string; /** * The image name pattern differs according to chosen container registry provider: * `ECR`: `repository` * `SCALEWAY_CR`: `namespace/image` * `DOCKER_HUB`: `image` or `repository/image` * `PUBLIC_ECR`: `registry_alias/repository` * @type {string} * @memberof ContainerRequest */ 'image_name': string; /** * tag of the image container * @type {string} * @memberof ContainerRequest */ 'tag': string; /** * * @type {Array} * @memberof ContainerRequest */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof ContainerRequest */ 'entrypoint'?: string; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof ContainerRequest */ 'cpu'?: number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof ContainerRequest */ 'memory'?: number; /** * * @type {number} * @memberof ContainerRequest */ 'gpu'?: number; /** * Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running. * @type {number} * @memberof ContainerRequest */ 'min_running_instances'?: number; /** * Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. * @type {number} * @memberof ContainerRequest */ 'max_running_instances'?: number; /** * * @type {Healthcheck} * @memberof ContainerRequest */ 'healthchecks': Healthcheck; /** * Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof ContainerRequest */ 'auto_preview'?: boolean; /** * Specify if the container will be automatically updated after receiving a new image tag. The new image tag shall be communicated via the \"Auto Deploy container\" endpoint https://api-doc.qovery.com/#tag/Containers/operation/autoDeployContainerEnvironments * @type {boolean} * @memberof ContainerRequest */ 'auto_deploy'?: boolean | null; /** * * @type {Array} * @memberof ContainerRequest */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof ContainerRequest */ 'labels_groups'?: Array; /** * Icon URI representing the container. * @type {string} * @memberof ContainerRequest */ 'icon_uri'?: string; /** * * @type {AutoscalingPolicyRequest} * @memberof ContainerRequest */ 'autoscaling'?: AutoscalingPolicyRequest; } /** * * @export * @interface ContainerResponse */ export interface ContainerResponse { /** * * @type {string} * @memberof ContainerResponse */ 'id': string; /** * * @type {string} * @memberof ContainerResponse */ 'created_at': string; /** * * @type {string} * @memberof ContainerResponse */ 'updated_at'?: string; /** * * @type {Array} * @memberof ContainerResponse */ 'storage'?: Array; /** * The image name pattern differs according to chosen container registry provider: * `ECR`: `repository` * `SCALEWAY_CR`: `namespace/image` * `DOCKER_HUB`: `image` or `repository/image` * `PUBLIC_ECR`: `registry_alias/repository` * @type {string} * @memberof ContainerResponse */ 'image_name': string; /** * tag of the image container * @type {string} * @memberof ContainerResponse */ 'tag': string; /** * tag of the image container * @type {string} * @memberof ContainerResponse */ 'registry_id'?: string; /** * * @type {ContainerRegistryProviderDetailsResponse} * @memberof ContainerResponse */ 'registry': ContainerRegistryProviderDetailsResponse; /** * * @type {ReferenceObject} * @memberof ContainerResponse */ 'environment': ReferenceObject; /** * Maximum cpu that can be allocated to the container based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof ContainerResponse */ 'maximum_cpu': number; /** * Maximum memory that can be allocated to the container based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof ContainerResponse */ 'maximum_memory': number; /** * Maximum memory that can be allocated to the container based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof ContainerResponse */ 'maximum_gpu': number; /** * name is case insensitive * @type {string} * @memberof ContainerResponse */ 'name': string; /** * give a description to this container * @type {string} * @memberof ContainerResponse */ 'description'?: string; /** * * @type {Array} * @memberof ContainerResponse */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof ContainerResponse */ 'entrypoint'?: string; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof ContainerResponse */ 'cpu': number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof ContainerResponse */ 'memory': number; /** * * @type {number} * @memberof ContainerResponse */ 'gpu': number; /** * Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running. * @type {number} * @memberof ContainerResponse */ 'min_running_instances': number; /** * Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. * @type {number} * @memberof ContainerResponse */ 'max_running_instances': number; /** * * @type {Healthcheck} * @memberof ContainerResponse */ 'healthchecks': Healthcheck; /** * Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof ContainerResponse */ 'auto_preview': boolean; /** * * @type {Array} * @memberof ContainerResponse */ 'ports'?: Array; /** * Specify if the container will be automatically updated after receiving a new image tag. The new image tag shall be communicated via the \"Auto Deploy container\" endpoint https://api-doc.qovery.com/#tag/Containers/operation/autoDeployContainerEnvironments * @type {boolean} * @memberof ContainerResponse */ 'auto_deploy'?: boolean; /** * * @type {Array} * @memberof ContainerResponse */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof ContainerResponse */ 'labels_groups'?: Array; /** * Icon URI representing the container. * @type {string} * @memberof ContainerResponse */ 'icon_uri': string; /** * * @type {ServiceTypeEnum} * @memberof ContainerResponse */ 'service_type': ServiceTypeEnum; /** * * @type {AutoscalingPolicyResponse} * @memberof ContainerResponse */ 'autoscaling'?: AutoscalingPolicyResponse; } /** * * @export * @interface ContainerResponseList */ export interface ContainerResponseList { /** * * @type {Array} * @memberof ContainerResponseList */ 'results'?: Array; } /** * * @export * @interface ContainerSource */ export interface ContainerSource { /** * The image name pattern differs according to chosen container registry provider: * `ECR`: `repository` * `SCALEWAY_CR`: `namespace/image` * `DOCKER_HUB`: `image` or `repository/image` * `PUBLIC_ECR`: `registry_alias/repository` * @type {string} * @memberof ContainerSource */ 'image_name': string; /** * tag of the image container * @type {string} * @memberof ContainerSource */ 'tag': string; /** * tag of the image container * @type {string} * @memberof ContainerSource */ 'registry_id'?: string; /** * * @type {ContainerRegistryProviderDetailsResponse} * @memberof ContainerSource */ 'registry': ContainerRegistryProviderDetailsResponse; } /** * * @export * @interface ContainerVersionResponse */ export interface ContainerVersionResponse { /** * * @type {string} * @memberof ContainerVersionResponse */ 'image_name'?: string; /** * * @type {Array} * @memberof ContainerVersionResponse */ 'versions'?: Array; } /** * * @export * @interface ContainerVersionResponseList */ export interface ContainerVersionResponseList { /** * * @type {Array} * @memberof ContainerVersionResponseList */ 'results'?: Array; } /** * * @export * @interface Cost */ export interface Cost { /** * * @type {number} * @memberof Cost */ 'total_in_cents': number; /** * * @type {number} * @memberof Cost */ 'total': number; /** * * @type {string} * @memberof Cost */ 'currency_code': string; } /** * * @export * @interface CostRange */ export interface CostRange { /** * * @type {number} * @memberof CostRange */ 'min_cost_in_cents'?: number; /** * * @type {number} * @memberof CostRange */ 'min_cost'?: number; /** * * @type {number} * @memberof CostRange */ 'max_cost_in_cents'?: number; /** * * @type {number} * @memberof CostRange */ 'max_cost'?: number; /** * * @type {string} * @memberof CostRange */ 'currency_code': string; } /** * * @export * @enum {string} */ export declare const CpuArchitectureEnum: { readonly AMD64: "AMD64"; readonly ARM64: "ARM64"; }; export type CpuArchitectureEnum = typeof CpuArchitectureEnum[keyof typeof CpuArchitectureEnum]; /** * * @export * @enum {string} */ export declare const CreateEnvironmentModeEnum: { readonly DEVELOPMENT: "DEVELOPMENT"; readonly PRODUCTION: "PRODUCTION"; readonly STAGING: "STAGING"; }; export type CreateEnvironmentModeEnum = typeof CreateEnvironmentModeEnum[keyof typeof CreateEnvironmentModeEnum]; /** * * @export * @interface CreateEnvironmentRequest */ export interface CreateEnvironmentRequest { /** * name is case insensitive * @type {string} * @memberof CreateEnvironmentRequest */ 'name': string; /** * * @type {string} * @memberof CreateEnvironmentRequest */ 'cluster'?: string; /** * * @type {CreateEnvironmentModeEnum} * @memberof CreateEnvironmentRequest */ 'mode'?: CreateEnvironmentModeEnum; } /** * * @export * @interface CredentialCluster */ export interface CredentialCluster { /** * * @type {string} * @memberof CredentialCluster */ 'id'?: string; /** * * @type {string} * @memberof CredentialCluster */ 'name'?: string; /** * * @type {CloudProviderEnum} * @memberof CredentialCluster */ 'cloud_provider'?: CloudProviderEnum; } /** * * @export * @interface Credentials */ export interface Credentials { /** * * @type {string} * @memberof Credentials */ 'host': string; /** * * @type {number} * @memberof Credentials */ 'port': number; /** * * @type {string} * @memberof Credentials */ 'login': string; /** * * @type {string} * @memberof Credentials */ 'password': string; } /** * * @export * @interface CredentialsRequest */ export interface CredentialsRequest { /** * * @type {string} * @memberof CredentialsRequest */ 'login': string; /** * * @type {string} * @memberof CredentialsRequest */ 'password': string; } /** * * @export * @interface CreditCard */ export interface CreditCard { /** * * @type {string} * @memberof CreditCard */ 'id': string; /** * * @type {string} * @memberof CreditCard */ 'created_at': string; /** * * @type {number} * @memberof CreditCard */ 'expiry_month': number; /** * * @type {number} * @memberof CreditCard */ 'expiry_year': number; /** * * @type {string} * @memberof CreditCard */ 'last_digit': string; /** * * @type {boolean} * @memberof CreditCard */ 'is_expired': boolean; /** * * @type {string} * @memberof CreditCard */ 'brand': string; } /** * * @export * @interface CreditCardRequest */ export interface CreditCardRequest { /** * * @type {string} * @memberof CreditCardRequest */ 'number': string; /** * * @type {string} * @memberof CreditCardRequest */ 'cvv': string; /** * * @type {number} * @memberof CreditCardRequest */ 'expiry_month': number; /** * * @type {number} * @memberof CreditCardRequest */ 'expiry_year': number; /** * Token generated by payment solution platform. * @type {string} * @memberof CreditCardRequest */ 'token'?: string | null; } /** * * @export * @interface CreditCardResponseList */ export interface CreditCardResponseList { /** * * @type {Array} * @memberof CreditCardResponseList */ 'results'?: Array; } /** * * @export * @interface CronJobResponse */ export interface CronJobResponse { /** * * @type {string} * @memberof CronJobResponse */ 'id': string; /** * * @type {string} * @memberof CronJobResponse */ 'created_at': string; /** * * @type {string} * @memberof CronJobResponse */ 'updated_at'?: string; /** * * @type {ReferenceObject} * @memberof CronJobResponse */ 'environment': ReferenceObject; /** * Maximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof CronJobResponse */ 'maximum_cpu': number; /** * Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof CronJobResponse */ 'maximum_memory': number; /** * Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof CronJobResponse */ 'maximum_gpu': number; /** * name is case insensitive * @type {string} * @memberof CronJobResponse */ 'name': string; /** * * @type {string} * @memberof CronJobResponse */ 'description'?: string; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof CronJobResponse */ 'cpu': number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof CronJobResponse */ 'memory': number; /** * * @type {number} * @memberof CronJobResponse */ 'gpu': number; /** * Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed * @type {number} * @memberof CronJobResponse */ 'max_nb_restart'?: number; /** * Maximum number of seconds allowed for the job to run before killing it and mark it as failed * @type {number} * @memberof CronJobResponse */ 'max_duration_seconds'?: number; /** * Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof CronJobResponse */ 'auto_preview': boolean; /** * Port where to run readiness and liveliness probes checks. The port will not be exposed externally * @type {number} * @memberof CronJobResponse */ 'port'?: number | null; /** * * @type {BaseJobResponseAllOfSource} * @memberof CronJobResponse */ 'source': BaseJobResponseAllOfSource; /** * * @type {Healthcheck} * @memberof CronJobResponse */ 'healthchecks': Healthcheck; /** * Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the \"Auto Deploy job\" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments * @type {boolean} * @memberof CronJobResponse */ 'auto_deploy'?: boolean; /** * Icon URI representing the job. * @type {string} * @memberof CronJobResponse */ 'icon_uri': string; /** * * @type {ServiceTypeEnum} * @memberof CronJobResponse */ 'service_type': ServiceTypeEnum; /** * * @type {JobTypeEnum} * @memberof CronJobResponse */ 'job_type': JobTypeEnum; /** * * @type {CronJobResponseAllOfSchedule} * @memberof CronJobResponse */ 'schedule': CronJobResponseAllOfSchedule; /** * * @type {Array} * @memberof CronJobResponse */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof CronJobResponse */ 'labels_groups'?: Array; } /** * * @export * @interface CronJobResponseAllOfSchedule */ export interface CronJobResponseAllOfSchedule { /** * * @type {CronJobResponseAllOfScheduleCronjob} * @memberof CronJobResponseAllOfSchedule */ 'cronjob': CronJobResponseAllOfScheduleCronjob; } /** * * @export * @interface CronJobResponseAllOfScheduleCronjob */ export interface CronJobResponseAllOfScheduleCronjob { /** * * @type {Array} * @memberof CronJobResponseAllOfScheduleCronjob */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof CronJobResponseAllOfScheduleCronjob */ 'entrypoint'?: string; /** * tz identifier at which the schedule at will be executed * @type {string} * @memberof CronJobResponseAllOfScheduleCronjob */ 'timezone': string; /** * Can only be set if the event is CRON. Represent the cron format for the job schedule without seconds. For example: `* * * * *` represent the cron to launch the job every minute. See https://crontab.guru/ to WISIWIG interface. Timezone is UT * @type {string} * @memberof CronJobResponseAllOfScheduleCronjob */ 'scheduled_at': string; } /** * * @export * @interface CurrentCost */ export interface CurrentCost { /** * * @type {PlanEnum} * @memberof CurrentCost */ 'plan'?: PlanEnum; /** * number of days remaining before the end of the trial period * @type {number} * @memberof CurrentCost */ 'remaining_trial_day'?: number; /** * date when the current plan will be renewed * @type {string} * @memberof CurrentCost */ 'renewal_at'?: string | null; /** * * @type {Cost} * @memberof CurrentCost */ 'cost'?: Cost; } /** * * @export * @interface CustomDomain */ export interface CustomDomain { /** * * @type {string} * @memberof CustomDomain */ 'id': string; /** * * @type {string} * @memberof CustomDomain */ 'created_at': string; /** * * @type {string} * @memberof CustomDomain */ 'updated_at'?: string; /** * your custom domain * @type {string} * @memberof CustomDomain */ 'domain': string; /** * to control if a certificate has to be generated for this custom domain by Qovery. The default value is `true`. This flag should be set to `false` if a CDN or other entities are managing the certificate for the specified domain and the traffic is proxied by the CDN to Qovery. * @type {boolean} * @memberof CustomDomain */ 'generate_certificate': boolean; /** * Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment: * If `true` then we only check the domain points to an IP * If `false` then we check that the domain resolves to the correct service Load Balancer * @type {boolean} * @memberof CustomDomain */ 'use_cdn'?: boolean; /** * URL provided by Qovery. You must create a CNAME on your DNS provider using that URL * @type {string} * @memberof CustomDomain */ 'validation_domain'?: string; /** * * @type {CustomDomainStatusEnum} * @memberof CustomDomain */ 'status'?: CustomDomainStatusEnum; } /** * * @export * @interface CustomDomainRequest */ export interface CustomDomainRequest { /** * your custom domain * @type {string} * @memberof CustomDomainRequest */ 'domain': string; /** * to control if a certificate has to be generated for this custom domain by Qovery. The default value is `true`. This flag should be set to `false` if a CDN or other entities are managing the certificate for the specified domain and the traffic is proxied by the CDN to Qovery. * @type {boolean} * @memberof CustomDomainRequest */ 'generate_certificate': boolean; /** * Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment: * If `true` then we only check the domain points to an IP * If `false` then we check that the domain resolves to the correct service Load Balancer * @type {boolean} * @memberof CustomDomainRequest */ 'use_cdn'?: boolean; } /** * * @export * @interface CustomDomainResponseList */ export interface CustomDomainResponseList { /** * * @type {Array} * @memberof CustomDomainResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const CustomDomainStatusEnum: { readonly VALIDATION_PENDING: "VALIDATION_PENDING"; }; export type CustomDomainStatusEnum = typeof CustomDomainStatusEnum[keyof typeof CustomDomainStatusEnum]; /** * * @export * @interface Database */ export interface Database { /** * * @type {string} * @memberof Database */ 'id': string; /** * * @type {string} * @memberof Database */ 'created_at': string; /** * * @type {string} * @memberof Database */ 'updated_at'?: string; /** * name is case insensitive * @type {string} * @memberof Database */ 'name': string; /** * give a description to this database * @type {string} * @memberof Database */ 'description'?: string; /** * * @type {DatabaseTypeEnum} * @memberof Database */ 'type': DatabaseTypeEnum; /** * * @type {string} * @memberof Database */ 'version': string; /** * * @type {DatabaseModeEnum} * @memberof Database */ 'mode': DatabaseModeEnum; /** * * @type {DatabaseAccessibilityEnum} * @memberof Database */ 'accessibility'?: DatabaseAccessibilityEnum; /** * unit is millicores (m). 1000m = 1 cpu This field will be ignored for managed DB (instance type will be used instead). * @type {number} * @memberof Database */ 'cpu'?: number; /** * Database instance type to be used for this database. The list of values can be retrieved via the endpoint /{CloudProvider}/managedDatabase/instanceType/{region}/{dbType}. This field is null for container DB. * @type {string} * @memberof Database */ 'instance_type'?: string; /** * unit is MB. 1024 MB = 1GB This field will be ignored for managed DB (instance type will be used instead). Default value is linked to the database type: - MANAGED: `100` - CONTAINER - POSTGRES: `100` - REDIS: `100` - MYSQL: `512` - MONGODB: `256` * @type {number} * @memberof Database */ 'memory'?: number; /** * unit is GB * @type {number} * @memberof Database */ 'storage'?: number; /** * * @type {Array} * @memberof Database */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof Database */ 'labels_groups'?: Array; /** * Icon URI representing the database. * @type {string} * @memberof Database */ 'icon_uri': string; /** * * @type {ReferenceObject} * @memberof Database */ 'environment': ReferenceObject; /** * * @type {string} * @memberof Database */ 'host'?: string; /** * * @type {number} * @memberof Database */ 'port'?: number; /** * Maximum cpu that can be allocated to the database based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof Database */ 'maximum_cpu'?: number; /** * Maximum memory that can be allocated to the database based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof Database */ 'maximum_memory'?: number; /** * indicates if the database disk is encrypted or not * @type {boolean} * @memberof Database */ 'disk_encrypted'?: boolean; /** * EBS disk type for the database. Only applicable for MANAGED mode (gp2 or gp3). Null for CONTAINER mode. * @type {string} * @memberof Database */ 'disk_type'?: DatabaseDiskTypeEnum | null; /** * * @type {ServiceTypeEnum} * @memberof Database */ 'service_type': ServiceTypeEnum; } export declare const DatabaseDiskTypeEnum: { readonly GP2: "gp2"; readonly GP3: "gp3"; }; export type DatabaseDiskTypeEnum = typeof DatabaseDiskTypeEnum[keyof typeof DatabaseDiskTypeEnum]; /** * * @export * @enum {string} */ export declare const DatabaseAccessibilityEnum: { readonly PRIVATE: "PRIVATE"; readonly PUBLIC: "PUBLIC"; }; export type DatabaseAccessibilityEnum = typeof DatabaseAccessibilityEnum[keyof typeof DatabaseAccessibilityEnum]; /** * * @export * @interface DatabaseConfiguration */ export interface DatabaseConfiguration { /** * * @type {DatabaseTypeEnum} * @memberof DatabaseConfiguration */ 'database_type'?: DatabaseTypeEnum; /** * * @type {Array} * @memberof DatabaseConfiguration */ 'version'?: Array; } /** * * @export * @interface DatabaseConfigurationResponseList */ export interface DatabaseConfigurationResponseList { /** * * @type {Array} * @memberof DatabaseConfigurationResponseList */ 'results'?: Array; } /** * * @export * @interface DatabaseEditRequest */ export interface DatabaseEditRequest { /** * name is case-insensitive * @type {string} * @memberof DatabaseEditRequest */ 'name'?: string; /** * give a description to this database * @type {string} * @memberof DatabaseEditRequest */ 'description'?: string; /** * * @type {string} * @memberof DatabaseEditRequest */ 'version'?: string; /** * * @type {DatabaseAccessibilityEnum} * @memberof DatabaseEditRequest */ 'accessibility'?: DatabaseAccessibilityEnum; /** * unit is millicores (m). 1000m = 1 cpu. This field will be ignored for managed DB (instance type will be used instead). * @type {number} * @memberof DatabaseEditRequest */ 'cpu'?: number; /** * unit is MB. 1024 MB = 1GB This field will be ignored for managed DB (instance type will be used instead). Default value is linked to the database type: - MANAGED: 100 - CONTAINER - POSTGRES: 100 - REDIS: 100 - MYSQL: 512 - MONGODB: 256 * @type {number} * @memberof DatabaseEditRequest */ 'memory'?: number; /** * unit is GB * @type {number} * @memberof DatabaseEditRequest */ 'storage'?: number; /** * Database instance type to be used for this database. The list of values can be retrieved via the endpoint /{CloudProvider}/managedDatabase/instanceType/{region}/{dbType}. This field SHOULD NOT be set for container DB. * @type {string} * @memberof DatabaseEditRequest */ 'instance_type'?: string; /** * * @type {Array} * @memberof DatabaseEditRequest */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof DatabaseEditRequest */ 'labels_groups'?: Array; /** * Icon URI representing the database. * @type {string} * @memberof DatabaseEditRequest */ 'icon_uri'?: string; /** * EBS disk type for MANAGED AWS databases. Allowed values: gp2, gp3. Only applicable for MANAGED mode. * @type {string} * @memberof DatabaseEditRequest */ 'disk_type'?: DatabaseEditRequestDiskTypeEnum | null; } export declare const DatabaseEditRequestDiskTypeEnum: { readonly GP2: "gp2"; readonly GP3: "gp3"; }; export type DatabaseEditRequestDiskTypeEnum = typeof DatabaseEditRequestDiskTypeEnum[keyof typeof DatabaseEditRequestDiskTypeEnum]; /** * * @export * @enum {string} */ export declare const DatabaseModeEnum: { readonly CONTAINER: "CONTAINER"; readonly MANAGED: "MANAGED"; }; export type DatabaseModeEnum = typeof DatabaseModeEnum[keyof typeof DatabaseModeEnum]; /** * * @export * @interface DatabaseRequest */ export interface DatabaseRequest { /** * name is case insensitive * @type {string} * @memberof DatabaseRequest */ 'name': string; /** * give a description to this database * @type {string} * @memberof DatabaseRequest */ 'description'?: string; /** * * @type {DatabaseTypeEnum} * @memberof DatabaseRequest */ 'type': DatabaseTypeEnum; /** * * @type {string} * @memberof DatabaseRequest */ 'version': string; /** * * @type {DatabaseModeEnum} * @memberof DatabaseRequest */ 'mode': DatabaseModeEnum; /** * * @type {DatabaseAccessibilityEnum} * @memberof DatabaseRequest */ 'accessibility'?: DatabaseAccessibilityEnum; /** * unit is millicores (m). 1000m = 1 cpu This field will be ignored for managed DB (instance type will be used instead). * @type {number} * @memberof DatabaseRequest */ 'cpu'?: number; /** * Database instance type to be used for this database. The list of values can be retrieved via the endpoint /{CloudProvider}/managedDatabase/instanceType/{region}/{dbType}. This field SHOULD NOT be set for container DB. * @type {string} * @memberof DatabaseRequest */ 'instance_type'?: string; /** * unit is MB. 1024 MB = 1GB This field will be ignored for managed DB (instance type will be used instead). Default value is linked to the database type: - MANAGED: `100` - CONTAINER - POSTGRES: `100` - REDIS: `100` - MYSQL: `512` - MONGODB: `256` * @type {number} * @memberof DatabaseRequest */ 'memory'?: number; /** * unit is GB * @type {number} * @memberof DatabaseRequest */ 'storage'?: number; /** * * @type {Array} * @memberof DatabaseRequest */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof DatabaseRequest */ 'labels_groups'?: Array; /** * Icon URI representing the database. * @type {string} * @memberof DatabaseRequest */ 'icon_uri'?: string; } /** * * @export * @interface DatabaseResponseList */ export interface DatabaseResponseList { /** * * @type {Array} * @memberof DatabaseResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const DatabaseTypeEnum: { readonly MONGODB: "MONGODB"; readonly MYSQL: "MYSQL"; readonly POSTGRESQL: "POSTGRESQL"; readonly REDIS: "REDIS"; }; export type DatabaseTypeEnum = typeof DatabaseTypeEnum[keyof typeof DatabaseTypeEnum]; /** * * @export * @interface DatabaseVersionMode */ export interface DatabaseVersionMode { /** * * @type {string} * @memberof DatabaseVersionMode */ 'name'?: string; /** * * @type {DatabaseModeEnum} * @memberof DatabaseVersionMode */ 'supported_mode'?: DatabaseModeEnum; } /** * * @export * @interface DeleteMemberRequest */ export interface DeleteMemberRequest { /** * * @type {string} * @memberof DeleteMemberRequest */ 'user_id': string; } /** * Action to force a specific Terraform behavior during deletion/uninstall. * @export * @enum {string} */ export declare const DeleteTerraformAction: { readonly SKIP_DESTROY: "SKIP_DESTROY"; }; export type DeleteTerraformAction = typeof DeleteTerraformAction[keyof typeof DeleteTerraformAction]; /** * * @export * @interface DeployAllRequest */ export interface DeployAllRequest { /** * * @type {Array} * @memberof DeployAllRequest */ 'applications'?: Array; /** * * @type {Array} * @memberof DeployAllRequest */ 'databases'?: Array; /** * * @type {Array} * @memberof DeployAllRequest */ 'containers'?: Array; /** * * @type {Array} * @memberof DeployAllRequest */ 'jobs'?: Array; /** * * @type {Array} * @memberof DeployAllRequest */ 'helms'?: Array; /** * * @type {Array} * @memberof DeployAllRequest */ 'terraforms'?: Array; } /** * * @export * @interface DeployAllRequestApplicationsInner */ export interface DeployAllRequestApplicationsInner { /** * id of the application to be deployed. * @type {string} * @memberof DeployAllRequestApplicationsInner */ 'application_id': string; /** * Commit ID to deploy. Can be empty only if the service has been already deployed (in this case the service version won\'t be changed) * @type {string} * @memberof DeployAllRequestApplicationsInner */ 'git_commit_id'?: string; } /** * * @export * @interface DeployAllRequestContainersInner */ export interface DeployAllRequestContainersInner { /** * id of the container to be updated. * @type {string} * @memberof DeployAllRequestContainersInner */ 'id': string; /** * new tag for the container. Can be empty only if the service has been already deployed (in this case the service version won\'t be changed) * @type {string} * @memberof DeployAllRequestContainersInner */ 'image_tag'?: string; } /** * * @export * @interface DeployAllRequestHelmsInner */ export interface DeployAllRequestHelmsInner { /** * id of the helm to be updated. * @type {string} * @memberof DeployAllRequestHelmsInner */ 'id'?: string; /** * The new chart version for the Helm source. Use this only if the helm has a Helm repository source. * @type {string} * @memberof DeployAllRequestHelmsInner */ 'chart_version'?: string; /** * The commit Id to deploy. Use this only if the helm has a Git repository source. * @type {string} * @memberof DeployAllRequestHelmsInner */ 'git_commit_id'?: string; /** * The commit Id of the override values to deploy. Use only if the helm has a Git override values repository. * @type {string} * @memberof DeployAllRequestHelmsInner */ 'values_override_git_commit_id'?: string; } /** * * @export * @interface DeployAllRequestJobsInner */ export interface DeployAllRequestJobsInner { /** * id of the job to be updated. * @type {string} * @memberof DeployAllRequestJobsInner */ 'id'?: string; /** * new tag for the job image. Use only if job is an image source. Can be empty only if the service has been already deployed (in this case the service version won\'t be changed) * @type {string} * @memberof DeployAllRequestJobsInner */ 'image_tag'?: string; /** * Commit ID to deploy. Use only if job is a repository source. Can be empty only if the service has been already deployed (in this case the service version won\'t be changed) * @type {string} * @memberof DeployAllRequestJobsInner */ 'git_commit_id'?: string; } /** * * @export * @interface DeployRequest */ export interface DeployRequest { /** * Commit ID to deploy * @type {string} * @memberof DeployRequest */ 'git_commit_id': string; } /** * * @export * @interface DeploymentBuildUsageReportRequest */ export interface DeploymentBuildUsageReportRequest { /** * The deployment execution ID (format environment_id-version) * @type {string} * @memberof DeploymentBuildUsageReportRequest */ 'execution_id': string; /** * The number of seconds the report will be publicly available * @type {number} * @memberof DeploymentBuildUsageReportRequest */ 'report_expiration_in_seconds': number; } /** * * @export * @interface DeploymentBuildUsageReportResponse */ export interface DeploymentBuildUsageReportResponse { /** * The publicly accessible URL of the Grafana snapshot report showing build pod resource usage * @type {string} * @memberof DeploymentBuildUsageReportResponse */ 'report_url'?: string; /** * The URL to pro-actively delete the report before it expires * @type {string} * @memberof DeploymentBuildUsageReportResponse */ 'delete_report_url'?: string; } /** * * @export * @interface DeploymentHistory */ export interface DeploymentHistory { /** * * @type {string} * @memberof DeploymentHistory */ 'id': string; /** * * @type {string} * @memberof DeploymentHistory */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistory */ 'updated_at'?: string; /** * name of the service * @type {string} * @memberof DeploymentHistory */ 'name'?: string; /** * * @type {Commit} * @memberof DeploymentHistory */ 'commit'?: Commit | null; /** * * @type {DeploymentHistoryStatusEnum} * @memberof DeploymentHistory */ 'status'?: DeploymentHistoryStatusEnum; } /** * * @export * @enum {string} */ export declare const DeploymentHistoryActionStatus: { readonly QUEUED: "QUEUED"; readonly ONGOING: "ONGOING"; readonly SUCCESS: "SUCCESS"; readonly ERROR: "ERROR"; readonly CANCELED: "CANCELED"; readonly CANCELING: "CANCELING"; readonly NEVER: "NEVER"; }; export type DeploymentHistoryActionStatus = typeof DeploymentHistoryActionStatus[keyof typeof DeploymentHistoryActionStatus]; /** * * @export * @interface DeploymentHistoryApplication */ export interface DeploymentHistoryApplication { /** * * @type {string} * @memberof DeploymentHistoryApplication */ 'id': string; /** * * @type {string} * @memberof DeploymentHistoryApplication */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistoryApplication */ 'updated_at'?: string; /** * * @type {string} * @memberof DeploymentHistoryApplication */ 'name'?: string; /** * * @type {Commit} * @memberof DeploymentHistoryApplication */ 'commit'?: Commit | null; /** * * @type {StateEnum} * @memberof DeploymentHistoryApplication */ 'status'?: StateEnum; } /** * * @export * @interface DeploymentHistoryAuditingData */ export interface DeploymentHistoryAuditingData { /** * * @type {string} * @memberof DeploymentHistoryAuditingData */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistoryAuditingData */ 'updated_at': string; /** * * @type {string} * @memberof DeploymentHistoryAuditingData */ 'triggered_by': string; /** * * @type {OrganizationEventOrigin} * @memberof DeploymentHistoryAuditingData */ 'origin'?: OrganizationEventOrigin; } /** * * @export * @interface DeploymentHistoryContainer */ export interface DeploymentHistoryContainer { /** * * @type {string} * @memberof DeploymentHistoryContainer */ 'id': string; /** * * @type {string} * @memberof DeploymentHistoryContainer */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistoryContainer */ 'updated_at'?: string; /** * name of the container * @type {string} * @memberof DeploymentHistoryContainer */ 'name'?: string; /** * * @type {StateEnum} * @memberof DeploymentHistoryContainer */ 'status'?: StateEnum; /** * * @type {string} * @memberof DeploymentHistoryContainer */ 'image_name'?: string; /** * * @type {string} * @memberof DeploymentHistoryContainer */ 'tag'?: string; /** * * @type {Array} * @memberof DeploymentHistoryContainer */ 'arguments'?: Array; /** * * @type {string} * @memberof DeploymentHistoryContainer */ 'entrypoint'?: string; } /** * * @export * @interface DeploymentHistoryDatabase */ export interface DeploymentHistoryDatabase { /** * * @type {string} * @memberof DeploymentHistoryDatabase */ 'id': string; /** * * @type {string} * @memberof DeploymentHistoryDatabase */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistoryDatabase */ 'updated_at'?: string; /** * name of the service * @type {string} * @memberof DeploymentHistoryDatabase */ 'name'?: string; /** * * @type {StateEnum} * @memberof DeploymentHistoryDatabase */ 'status'?: StateEnum; } /** * * @export * @interface DeploymentHistoryEnvironment */ export interface DeploymentHistoryEnvironment { /** * * @type {string} * @memberof DeploymentHistoryEnvironment */ 'id': string; /** * * @type {string} * @memberof DeploymentHistoryEnvironment */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistoryEnvironment */ 'updated_at'?: string; /** * * @type {StateEnum} * @memberof DeploymentHistoryEnvironment */ 'status'?: StateEnum; /** * * @type {OrganizationEventOrigin} * @memberof DeploymentHistoryEnvironment */ 'origin'?: OrganizationEventOrigin; /** * * @type {string} * @memberof DeploymentHistoryEnvironment */ 'triggered_by'?: string; /** * * @type {Array} * @memberof DeploymentHistoryEnvironment */ 'applications'?: Array; /** * * @type {Array} * @memberof DeploymentHistoryEnvironment */ 'containers'?: Array; /** * * @type {Array} * @memberof DeploymentHistoryEnvironment */ 'databases'?: Array; /** * * @type {Array} * @memberof DeploymentHistoryEnvironment */ 'jobs'?: Array; /** * * @type {Array} * @memberof DeploymentHistoryEnvironment */ 'helms'?: Array; } /** * * @export * @interface DeploymentHistoryEnvironmentPaginatedResponseList */ export interface DeploymentHistoryEnvironmentPaginatedResponseList { /** * * @type {number} * @memberof DeploymentHistoryEnvironmentPaginatedResponseList */ 'page': number; /** * * @type {number} * @memberof DeploymentHistoryEnvironmentPaginatedResponseList */ 'page_size': number; /** * * @type {Array} * @memberof DeploymentHistoryEnvironmentPaginatedResponseList */ 'results'?: Array; } /** * * @export * @interface DeploymentHistoryEnvironmentPaginatedResponseListV2 */ export interface DeploymentHistoryEnvironmentPaginatedResponseListV2 { /** * * @type {number} * @memberof DeploymentHistoryEnvironmentPaginatedResponseListV2 */ 'page': number; /** * * @type {number} * @memberof DeploymentHistoryEnvironmentPaginatedResponseListV2 */ 'page_size': number; /** * * @type {Array} * @memberof DeploymentHistoryEnvironmentPaginatedResponseListV2 */ 'results'?: Array; } /** * * @export * @interface DeploymentHistoryEnvironmentV2 */ export interface DeploymentHistoryEnvironmentV2 { /** * * @type {DeploymentHistoryEnvironmentV2Identifier} * @memberof DeploymentHistoryEnvironmentV2 */ 'identifier': DeploymentHistoryEnvironmentV2Identifier; /** * * @type {DeploymentHistoryAuditingData} * @memberof DeploymentHistoryEnvironmentV2 */ 'auditing_data': DeploymentHistoryAuditingData; /** * * @type {StateEnum} * @memberof DeploymentHistoryEnvironmentV2 */ 'status': StateEnum; /** * * @type {DeploymentHistoryTriggerAction} * @memberof DeploymentHistoryEnvironmentV2 */ 'trigger_action': DeploymentHistoryTriggerAction; /** * * @type {string} * @memberof DeploymentHistoryEnvironmentV2 */ 'total_duration': string; /** * * @type {Array} * @memberof DeploymentHistoryEnvironmentV2 */ 'stages': Array; /** * * @type {DeploymentHistoryActionStatus} * @memberof DeploymentHistoryEnvironmentV2 */ 'action_status': DeploymentHistoryActionStatus; } /** * * @export * @interface DeploymentHistoryEnvironmentV2Identifier */ export interface DeploymentHistoryEnvironmentV2Identifier { /** * * @type {string} * @memberof DeploymentHistoryEnvironmentV2Identifier */ 'execution_id': string; /** * * @type {string} * @memberof DeploymentHistoryEnvironmentV2Identifier */ 'environment_id': string; } /** * * @export * @interface DeploymentHistoryHelmResponse */ export interface DeploymentHistoryHelmResponse { /** * * @type {string} * @memberof DeploymentHistoryHelmResponse */ 'id': string; /** * * @type {string} * @memberof DeploymentHistoryHelmResponse */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistoryHelmResponse */ 'updated_at'?: string; /** * name of the helm * @type {string} * @memberof DeploymentHistoryHelmResponse */ 'name'?: string; /** * * @type {StateEnum} * @memberof DeploymentHistoryHelmResponse */ 'status'?: StateEnum; /** * * @type {Commit} * @memberof DeploymentHistoryHelmResponse */ 'commit'?: Commit | null; /** * * @type {DeploymentHistoryHelmResponseAllOfRepository} * @memberof DeploymentHistoryHelmResponse */ 'repository'?: DeploymentHistoryHelmResponseAllOfRepository | null; } /** * If the chart source if from a repository, the chart name and its version * @export * @interface DeploymentHistoryHelmResponseAllOfRepository */ export interface DeploymentHistoryHelmResponseAllOfRepository { /** * * @type {string} * @memberof DeploymentHistoryHelmResponseAllOfRepository */ 'chart_name'?: string; /** * * @type {string} * @memberof DeploymentHistoryHelmResponseAllOfRepository */ 'chart_version'?: string; } /** * * @export * @interface DeploymentHistoryJobResponse */ export interface DeploymentHistoryJobResponse { /** * * @type {string} * @memberof DeploymentHistoryJobResponse */ 'id': string; /** * * @type {string} * @memberof DeploymentHistoryJobResponse */ 'created_at': string; /** * * @type {string} * @memberof DeploymentHistoryJobResponse */ 'updated_at'?: string; /** * name of the job * @type {string} * @memberof DeploymentHistoryJobResponse */ 'name'?: string; /** * * @type {StateEnum} * @memberof DeploymentHistoryJobResponse */ 'status'?: StateEnum; /** * * @type {string} * @memberof DeploymentHistoryJobResponse */ 'image_name'?: string; /** * * @type {string} * @memberof DeploymentHistoryJobResponse */ 'tag'?: string; /** * * @type {Commit} * @memberof DeploymentHistoryJobResponse */ 'commit'?: Commit | null; /** * * @type {DeploymentHistoryJobResponseAllOfSchedule} * @memberof DeploymentHistoryJobResponse */ 'schedule'?: DeploymentHistoryJobResponseAllOfSchedule; /** * * @type {Array} * @memberof DeploymentHistoryJobResponse */ 'arguments'?: Array; /** * * @type {string} * @memberof DeploymentHistoryJobResponse */ 'entrypoint'?: string; } /** * * @export * @interface DeploymentHistoryJobResponseAllOfSchedule */ export interface DeploymentHistoryJobResponseAllOfSchedule { /** * * @type {JobScheduleEvent} * @memberof DeploymentHistoryJobResponseAllOfSchedule */ 'event'?: JobScheduleEvent; /** * Can only be set if the event is CRON. Represent the cron format for the job schedule without seconds. For example: `* * * * *` represent the cron to launch the job every minute. See https://crontab.guru/ to WISIWIG interface. Timezone is UTC * @type {string} * @memberof DeploymentHistoryJobResponseAllOfSchedule */ 'schedule_at'?: string | null; } /** * * @export * @interface DeploymentHistoryPaginatedResponseList */ export interface DeploymentHistoryPaginatedResponseList { /** * * @type {number} * @memberof DeploymentHistoryPaginatedResponseList */ 'page': number; /** * * @type {number} * @memberof DeploymentHistoryPaginatedResponseList */ 'page_size': number; /** * * @type {Array} * @memberof DeploymentHistoryPaginatedResponseList */ 'results'?: Array; } /** * * @export * @interface DeploymentHistoryService */ export interface DeploymentHistoryService { /** * * @type {DeploymentHistoryServiceIdentifier} * @memberof DeploymentHistoryService */ 'identifier': DeploymentHistoryServiceIdentifier; /** * * @type {StateEnum} * @memberof DeploymentHistoryService */ 'status': StateEnum; /** * * @type {DeploymentHistoryAuditingData} * @memberof DeploymentHistoryService */ 'auditing_data': DeploymentHistoryAuditingData; /** * * @type {DeploymentHistoryServiceDetails} * @memberof DeploymentHistoryService */ 'details': DeploymentHistoryServiceDetails; /** * * @type {StatusDetails} * @memberof DeploymentHistoryService */ 'status_details': StatusDetails; /** * * @type {string} * @memberof DeploymentHistoryService */ 'icon_uri': string; /** * * @type {string} * @memberof DeploymentHistoryService */ 'total_duration'?: string; } /** * @type DeploymentHistoryServiceDetails * @export */ export type DeploymentHistoryServiceDetails = DeploymentHistoryServiceDetailsOneOf | DeploymentHistoryServiceDetailsOneOf1 | DeploymentHistoryServiceDetailsOneOf2 | DeploymentHistoryServiceDetailsOneOf3; /** * ApplicationDeploymentHistoryData * @export * @interface DeploymentHistoryServiceDetailsOneOf */ export interface DeploymentHistoryServiceDetailsOneOf { /** * * @type {Commit} * @memberof DeploymentHistoryServiceDetailsOneOf */ 'commit': Commit | null; /** * The build pod name prefix for monitoring build runner usage. Format build-{execution_id}-0 * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf */ 'build_pod_name': string; } /** * ContainerDeploymentHistoryData * @export * @interface DeploymentHistoryServiceDetailsOneOf1 */ export interface DeploymentHistoryServiceDetailsOneOf1 { /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf1 */ 'image_name': string; /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf1 */ 'tag': string; /** * * @type {Array} * @memberof DeploymentHistoryServiceDetailsOneOf1 */ 'arguments': Array; /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf1 */ 'entrypoint'?: string; } /** * JobDeploymentHistoryDetails * @export * @interface DeploymentHistoryServiceDetailsOneOf2 */ export interface DeploymentHistoryServiceDetailsOneOf2 { /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf2 */ 'image_name': string; /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf2 */ 'tag': string; /** * * @type {Commit} * @memberof DeploymentHistoryServiceDetailsOneOf2 */ 'commit'?: Commit | null; /** * * @type {DeploymentHistoryServiceDetailsOneOf2Schedule} * @memberof DeploymentHistoryServiceDetailsOneOf2 */ 'schedule'?: DeploymentHistoryServiceDetailsOneOf2Schedule; /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf2 */ 'job_type': DeploymentHistoryServiceDetailsOneOf2JobTypeEnum; /** * The build pod name prefix. Only set for jobs with a git source (Docker build). Null for container-source jobs. * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf2 */ 'build_pod_name'?: string | null; } export declare const DeploymentHistoryServiceDetailsOneOf2JobTypeEnum: { readonly CRON: "CRON"; readonly LIFECYCLE: "LIFECYCLE"; }; export type DeploymentHistoryServiceDetailsOneOf2JobTypeEnum = typeof DeploymentHistoryServiceDetailsOneOf2JobTypeEnum[keyof typeof DeploymentHistoryServiceDetailsOneOf2JobTypeEnum]; /** * * @export * @interface DeploymentHistoryServiceDetailsOneOf2Schedule */ export interface DeploymentHistoryServiceDetailsOneOf2Schedule { /** * * @type {JobLifecyleSchedule} * @memberof DeploymentHistoryServiceDetailsOneOf2Schedule */ 'on_start'?: JobLifecyleSchedule; /** * * @type {JobLifecyleSchedule} * @memberof DeploymentHistoryServiceDetailsOneOf2Schedule */ 'on_stop'?: JobLifecyleSchedule; /** * * @type {JobLifecyleSchedule} * @memberof DeploymentHistoryServiceDetailsOneOf2Schedule */ 'on_delete'?: JobLifecyleSchedule; /** * * @type {JobCronSchedule} * @memberof DeploymentHistoryServiceDetailsOneOf2Schedule */ 'cron_job'?: JobCronSchedule; /** * * @type {JobLifecycleTypeEnum} * @memberof DeploymentHistoryServiceDetailsOneOf2Schedule */ 'lifecycle_type'?: JobLifecycleTypeEnum; } /** * HelmDeploymentHistoryDetails * @export * @interface DeploymentHistoryServiceDetailsOneOf3 */ export interface DeploymentHistoryServiceDetailsOneOf3 { /** * * @type {Commit} * @memberof DeploymentHistoryServiceDetailsOneOf3 */ 'commit'?: Commit | null; /** * * @type {DeploymentHistoryServiceDetailsOneOf3Repository} * @memberof DeploymentHistoryServiceDetailsOneOf3 */ 'repository'?: DeploymentHistoryServiceDetailsOneOf3Repository; } /** * * @export * @interface DeploymentHistoryServiceDetailsOneOf3Repository */ export interface DeploymentHistoryServiceDetailsOneOf3Repository { /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf3Repository */ 'chart_name'?: string; /** * * @type {string} * @memberof DeploymentHistoryServiceDetailsOneOf3Repository */ 'chart_version'?: string; } /** * * @export * @interface DeploymentHistoryServiceIdentifier */ export interface DeploymentHistoryServiceIdentifier { /** * * @type {string} * @memberof DeploymentHistoryServiceIdentifier */ 'name': string; /** * * @type {string} * @memberof DeploymentHistoryServiceIdentifier */ 'service_id': string; /** * * @type {ServiceTypeEnum} * @memberof DeploymentHistoryServiceIdentifier */ 'service_type': ServiceTypeEnum; /** * * @type {string} * @memberof DeploymentHistoryServiceIdentifier */ 'execution_id'?: string; } /** * * @export * @interface DeploymentHistoryServicePaginatedResponseListV2 */ export interface DeploymentHistoryServicePaginatedResponseListV2 { /** * * @type {number} * @memberof DeploymentHistoryServicePaginatedResponseListV2 */ 'page': number; /** * * @type {number} * @memberof DeploymentHistoryServicePaginatedResponseListV2 */ 'page_size': number; /** * * @type {Array} * @memberof DeploymentHistoryServicePaginatedResponseListV2 */ 'results'?: Array; } /** * * @export * @interface DeploymentHistoryStage */ export interface DeploymentHistoryStage { /** * * @type {string} * @memberof DeploymentHistoryStage */ 'name': string; /** * * @type {StageStatusEnum} * @memberof DeploymentHistoryStage */ 'status': StageStatusEnum; /** * * @type {string} * @memberof DeploymentHistoryStage */ 'duration': string; /** * * @type {Array} * @memberof DeploymentHistoryStage */ 'services': Array; } /** * * @export * @enum {string} */ export declare const DeploymentHistoryStatusEnum: { readonly FAILED: "FAILED"; readonly SUCCESS: "SUCCESS"; }; export type DeploymentHistoryStatusEnum = typeof DeploymentHistoryStatusEnum[keyof typeof DeploymentHistoryStatusEnum]; /** * * @export * @enum {string} */ export declare const DeploymentHistoryTriggerAction: { readonly DEPLOY: "DEPLOY"; readonly DELETE: "DELETE"; readonly RESTART: "RESTART"; readonly STOP: "STOP"; readonly DEPLOY_DRY_RUN: "DEPLOY_DRY_RUN"; readonly TERRAFORM_FORCE_UNLOCK: "TERRAFORM_FORCE_UNLOCK"; readonly TERRAFORM_MIGRATE_STATE: "TERRAFORM_MIGRATE_STATE"; readonly DELETE_RESOURCES_ONLY: "DELETE_RESOURCES_ONLY"; readonly UNKNOWN: "UNKNOWN"; readonly UNINSTALL: "UNINSTALL"; }; export type DeploymentHistoryTriggerAction = typeof DeploymentHistoryTriggerAction[keyof typeof DeploymentHistoryTriggerAction]; /** * * @export * @enum {string} */ export declare const DeploymentInfraReason: { readonly UNSPECIFIED: "UNSPECIFIED"; readonly MAINTENANCE: "MAINTENANCE"; }; export type DeploymentInfraReason = typeof DeploymentInfraReason[keyof typeof DeploymentInfraReason]; /** * Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated. * @export * @enum {string} */ export declare const DeploymentRestrictionModeEnum: { readonly EXCLUDE: "EXCLUDE"; readonly MATCH: "MATCH"; }; export type DeploymentRestrictionModeEnum = typeof DeploymentRestrictionModeEnum[keyof typeof DeploymentRestrictionModeEnum]; /** * * @export * @enum {string} */ export declare const DeploymentRestrictionTypeEnum: { readonly PATH: "PATH"; }; export type DeploymentRestrictionTypeEnum = typeof DeploymentRestrictionTypeEnum[keyof typeof DeploymentRestrictionTypeEnum]; /** * * @export * @interface DeploymentStageRequest */ export interface DeploymentStageRequest { /** * The name of the deployment stage * @type {string} * @memberof DeploymentStageRequest */ 'name': string; /** * free test describing this stage * @type {string} * @memberof DeploymentStageRequest */ 'description'?: string | null; } /** * * @export * @interface DeploymentStageResponse */ export interface DeploymentStageResponse { /** * * @type {string} * @memberof DeploymentStageResponse */ 'id': string; /** * * @type {string} * @memberof DeploymentStageResponse */ 'created_at': string; /** * * @type {string} * @memberof DeploymentStageResponse */ 'updated_at'?: string; /** * * @type {ReferenceObject} * @memberof DeploymentStageResponse */ 'environment': ReferenceObject; /** * name is case insensitive * @type {string} * @memberof DeploymentStageResponse */ 'name'?: string; /** * * @type {string} * @memberof DeploymentStageResponse */ 'description'?: string; /** * Position of the deployment stage within the environment * @type {number} * @memberof DeploymentStageResponse */ 'deployment_order'?: number; /** * * @type {Array} * @memberof DeploymentStageResponse */ 'services'?: Array; } /** * * @export * @interface DeploymentStageResponseList */ export interface DeploymentStageResponseList { /** * * @type {Array} * @memberof DeploymentStageResponseList */ 'results'?: Array; } /** * * @export * @interface DeploymentStageServiceResponse */ export interface DeploymentStageServiceResponse { /** * * @type {string} * @memberof DeploymentStageServiceResponse */ 'id': string; /** * * @type {string} * @memberof DeploymentStageServiceResponse */ 'created_at': string; /** * * @type {string} * @memberof DeploymentStageServiceResponse */ 'updated_at'?: string; /** * id of the service attached to the stage * @type {string} * @memberof DeploymentStageServiceResponse */ 'service_id'?: string; /** * type of the service (i.e APPLICATION, JOB, DATABASE, ...) * @type {string} * @memberof DeploymentStageServiceResponse */ 'service_type'?: string; /** * whether the service is excluded from environment-level deployments * @type {boolean} * @memberof DeploymentStageServiceResponse */ 'is_skipped'?: boolean; } /** * * @export * @interface DeploymentStageWithServicesStatuses */ export interface DeploymentStageWithServicesStatuses { /** * * @type {Array} * @memberof DeploymentStageWithServicesStatuses */ 'applications'?: Array; /** * * @type {Array} * @memberof DeploymentStageWithServicesStatuses */ 'containers'?: Array; /** * * @type {Array} * @memberof DeploymentStageWithServicesStatuses */ 'jobs'?: Array; /** * * @type {Array} * @memberof DeploymentStageWithServicesStatuses */ 'databases'?: Array; /** * * @type {Array} * @memberof DeploymentStageWithServicesStatuses */ 'helms'?: Array; /** * * @type {Array} * @memberof DeploymentStageWithServicesStatuses */ 'terraforms'?: Array; /** * * @type {Stage} * @memberof DeploymentStageWithServicesStatuses */ 'stage'?: Stage; } /** * * @export * @interface DockerfileCheckRequest */ export interface DockerfileCheckRequest { /** * * @type {ApplicationGitRepositoryRequest} * @memberof DockerfileCheckRequest */ 'git_repository': ApplicationGitRepositoryRequest; /** * path of the dockerfile with root_path as base path * @type {string} * @memberof DockerfileCheckRequest */ 'dockerfile_path': string; } /** * * @export * @interface DockerfileCheckResponse */ export interface DockerfileCheckResponse { /** * * @type {string} * @memberof DockerfileCheckResponse */ 'dockerfile_path': string; /** * All ARG variable declared in the Dockerfile * @type {Array} * @memberof DockerfileCheckResponse */ 'arg'?: Array; /** * All image repositories we found declared in the Dockerfile * @type {Array} * @memberof DockerfileCheckResponse */ 'repositories'?: Array; } /** * Reference a Dockerfile fragment file from your Git repository. * @export * @interface DockerfileFragmentFile */ export interface DockerfileFragmentFile { /** * Fragment type discriminator * @type {string} * @memberof DockerfileFragmentFile */ 'type': DockerfileFragmentFileTypeEnum; /** * Absolute path to the fragment file. * @type {string} * @memberof DockerfileFragmentFile */ 'path': string; } export declare const DockerfileFragmentFileTypeEnum: { readonly FILE: "file"; }; export type DockerfileFragmentFileTypeEnum = typeof DockerfileFragmentFileTypeEnum[keyof typeof DockerfileFragmentFileTypeEnum]; /** * Define Dockerfile commands directly in the configuration. * @export * @interface DockerfileFragmentInline */ export interface DockerfileFragmentInline { /** * Fragment type discriminator * @type {string} * @memberof DockerfileFragmentInline */ 'type': DockerfileFragmentInlineTypeEnum; /** * Dockerfile commands to inject (max 8KB). * @type {string} * @memberof DockerfileFragmentInline */ 'content': string; } export declare const DockerfileFragmentInlineTypeEnum: { readonly INLINE: "inline"; }; export type DockerfileFragmentInlineTypeEnum = typeof DockerfileFragmentInlineTypeEnum[keyof typeof DockerfileFragmentInlineTypeEnum]; /** * * @export * @interface EksAnywhereClusterJwtResponse */ export interface EksAnywhereClusterJwtResponse { /** * * @type {string} * @memberof EksAnywhereClusterJwtResponse */ 'jwt': string; } /** * * @export * @interface EksAnywhereCommitRequest */ export interface EksAnywhereCommitRequest { /** * * @type {string} * @memberof EksAnywhereCommitRequest */ 'commit_id': string; } /** * * @export * @interface EksAnywhereCommitResponse */ export interface EksAnywhereCommitResponse { /** * * @type {string} * @memberof EksAnywhereCommitResponse */ 'commit_id': string; } /** * * @export * @interface EksAnywhereVsphereClusterCredentials */ export interface EksAnywhereVsphereClusterCredentials { /** * * @type {string} * @memberof EksAnywhereVsphereClusterCredentials */ 'id': string; /** * * @type {string} * @memberof EksAnywhereVsphereClusterCredentials */ 'name': string; /** * * @type {string} * @memberof EksAnywhereVsphereClusterCredentials */ 'vsphere_user': string; /** * * @type {string} * @memberof EksAnywhereVsphereClusterCredentials */ 'access_key_id'?: string | null; /** * * @type {string} * @memberof EksAnywhereVsphereClusterCredentials */ 'role_arn'?: string | null; /** * * @type {string} * @memberof EksAnywhereVsphereClusterCredentials */ 'object_type': EksAnywhereVsphereClusterCredentialsObjectTypeEnum; } export declare const EksAnywhereVsphereClusterCredentialsObjectTypeEnum: { readonly EKS_ANYWHERE_VSPHERE: "EKS_ANYWHERE_VSPHERE"; }; export type EksAnywhereVsphereClusterCredentialsObjectTypeEnum = typeof EksAnywhereVsphereClusterCredentialsObjectTypeEnum[keyof typeof EksAnywhereVsphereClusterCredentialsObjectTypeEnum]; /** * * @export * @interface EksAnywhereVsphereRoleCredentialsRequest */ export interface EksAnywhereVsphereRoleCredentialsRequest { /** * * @type {string} * @memberof EksAnywhereVsphereRoleCredentialsRequest */ 'type': EksAnywhereVsphereRoleCredentialsRequestTypeEnum; /** * * @type {string} * @memberof EksAnywhereVsphereRoleCredentialsRequest */ 'name': string; /** * * @type {string} * @memberof EksAnywhereVsphereRoleCredentialsRequest */ 'vsphere_user': string; /** * * @type {string} * @memberof EksAnywhereVsphereRoleCredentialsRequest */ 'vsphere_password': string; /** * * @type {string} * @memberof EksAnywhereVsphereRoleCredentialsRequest */ 'role_arn': string; } export declare const EksAnywhereVsphereRoleCredentialsRequestTypeEnum: { readonly EKS_ANYWHERE_VSPHERE_ROLE: "EKS_ANYWHERE_VSPHERE_ROLE"; }; export type EksAnywhereVsphereRoleCredentialsRequestTypeEnum = typeof EksAnywhereVsphereRoleCredentialsRequestTypeEnum[keyof typeof EksAnywhereVsphereRoleCredentialsRequestTypeEnum]; /** * * @export * @interface EksAnywhereVsphereStaticCredentialsRequest */ export interface EksAnywhereVsphereStaticCredentialsRequest { /** * * @type {string} * @memberof EksAnywhereVsphereStaticCredentialsRequest */ 'type': EksAnywhereVsphereStaticCredentialsRequestTypeEnum; /** * * @type {string} * @memberof EksAnywhereVsphereStaticCredentialsRequest */ 'name': string; /** * * @type {string} * @memberof EksAnywhereVsphereStaticCredentialsRequest */ 'vsphere_user': string; /** * * @type {string} * @memberof EksAnywhereVsphereStaticCredentialsRequest */ 'vsphere_password': string; /** * * @type {string} * @memberof EksAnywhereVsphereStaticCredentialsRequest */ 'access_key_id': string; /** * * @type {string} * @memberof EksAnywhereVsphereStaticCredentialsRequest */ 'secret_access_key': string; } export declare const EksAnywhereVsphereStaticCredentialsRequestTypeEnum: { readonly EKS_ANYWHERE_VSPHERE_STATIC: "EKS_ANYWHERE_VSPHERE_STATIC"; }; export type EksAnywhereVsphereStaticCredentialsRequestTypeEnum = typeof EksAnywhereVsphereStaticCredentialsRequestTypeEnum[keyof typeof EksAnywhereVsphereStaticCredentialsRequestTypeEnum]; /** * * @export * @interface EksInfrastructureOutputs */ export interface EksInfrastructureOutputs { /** * * @type {string} * @memberof EksInfrastructureOutputs */ 'kind': EksInfrastructureOutputsKindEnum; /** * * @type {string} * @memberof EksInfrastructureOutputs */ 'cluster_name': string; /** * * @type {string} * @memberof EksInfrastructureOutputs */ 'cluster_arn': string; /** * * @type {string} * @memberof EksInfrastructureOutputs */ 'cluster_oidc_issuer': string; /** * * @type {string} * @memberof EksInfrastructureOutputs */ 'vpc_id': string; } export declare const EksInfrastructureOutputsKindEnum: { readonly EKS: "EKS"; }; export type EksInfrastructureOutputsKindEnum = typeof EksInfrastructureOutputsKindEnum[keyof typeof EksInfrastructureOutputsKindEnum]; /** * * @export * @interface EmailAlertReceiverCreationRequest */ export interface EmailAlertReceiverCreationRequest { /** * * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'organization_id': string; /** * * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'name': string; /** * * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'description': string; /** * * @type {AlertReceiverType} * @memberof EmailAlertReceiverCreationRequest */ 'type': AlertReceiverType; /** * * @type {boolean} * @memberof EmailAlertReceiverCreationRequest */ 'send_resolved': boolean; /** * * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'owner'?: string | null; /** * * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'severity'?: string | null; /** * Recipient email address * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'to': string; /** * Sender email address * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'from': string; /** * SMTP server in format \'host:port\' * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'smarthost': string; /** * SMTP authentication username. Defaults to \'from\' if not provided. * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'auth_username'?: string | null; /** * SMTP authentication password * @type {string} * @memberof EmailAlertReceiverCreationRequest */ 'auth_password': string; /** * Whether to require TLS for SMTP connection * @type {boolean} * @memberof EmailAlertReceiverCreationRequest */ 'require_tls': boolean; } /** * * @export * @interface EmailAlertReceiverEditRequest */ export interface EmailAlertReceiverEditRequest { /** * * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'name': string; /** * * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'description': string; /** * * @type {AlertReceiverType} * @memberof EmailAlertReceiverEditRequest */ 'type': AlertReceiverType; /** * * @type {boolean} * @memberof EmailAlertReceiverEditRequest */ 'send_resolved': boolean; /** * * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'owner'?: string | null; /** * * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'severity'?: string | null; /** * * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'to': string; /** * * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'from': string; /** * SMTP server in format \'host:port\' * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'smarthost': string; /** * * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'auth_username'?: string | null; /** * SMTP password. If null, keeps existing password. * @type {string} * @memberof EmailAlertReceiverEditRequest */ 'auth_password'?: string | null; /** * * @type {boolean} * @memberof EmailAlertReceiverEditRequest */ 'require_tls': boolean; } /** * * @export * @interface EmailAlertReceiverResponse */ export interface EmailAlertReceiverResponse { /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'id': string; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'created_at': string; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'name': string; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'description': string; /** * * @type {AlertReceiverType} * @memberof EmailAlertReceiverResponse */ 'type': AlertReceiverType; /** * * @type {boolean} * @memberof EmailAlertReceiverResponse */ 'send_resolved': boolean; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'to': string; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'from': string; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'smarthost': string; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'auth_username': string | null; /** * * @type {boolean} * @memberof EmailAlertReceiverResponse */ 'require_tls': boolean; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'owner'?: string | null; /** * * @type {string} * @memberof EmailAlertReceiverResponse */ 'severity'?: string | null; } /** * * @export * @interface EnterpriseConnectionDto */ export interface EnterpriseConnectionDto { /** * The connection name * @type {string} * @memberof EnterpriseConnectionDto */ 'connection_name': string; /** * The purpose of this default role is to be associated to your users if: - you choose to not expose your IDPs groups to the SAML / OIDC connection - no associated group is found in your `group_mappings` defined You can define either a Qovery provided role (i.e `viewer`) or one of your custom role`s uuid. * @type {string} * @memberof EnterpriseConnectionDto */ 'default_role': string; /** * * if `true`, roles will be synchronized at each user login according to your `group_mappings` configuration based on your IDP groups * if `false`, no synchronization is done for your users and `group_mappings` configuration will be ignored * @type {boolean} * @memberof EnterpriseConnectionDto */ 'enforce_group_sync': boolean; /** * This will allow to create mapping rules based on your IDP group names. It\'s a dictionnary having: - key: either a Qovery provided role (i.e `viewer`) or one of your custom role`s uuid - value: an array of your IDP group names Example: \"I want to associate the Qovery role `devops` to my IDP groups [\'Administrators\', \'DevSecOps\']\" * @type {{ [key: string]: Array; }} * @memberof EnterpriseConnectionDto */ 'group_mappings': { [key: string]: Array; }; } /** * * @export * @interface EnterpriseConnectionResponseList */ export interface EnterpriseConnectionResponseList { /** * * @type {Array} * @memberof EnterpriseConnectionResponseList */ 'results'?: Array; } /** * * @export * @interface EnvDeploymentStatus */ export interface EnvDeploymentStatus { /** * * @type {string} * @memberof EnvDeploymentStatus */ 'deployment_request_id'?: string; /** * * @type {string} * @memberof EnvDeploymentStatus */ 'environment_id'?: string; /** * * @type {StateEnum} * @memberof EnvDeploymentStatus */ 'status'?: StateEnum; } /** * * @export * @interface Environment */ export interface Environment { /** * * @type {string} * @memberof Environment */ 'id': string; /** * * @type {string} * @memberof Environment */ 'created_at': string; /** * * @type {string} * @memberof Environment */ 'updated_at'?: string; /** * name is case insensitive * @type {string} * @memberof Environment */ 'name': string; /** * * @type {ReferenceObject} * @memberof Environment */ 'organization': ReferenceObject; /** * * @type {ReferenceObject} * @memberof Environment */ 'project': ReferenceObject; /** * uuid of the user that made the last update * @type {string} * @memberof Environment */ 'last_updated_by'?: string; /** * * @type {EnvironmentAllOfCloudProvider} * @memberof Environment */ 'cloud_provider': EnvironmentAllOfCloudProvider; /** * * @type {EnvironmentModeEnum} * @memberof Environment */ 'mode': EnvironmentModeEnum; /** * * @type {string} * @memberof Environment */ 'cluster_id': string; /** * * @type {string} * @memberof Environment */ 'cluster_name'?: string; } /** * * @export * @interface EnvironmentAllOfCloudProvider */ export interface EnvironmentAllOfCloudProvider { /** * * @type {string} * @memberof EnvironmentAllOfCloudProvider */ 'provider'?: string; /** * * @type {string} * @memberof EnvironmentAllOfCloudProvider */ 'cluster'?: string; } /** * * @export * @interface EnvironmentDeploymentRule */ export interface EnvironmentDeploymentRule { /** * * @type {string} * @memberof EnvironmentDeploymentRule */ 'id': string; /** * * @type {string} * @memberof EnvironmentDeploymentRule */ 'created_at': string; /** * * @type {string} * @memberof EnvironmentDeploymentRule */ 'updated_at'?: string; /** * * @type {boolean} * @memberof EnvironmentDeploymentRule */ 'on_demand_preview'?: boolean; /** * * @type {boolean} * @memberof EnvironmentDeploymentRule */ 'auto_stop'?: boolean; /** * * @type {boolean} * @memberof EnvironmentDeploymentRule */ 'auto_preview'?: boolean; /** * * @type {string} * @memberof EnvironmentDeploymentRule */ 'timezone': string; /** * * @type {string} * @memberof EnvironmentDeploymentRule */ 'start_time': string; /** * * @type {string} * @memberof EnvironmentDeploymentRule */ 'stop_time': string; /** * * @type {Array} * @memberof EnvironmentDeploymentRule */ 'weekdays': Array; } /** * * @export * @interface EnvironmentDeploymentRuleEditRequest */ export interface EnvironmentDeploymentRuleEditRequest { /** * * @type {boolean} * @memberof EnvironmentDeploymentRuleEditRequest */ 'on_demand_preview'?: boolean; /** * * @type {boolean} * @memberof EnvironmentDeploymentRuleEditRequest */ 'auto_preview'?: boolean; /** * * @type {boolean} * @memberof EnvironmentDeploymentRuleEditRequest */ 'auto_stop'?: boolean; /** * * @type {string} * @memberof EnvironmentDeploymentRuleEditRequest */ 'timezone': string; /** * * @type {string} * @memberof EnvironmentDeploymentRuleEditRequest */ 'start_time': string; /** * * @type {string} * @memberof EnvironmentDeploymentRuleEditRequest */ 'stop_time': string; /** * * @type {Array} * @memberof EnvironmentDeploymentRuleEditRequest */ 'weekdays': Array; } /** * * @export * @enum {string} */ export declare const EnvironmentDeploymentStatusEnum: { readonly NEVER_DEPLOYED: "NEVER_DEPLOYED"; readonly UP_TO_DATE: "UP_TO_DATE"; readonly OUT_OF_DATE: "OUT_OF_DATE"; }; export type EnvironmentDeploymentStatusEnum = typeof EnvironmentDeploymentStatusEnum[keyof typeof EnvironmentDeploymentStatusEnum]; /** * * @export * @interface EnvironmentEditRequest */ export interface EnvironmentEditRequest { /** * * @type {string} * @memberof EnvironmentEditRequest */ 'name'?: string; /** * * @type {CreateEnvironmentModeEnum} * @memberof EnvironmentEditRequest */ 'mode'?: CreateEnvironmentModeEnum; } /** * * @export * @interface EnvironmentLog */ export interface EnvironmentLog { /** * * @type {string} * @memberof EnvironmentLog */ 'id': string; /** * * @type {string} * @memberof EnvironmentLog */ 'created_at': string; /** * * @type {EnvironmentLogScope} * @memberof EnvironmentLog */ 'scope'?: EnvironmentLogScope; /** * * @type {StatusKindEnum} * @memberof EnvironmentLog */ 'state'?: StatusKindEnum; /** * Log message * @type {string} * @memberof EnvironmentLog */ 'message': string | null; /** * Only for errors. Helps Qovery team to investigate. * @type {string} * @memberof EnvironmentLog */ 'execution_id'?: string; /** * * @type {string} * @memberof EnvironmentLog */ 'hint'?: string; } /** * * @export * @interface EnvironmentLogResponseList */ export interface EnvironmentLogResponseList { /** * * @type {Array} * @memberof EnvironmentLogResponseList */ 'results'?: Array; } /** * * @export * @interface EnvironmentLogScope */ export interface EnvironmentLogScope { /** * * @type {EnvironmentLogTypeEnum} * @memberof EnvironmentLogScope */ 'type'?: EnvironmentLogTypeEnum; /** * * @type {string} * @memberof EnvironmentLogScope */ 'name'?: string; /** * * @type {string} * @memberof EnvironmentLogScope */ 'id'?: string; } /** * * @export * @enum {string} */ export declare const EnvironmentLogTypeEnum: { readonly APPLICATION: "APPLICATION"; readonly DATABASE: "DATABASE"; readonly ENVIRONMENT: "ENVIRONMENT"; }; export type EnvironmentLogTypeEnum = typeof EnvironmentLogTypeEnum[keyof typeof EnvironmentLogTypeEnum]; /** * * @export * @interface EnvironmentLogs */ export interface EnvironmentLogs { /** * * @type {string} * @memberof EnvironmentLogs */ 'type': string; /** * * @type {string} * @memberof EnvironmentLogs */ 'timestamp': string; /** * * @type {EnvironmentLogsDetails} * @memberof EnvironmentLogs */ 'details': EnvironmentLogsDetails; /** * * @type {EnvironmentLogsError} * @memberof EnvironmentLogs */ 'error'?: EnvironmentLogsError | null; /** * * @type {EnvironmentLogsMessage} * @memberof EnvironmentLogs */ 'message'?: EnvironmentLogsMessage | null; } /** * * @export * @interface EnvironmentLogsDetails */ export interface EnvironmentLogsDetails { /** * * @type {string} * @memberof EnvironmentLogsDetails */ 'organization_id'?: string; /** * * @type {string} * @memberof EnvironmentLogsDetails */ 'cluster_id'?: string; /** * * @type {string} * @memberof EnvironmentLogsDetails */ 'execution_id'?: string; /** * * @type {EnvironmentLogsDetailsTransmitter} * @memberof EnvironmentLogsDetails */ 'transmitter'?: EnvironmentLogsDetailsTransmitter; /** * * @type {EnvironmentLogsDetailsStage} * @memberof EnvironmentLogsDetails */ 'stage'?: EnvironmentLogsDetailsStage; } /** * * @export * @interface EnvironmentLogsDetailsStage */ export interface EnvironmentLogsDetailsStage { /** * * @type {string} * @memberof EnvironmentLogsDetailsStage */ 'step'?: string; /** * * @type {string} * @memberof EnvironmentLogsDetailsStage */ 'id'?: string | null; /** * * @type {string} * @memberof EnvironmentLogsDetailsStage */ 'name'?: string | null; } /** * * @export * @interface EnvironmentLogsDetailsTransmitter */ export interface EnvironmentLogsDetailsTransmitter { /** * * @type {string} * @memberof EnvironmentLogsDetailsTransmitter */ 'id'?: string; /** * * @type {string} * @memberof EnvironmentLogsDetailsTransmitter */ 'name'?: string; /** * * @type {string} * @memberof EnvironmentLogsDetailsTransmitter */ 'type'?: string; } /** * * @export * @interface EnvironmentLogsError */ export interface EnvironmentLogsError { /** * * @type {string} * @memberof EnvironmentLogsError */ 'tag'?: string; /** * * @type {string} * @memberof EnvironmentLogsError */ 'user_log_message'?: string; /** * * @type {string} * @memberof EnvironmentLogsError */ 'link'?: string; /** * * @type {string} * @memberof EnvironmentLogsError */ 'hint_message'?: string; /** * * @type {EnvironmentLogsErrorUnderlyingError} * @memberof EnvironmentLogsError */ 'underlying_error'?: EnvironmentLogsErrorUnderlyingError; } /** * * @export * @interface EnvironmentLogsErrorUnderlyingError */ export interface EnvironmentLogsErrorUnderlyingError { /** * * @type {string} * @memberof EnvironmentLogsErrorUnderlyingError */ 'message'?: string; /** * * @type {string} * @memberof EnvironmentLogsErrorUnderlyingError */ 'full_details'?: string; } /** * * @export * @interface EnvironmentLogsMessage */ export interface EnvironmentLogsMessage { /** * * @type {string} * @memberof EnvironmentLogsMessage */ 'safe_message'?: string; /** * * @type {string} * @memberof EnvironmentLogsMessage */ 'full_details'?: string; } /** * * @export * @enum {string} */ export declare const EnvironmentModeEnum: { readonly DEVELOPMENT: "DEVELOPMENT"; readonly PREVIEW: "PREVIEW"; readonly PRODUCTION: "PRODUCTION"; readonly STAGING: "STAGING"; }; export type EnvironmentModeEnum = typeof EnvironmentModeEnum[keyof typeof EnvironmentModeEnum]; /** * * @export * @interface EnvironmentOverviewResponse */ export interface EnvironmentOverviewResponse { /** * * @type {string} * @memberof EnvironmentOverviewResponse */ 'id': string; /** * * @type {string} * @memberof EnvironmentOverviewResponse */ 'created_at': string; /** * * @type {string} * @memberof EnvironmentOverviewResponse */ 'updated_at': string; /** * * @type {string} * @memberof EnvironmentOverviewResponse */ 'name': string; /** * * @type {EnvironmentModeEnum} * @memberof EnvironmentOverviewResponse */ 'mode': EnvironmentModeEnum; /** * * @type {ClusterOverviewResponse} * @memberof EnvironmentOverviewResponse */ 'cluster': ClusterOverviewResponse; /** * * @type {ServicesOverviewResponse} * @memberof EnvironmentOverviewResponse */ 'services_overview': ServicesOverviewResponse; /** * * @type {EnvironmentStatus} * @memberof EnvironmentOverviewResponse */ 'deployment_status'?: EnvironmentStatus | null; } /** * * @export * @interface EnvironmentOverviewResponseList */ export interface EnvironmentOverviewResponseList { /** * * @type {Array} * @memberof EnvironmentOverviewResponseList */ 'results'?: Array; } /** * * @export * @interface EnvironmentResponseList */ export interface EnvironmentResponseList { /** * * @type {Array} * @memberof EnvironmentResponseList */ 'results'?: Array; } /** * * @export * @interface EnvironmentServiceIdsAllRequest */ export interface EnvironmentServiceIdsAllRequest { /** * * @type {Array} * @memberof EnvironmentServiceIdsAllRequest */ 'application_ids'?: Array; /** * * @type {Array} * @memberof EnvironmentServiceIdsAllRequest */ 'container_ids'?: Array; /** * * @type {Array} * @memberof EnvironmentServiceIdsAllRequest */ 'database_ids'?: Array; /** * * @type {Array} * @memberof EnvironmentServiceIdsAllRequest */ 'job_ids'?: Array; /** * * @type {Array} * @memberof EnvironmentServiceIdsAllRequest */ 'helm_ids'?: Array; /** * * @type {Array} * @memberof EnvironmentServiceIdsAllRequest */ 'terraform_ids'?: Array; } /** * * @export * @interface EnvironmentStats */ export interface EnvironmentStats { /** * * @type {string} * @memberof EnvironmentStats */ 'id': string; /** * * @type {number} * @memberof EnvironmentStats */ 'service_total_number'?: number; } /** * * @export * @interface EnvironmentStatsResponseList */ export interface EnvironmentStatsResponseList { /** * * @type {Array} * @memberof EnvironmentStatsResponseList */ 'results'?: Array; } /** * * @export * @interface EnvironmentStatus */ export interface EnvironmentStatus { /** * * @type {string} * @memberof EnvironmentStatus */ 'id': string; /** * * @type {StateEnum} * @memberof EnvironmentStatus */ 'state': StateEnum; /** * * @type {string} * @memberof EnvironmentStatus */ 'last_deployment_date'?: string | null; /** * * @type {StateEnum} * @memberof EnvironmentStatus */ 'last_deployment_state': StateEnum; /** * * @type {string} * @memberof EnvironmentStatus */ 'last_deployment_id'?: string | null; /** * * @type {number} * @memberof EnvironmentStatus */ 'total_deployment_duration_in_seconds'?: number | null; /** * * @type {EnvironmentStatusEventOriginEnum} * @memberof EnvironmentStatus */ 'origin'?: EnvironmentStatusEventOriginEnum | null; /** * * @type {string} * @memberof EnvironmentStatus */ 'triggered_by'?: string | null; /** * * @type {EnvironmentDeploymentStatusEnum} * @memberof EnvironmentStatus */ 'deployment_status'?: EnvironmentDeploymentStatusEnum; /** * * @type {string} * @memberof EnvironmentStatus */ 'deployment_request_id'?: string | null; /** * * @type {Array} * @memberof EnvironmentStatus */ 'metrics'?: Array | null; } /** * Origin of the organization event * @export * @enum {string} */ export declare const EnvironmentStatusEventOriginEnum: { readonly API: "API"; readonly CLI: "CLI"; readonly CONSOLE: "CONSOLE"; readonly GIT: "GIT"; readonly QOVERY_INTERNAL: "QOVERY_INTERNAL"; readonly TERRAFORM_PROVIDER: "TERRAFORM_PROVIDER"; }; export type EnvironmentStatusEventOriginEnum = typeof EnvironmentStatusEventOriginEnum[keyof typeof EnvironmentStatusEventOriginEnum]; /** * * @export * @interface EnvironmentStatusList */ export interface EnvironmentStatusList { /** * * @type {Array} * @memberof EnvironmentStatusList */ 'results'?: Array; } /** * * @export * @interface EnvironmentStatuses */ export interface EnvironmentStatuses { /** * * @type {EnvironmentStatus} * @memberof EnvironmentStatuses */ 'environment': EnvironmentStatus; /** * * @type {Array} * @memberof EnvironmentStatuses */ 'applications': Array; /** * * @type {Array} * @memberof EnvironmentStatuses */ 'containers': Array; /** * * @type {Array} * @memberof EnvironmentStatuses */ 'jobs': Array; /** * * @type {Array} * @memberof EnvironmentStatuses */ 'databases': Array; /** * * @type {Array} * @memberof EnvironmentStatuses */ 'helms': Array; /** * * @type {Array} * @memberof EnvironmentStatuses */ 'terraforms': Array; } /** * * @export * @interface EnvironmentStatusesWithStages */ export interface EnvironmentStatusesWithStages { /** * * @type {EnvironmentStatus} * @memberof EnvironmentStatusesWithStages */ 'environment'?: EnvironmentStatus; /** * * @type {Array} * @memberof EnvironmentStatusesWithStages */ 'stages'?: Array; /** * * @type {EnvironmentStatusesWithStagesPreCheckStage} * @memberof EnvironmentStatusesWithStages */ 'pre_check_stage'?: EnvironmentStatusesWithStagesPreCheckStage; } /** * * @export * @interface EnvironmentStatusesWithStagesPreCheckStage */ export interface EnvironmentStatusesWithStagesPreCheckStage { /** * * @type {StepMetricStatusEnum} * @memberof EnvironmentStatusesWithStagesPreCheckStage */ 'status'?: StepMetricStatusEnum; /** * * @type {number} * @memberof EnvironmentStatusesWithStagesPreCheckStage */ 'total_duration_sec'?: number; } /** * * @export * @interface EnvironmentTotalNumber */ export interface EnvironmentTotalNumber { /** * * @type {number} * @memberof EnvironmentTotalNumber */ 'environment_total_number'?: number; } /** * * @export * @interface EnvironmentVariable */ export interface EnvironmentVariable { /** * * @type {string} * @memberof EnvironmentVariable */ 'id': string; /** * * @type {string} * @memberof EnvironmentVariable */ 'created_at': string; /** * * @type {string} * @memberof EnvironmentVariable */ 'updated_at'?: string; /** * key is case sensitive. * @type {string} * @memberof EnvironmentVariable */ 'key': string; /** * value of the env variable. * @type {string} * @memberof EnvironmentVariable */ 'value'?: string; /** * should be set for file only. variable mount path makes variable a file (where file should be mounted). * @type {string} * @memberof EnvironmentVariable */ 'mount_path'?: string | null; /** * optional variable description (255 characters maximum) * @type {string} * @memberof EnvironmentVariable */ 'description'?: string | null; /** * * @type {boolean} * @memberof EnvironmentVariable */ 'enable_interpolation_in_file'?: boolean | null; /** * * @type {EnvironmentVariableOverride} * @memberof EnvironmentVariable */ 'overridden_variable'?: EnvironmentVariableOverride; /** * * @type {EnvironmentVariableAlias} * @memberof EnvironmentVariable */ 'aliased_variable'?: EnvironmentVariableAlias; /** * * @type {APIVariableScopeEnum} * @memberof EnvironmentVariable */ 'scope': APIVariableScopeEnum; /** * * @type {APIVariableTypeEnum} * @memberof EnvironmentVariable */ 'variable_type': APIVariableTypeEnum; /** * * @type {string} * @memberof EnvironmentVariable */ 'service_id'?: string; /** * * @type {string} * @memberof EnvironmentVariable */ 'service_name'?: string; /** * * @type {LinkedServiceTypeEnum} * @memberof EnvironmentVariable */ 'service_type'?: LinkedServiceTypeEnum; /** * Entity that created/own the variable (i.e: Qovery, Doppler) * @type {string} * @memberof EnvironmentVariable */ 'owned_by'?: string; } /** * * @export * @interface EnvironmentVariableAlias */ export interface EnvironmentVariableAlias { /** * * @type {string} * @memberof EnvironmentVariableAlias */ 'id': string; /** * * @type {string} * @memberof EnvironmentVariableAlias */ 'key': string; /** * * @type {string} * @memberof EnvironmentVariableAlias */ 'value': string; /** * * @type {string} * @memberof EnvironmentVariableAlias */ 'mount_path': string; /** * * @type {APIVariableScopeEnum} * @memberof EnvironmentVariableAlias */ 'scope': APIVariableScopeEnum; /** * * @type {APIVariableTypeEnum} * @memberof EnvironmentVariableAlias */ 'variable_type': APIVariableTypeEnum; } /** * * @export * @interface EnvironmentVariableEditRequest */ export interface EnvironmentVariableEditRequest { /** * key is case sensitive * @type {string} * @memberof EnvironmentVariableEditRequest */ 'key': string; /** * value of the env variable. * @type {string} * @memberof EnvironmentVariableEditRequest */ 'value'?: string; /** * * @type {string} * @memberof EnvironmentVariableEditRequest */ 'mount_path'?: string | null; /** * optional variable description (255 characters maximum) * @type {string} * @memberof EnvironmentVariableEditRequest */ 'description'?: string | null; /** * * @type {boolean} * @memberof EnvironmentVariableEditRequest */ 'enable_interpolation_in_file'?: boolean | null; } /** * * @export * @interface EnvironmentVariableOverride */ export interface EnvironmentVariableOverride { /** * * @type {string} * @memberof EnvironmentVariableOverride */ 'id': string; /** * * @type {string} * @memberof EnvironmentVariableOverride */ 'key': string; /** * * @type {string} * @memberof EnvironmentVariableOverride */ 'value': string; /** * * @type {string} * @memberof EnvironmentVariableOverride */ 'mount_path': string; /** * * @type {APIVariableScopeEnum} * @memberof EnvironmentVariableOverride */ 'scope': APIVariableScopeEnum; /** * * @type {APIVariableTypeEnum} * @memberof EnvironmentVariableOverride */ 'variable_type': APIVariableTypeEnum; } /** * * @export * @interface EnvironmentVariableRequest */ export interface EnvironmentVariableRequest { /** * key is case sensitive. * @type {string} * @memberof EnvironmentVariableRequest */ 'key': string; /** * value of the env variable. * @type {string} * @memberof EnvironmentVariableRequest */ 'value'?: string; /** * should be set for file only. variable mount path makes variable a file (where file should be mounted). * @type {string} * @memberof EnvironmentVariableRequest */ 'mount_path'?: string | null; /** * optional variable description (255 characters maximum) * @type {string} * @memberof EnvironmentVariableRequest */ 'description'?: string | null; /** * * @type {boolean} * @memberof EnvironmentVariableRequest */ 'enable_interpolation_in_file'?: boolean | null; } /** * * @export * @interface EnvironmentVariableResponseList */ export interface EnvironmentVariableResponseList { /** * * @type {Array} * @memberof EnvironmentVariableResponseList */ 'results'?: Array; } /** * * @export * @interface ExternalSecretAssociatedServiceResponse */ export interface ExternalSecretAssociatedServiceResponse { /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'project_id': string; /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'project_name': string; /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'environment_id': string; /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'environment_name': string; /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'service_id'?: string; /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'service_name'?: string; /** * * @type {APIVariableScopeEnum} * @memberof ExternalSecretAssociatedServiceResponse */ 'service_type'?: APIVariableScopeEnum; /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'variable_name': string; /** * * @type {string} * @memberof ExternalSecretAssociatedServiceResponse */ 'external_secret_name': string; } /** * * @export * @interface ExternalSecretAssociatedServiceResponseList */ export interface ExternalSecretAssociatedServiceResponseList { /** * * @type {Array} * @memberof ExternalSecretAssociatedServiceResponseList */ 'results': Array; } /** * * @export * @interface GcpCredentialsRequest */ export interface GcpCredentialsRequest { /** * * @type {string} * @memberof GcpCredentialsRequest */ 'name': string; /** * The json must be base64 encoded * @type {string} * @memberof GcpCredentialsRequest */ 'gcp_credentials': string; } /** * * @export * @interface GcpJsonCredentialsAuthDto */ export interface GcpJsonCredentialsAuthDto { /** * * @type {string} * @memberof GcpJsonCredentialsAuthDto */ 'mode': GcpJsonCredentialsAuthDtoModeEnum; /** * The json must be base64 encoded * @type {string} * @memberof GcpJsonCredentialsAuthDto */ 'json_credentials'?: string | null; } export declare const GcpJsonCredentialsAuthDtoModeEnum: { readonly GCP_JSON_CREDENTIALS: "GCP_JSON_CREDENTIALS"; }; export type GcpJsonCredentialsAuthDtoModeEnum = typeof GcpJsonCredentialsAuthDtoModeEnum[keyof typeof GcpJsonCredentialsAuthDtoModeEnum]; /** * * @export * @interface GcpSecretManagerEndpointDto */ export interface GcpSecretManagerEndpointDto { /** * * @type {string} * @memberof GcpSecretManagerEndpointDto */ 'mode': GcpSecretManagerEndpointDtoModeEnum; /** * * @type {string} * @memberof GcpSecretManagerEndpointDto */ 'region': string; /** * * @type {string} * @memberof GcpSecretManagerEndpointDto */ 'projectId': string; } export declare const GcpSecretManagerEndpointDtoModeEnum: { readonly GCP_SECRET_MANAGER: "GCP_SECRET_MANAGER"; }; export type GcpSecretManagerEndpointDtoModeEnum = typeof GcpSecretManagerEndpointDtoModeEnum[keyof typeof GcpSecretManagerEndpointDtoModeEnum]; /** * * @export * @interface GcpStaticClusterCredentials */ export interface GcpStaticClusterCredentials { /** * * @type {string} * @memberof GcpStaticClusterCredentials */ 'id': string; /** * * @type {string} * @memberof GcpStaticClusterCredentials */ 'name': string; /** * * @type {string} * @memberof GcpStaticClusterCredentials */ 'object_type': GcpStaticClusterCredentialsObjectTypeEnum; } export declare const GcpStaticClusterCredentialsObjectTypeEnum: { readonly GCP: "GCP"; }; export type GcpStaticClusterCredentialsObjectTypeEnum = typeof GcpStaticClusterCredentialsObjectTypeEnum[keyof typeof GcpStaticClusterCredentialsObjectTypeEnum]; /** * * @export * @interface GenericClusterCredentials */ export interface GenericClusterCredentials { /** * * @type {string} * @memberof GenericClusterCredentials */ 'id': string; /** * * @type {string} * @memberof GenericClusterCredentials */ 'name': string; /** * * @type {string} * @memberof GenericClusterCredentials */ 'object_type': GenericClusterCredentialsObjectTypeEnum; } export declare const GenericClusterCredentialsObjectTypeEnum: { readonly OTHER: "OTHER"; }; export type GenericClusterCredentialsObjectTypeEnum = typeof GenericClusterCredentialsObjectTypeEnum[keyof typeof GenericClusterCredentialsObjectTypeEnum]; /** * * @export * @interface GenericObjectCurrentCost */ export interface GenericObjectCurrentCost { /** * * @type {string} * @memberof GenericObjectCurrentCost */ 'id': string; /** * * @type {string} * @memberof GenericObjectCurrentCost */ 'name': string; /** * * @type {number} * @memberof GenericObjectCurrentCost */ 'consumed_time_in_seconds': number; /** * * @type {Cost} * @memberof GenericObjectCurrentCost */ 'cost': Cost; } /** * * @export * @interface GetClusterKubernetesEvents200Response */ export interface GetClusterKubernetesEvents200Response { /** * * @type {Array} * @memberof GetClusterKubernetesEvents200Response */ 'results'?: Array; } /** * * @export * @interface GetClusterKubernetesEvents200ResponseResultsInner */ export interface GetClusterKubernetesEvents200ResponseResultsInner { /** * The created date following ISO-8601 format * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'created_at'?: string; /** * The source kubernetes object related to the Event * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'kind'?: string; /** * The namespace of the kubernetes object related to the Event (optional) * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'namespace'?: string; /** * The name of the Event * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'name'?: string; /** * The action that triggered the Event * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'reason'?: string; /** * A description of the Event * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'message'?: string; /** * As of today it can be either Warning or Normal (can evolve in the next releases) * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'type'?: string; /** * * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'reporting_component'?: string; /** * * @type {number} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'count'?: number; /** * * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'first_occurrence'?: string; /** * * @type {string} * @memberof GetClusterKubernetesEvents200ResponseResultsInner */ 'last_occurrence'?: string; } /** * * @export * @interface GetClusterTokenByClusterId200Response */ export interface GetClusterTokenByClusterId200Response { /** * * @type {string} * @memberof GetClusterTokenByClusterId200Response */ 'apiVersion': string; /** * * @type {string} * @memberof GetClusterTokenByClusterId200Response */ 'kind': string; /** * * @type {object} * @memberof GetClusterTokenByClusterId200Response */ 'spec': object; /** * * @type {GetClusterTokenByClusterId200ResponseStatus} * @memberof GetClusterTokenByClusterId200Response */ 'status': GetClusterTokenByClusterId200ResponseStatus; } /** * * @export * @interface GetClusterTokenByClusterId200ResponseStatus */ export interface GetClusterTokenByClusterId200ResponseStatus { /** * * @type {string} * @memberof GetClusterTokenByClusterId200ResponseStatus */ 'token': string; /** * * @type {string} * @memberof GetClusterTokenByClusterId200ResponseStatus */ 'expirationTimestamp': string; } /** * Response for ghost alerts that exist in Prometheus but have been deleted from the database * @export * @interface GhostAlertRuleResponse */ export interface GhostAlertRuleResponse extends AlertRuleResponseBase { /** * * @type {GhostAlertRuleResponseAllOfTarget} * @memberof GhostAlertRuleResponse */ 'target'?: GhostAlertRuleResponseAllOfTarget; /** * When the ghost alert started firing * @type {string} * @memberof GhostAlertRuleResponse */ 'starts_at'?: string | null; } /** * May be null if target info couldn\'t be extracted from Prometheus * @export * @interface GhostAlertRuleResponseAllOfTarget */ export interface GhostAlertRuleResponseAllOfTarget { /** * * @type {AlertTargetType} * @memberof GhostAlertRuleResponseAllOfTarget */ 'target_type': AlertTargetType; /** * * @type {string} * @memberof GhostAlertRuleResponseAllOfTarget */ 'target_id': string; /** * * @type {ServiceLightResponse} * @memberof GhostAlertRuleResponseAllOfTarget */ 'service'?: ServiceLightResponse; } /** * * @export * @interface GitAuthProvider */ export interface GitAuthProvider { /** * * @type {string} * @memberof GitAuthProvider */ 'id'?: string; /** * * @type {string} * @memberof GitAuthProvider */ 'name': string; /** * * @type {string} * @memberof GitAuthProvider */ 'owner': string; /** * * @type {boolean} * @memberof GitAuthProvider */ 'use_bot'?: boolean; } /** * * @export * @interface GitAuthProviderResponseList */ export interface GitAuthProviderResponseList { /** * * @type {Array} * @memberof GitAuthProviderResponseList */ 'results'?: Array; } /** * * @export * @interface GitFileCheckRequest */ export interface GitFileCheckRequest { /** * * @type {HelmGitRepositoryRequest} * @memberof GitFileCheckRequest */ 'git_repository': HelmGitRepositoryRequest; /** * * @type {Array} * @memberof GitFileCheckRequest */ 'files': Array; } /** * * @export * @enum {string} */ export declare const GitProviderEnum: { readonly BITBUCKET: "BITBUCKET"; readonly GITHUB: "GITHUB"; readonly GITLAB: "GITLAB"; }; export type GitProviderEnum = typeof GitProviderEnum[keyof typeof GitProviderEnum]; /** * * @export * @interface GitRepository */ export interface GitRepository { /** * * @type {string} * @memberof GitRepository */ 'id': string; /** * * @type {string} * @memberof GitRepository */ 'name': string; /** * * @type {string} * @memberof GitRepository */ 'url': string; /** * * @type {string} * @memberof GitRepository */ 'default_branch'?: string; /** * * @type {boolean} * @memberof GitRepository */ 'is_private'?: boolean; } /** * * @export * @interface GitRepositoryBranch */ export interface GitRepositoryBranch { /** * * @type {string} * @memberof GitRepositoryBranch */ 'name': string; } /** * * @export * @interface GitRepositoryBranchResponseList */ export interface GitRepositoryBranchResponseList { /** * * @type {Array} * @memberof GitRepositoryBranchResponseList */ 'results'?: Array; } /** * * @export * @interface GitRepositoryResponseList */ export interface GitRepositoryResponseList { /** * * @type {Array} * @memberof GitRepositoryResponseList */ 'results'?: Array; } /** * * @export * @interface GitTokenAssociatedServiceResponse */ export interface GitTokenAssociatedServiceResponse { /** * * @type {string} * @memberof GitTokenAssociatedServiceResponse */ 'project_id': string; /** * * @type {string} * @memberof GitTokenAssociatedServiceResponse */ 'project_name': string; /** * * @type {string} * @memberof GitTokenAssociatedServiceResponse */ 'environment_id': string; /** * * @type {string} * @memberof GitTokenAssociatedServiceResponse */ 'environment_name': string; /** * * @type {string} * @memberof GitTokenAssociatedServiceResponse */ 'service_id': string; /** * * @type {string} * @memberof GitTokenAssociatedServiceResponse */ 'service_name': string; /** * * @type {GitTokenAssociatedServiceType} * @memberof GitTokenAssociatedServiceResponse */ 'service_type': GitTokenAssociatedServiceType; } /** * * @export * @enum {string} */ export declare const GitTokenAssociatedServiceType: { readonly APPLICATION: "APPLICATION"; readonly CRON: "CRON"; readonly LIFECYCLE: "LIFECYCLE"; readonly HELM: "HELM"; readonly TERRAFORM: "TERRAFORM"; }; export type GitTokenAssociatedServiceType = typeof GitTokenAssociatedServiceType[keyof typeof GitTokenAssociatedServiceType]; /** * * @export * @interface GitTokenAssociatedServicesResponseList */ export interface GitTokenAssociatedServicesResponseList { /** * * @type {Array} * @memberof GitTokenAssociatedServicesResponseList */ 'results'?: Array; } /** * * @export * @interface GitTokenRequest */ export interface GitTokenRequest { /** * * @type {string} * @memberof GitTokenRequest */ 'name': string; /** * * @type {string} * @memberof GitTokenRequest */ 'description'?: string; /** * * @type {GitProviderEnum} * @memberof GitTokenRequest */ 'type': GitProviderEnum; /** * The token from your git provider side * @type {string} * @memberof GitTokenRequest */ 'token': string; /** * Mandatory only for BITBUCKET git provider, to allow us to fetch repositories at creation/edition of a service * @type {string} * @memberof GitTokenRequest */ 'workspace'?: string; /** * custom git api url for the given git provider/type. I.e: Self-hosted version of Gitlab * @type {string} * @memberof GitTokenRequest */ 'git_api_url'?: string; } /** * * @export * @interface GitTokenResponse */ export interface GitTokenResponse { /** * * @type {string} * @memberof GitTokenResponse */ 'id': string; /** * * @type {string} * @memberof GitTokenResponse */ 'created_at': string; /** * * @type {string} * @memberof GitTokenResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof GitTokenResponse */ 'name': string; /** * * @type {string} * @memberof GitTokenResponse */ 'description'?: string; /** * * @type {GitProviderEnum} * @memberof GitTokenResponse */ 'type': GitProviderEnum; /** * * @type {string} * @memberof GitTokenResponse */ 'expired_at'?: string; /** * Mandatory only for BITBUCKET git provider * @type {string} * @memberof GitTokenResponse */ 'workspace'?: string; /** * The number of services using this git token * @type {number} * @memberof GitTokenResponse */ 'associated_services_count': number; /** * * @type {string} * @memberof GitTokenResponse */ 'git_api_url': string; } /** * * @export * @interface GitTokenResponseList */ export interface GitTokenResponseList { /** * * @type {Array} * @memberof GitTokenResponseList */ 'results'?: Array; } /** * * @export * @interface GitWebhookStatusResponse */ export interface GitWebhookStatusResponse { /** * The webhook configuration status: - ACTIVE: Webhook is properly configured with all required events - NOT_CONFIGURED: No Qovery webhook found on the git rep - MISCONFIGURED: Webhook exists but is missing required events - UNABLE_TO_VERIFY: Could not check webhook status (auth error, rate limit, etc.) * @type {string} * @memberof GitWebhookStatusResponse */ 'status': GitWebhookStatusResponseStatusEnum; /** * The git provider where the webhook is configured * @type {string} * @memberof GitWebhookStatusResponse */ 'provider': GitWebhookStatusResponseProviderEnum; /** * List of required events that are missing from the webhook configuration (only present when status is MISCONFIGURED) * @type {Array} * @memberof GitWebhookStatusResponse */ 'missing_events'?: Array; } export declare const GitWebhookStatusResponseStatusEnum: { readonly ACTIVE: "ACTIVE"; readonly NOT_CONFIGURED: "NOT_CONFIGURED"; readonly MISCONFIGURED: "MISCONFIGURED"; readonly UNABLE_TO_VERIFY: "UNABLE_TO_VERIFY"; }; export type GitWebhookStatusResponseStatusEnum = typeof GitWebhookStatusResponseStatusEnum[keyof typeof GitWebhookStatusResponseStatusEnum]; export declare const GitWebhookStatusResponseProviderEnum: { readonly GITHUB: "GITHUB"; readonly GITLAB: "GITLAB"; readonly BITBUCKET: "BITBUCKET"; }; export type GitWebhookStatusResponseProviderEnum = typeof GitWebhookStatusResponseProviderEnum[keyof typeof GitWebhookStatusResponseProviderEnum]; /** * * @export * @interface GkeInfrastructureOutputs */ export interface GkeInfrastructureOutputs { /** * * @type {string} * @memberof GkeInfrastructureOutputs */ 'kind': GkeInfrastructureOutputsKindEnum; /** * * @type {string} * @memberof GkeInfrastructureOutputs */ 'cluster_name': string; /** * * @type {string} * @memberof GkeInfrastructureOutputs */ 'cluster_self_link': string; } export declare const GkeInfrastructureOutputsKindEnum: { readonly GKE: "GKE"; }; export type GkeInfrastructureOutputsKindEnum = typeof GkeInfrastructureOutputsKindEnum[keyof typeof GkeInfrastructureOutputsKindEnum]; /** * * @export * @interface Healthcheck */ export interface Healthcheck { /** * * @type {Probe} * @memberof Healthcheck */ 'readiness_probe'?: Probe | null; /** * * @type {Probe} * @memberof Healthcheck */ 'liveness_probe'?: Probe | null; } /** * * @export * @interface HelmAdvancedSettings */ export interface HelmAdvancedSettings { /** * disable custom domain check when deploying a helm * @type {boolean} * @memberof HelmAdvancedSettings */ 'deployment.custom_domain_check_enabled'?: boolean; /** * * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.proxy_body_size_mb'?: number; /** * When using SSL offloading outside of cluster, you can enforce a redirect to HTTPS even when there is no TLS certificate available * @type {boolean} * @memberof HelmAdvancedSettings */ 'network.ingress.force_ssl_redirect'?: boolean; /** * * @type {boolean} * @memberof HelmAdvancedSettings */ 'network.ingress.enable_cors'?: boolean; /** * * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.cors_allow_origin'?: string; /** * * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.cors_allow_methods'?: string; /** * * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.cors_allow_headers'?: string; /** * header buffer size used while reading response header from upstream * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.proxy_buffer_size_kb'?: number; /** * Limits the maximum time (in seconds) during which requests can be processed through one keepalive connection * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.keepalive_time_seconds'?: number; /** * Sets a timeout (in seconds) during which an idle keepalive connection to an upstream server will stay open. * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.keepalive_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a response to the client * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for establishing a connection to a proxied server * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.proxy_connect_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a request to the proxied server * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.proxy_send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for reading a response from the proxied server * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.proxy_read_timeout_seconds'?: number; /** * Allows to enable or disable nginx `proxy-buffering` * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.proxy_buffering'?: string; /** * Allows to enable or disable nginx `proxy-request-buffering` * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.proxy_request_buffering'?: string; /** * Sets a timeout (in seconds) for transmitting a request to the grpc server * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.grpc_send_timeout_seconds'?: number; /** * Sets a timeout (in seconds) for transmitting a request to the grpc server * @type {number} * @memberof HelmAdvancedSettings */ 'network.ingress.grpc_read_timeout_seconds'?: number; /** * list of source ranges to allow access to ingress proxy. This property can be used to whitelist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 To allow all source ranges, set 0.0.0.0/0. * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.whitelist_source_range'?: string; /** * list of source ranges to deny access to ingress proxy. This property can be used to blacklist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.denylist_source_range'?: string; /** * Allows to define response headers * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.extra_headers'?: string; /** * Set the name of an environment variable to use as a basic authentication (`login:crypted_password`) from `htpasswd` command. You can add multiples comma separated values. * @type {string} * @memberof HelmAdvancedSettings */ 'network.ingress.basic_auth_env_var'?: string; /** * Enable the load balancer to bind a user\'s session to a specific target. This ensures that all requests from the user during the session are sent to the same target * @type {boolean} * @memberof HelmAdvancedSettings */ 'network.ingress.enable_sticky_session'?: boolean; /** * Sets a timeout (in seconds) for requests proxied through the Gateway API route. * @type {number} * @memberof HelmAdvancedSettings */ 'network.gateway_api.http_request_timeout_seconds'?: number | null; /** * Sets the idle timeout (in seconds) for HTTP connections proxied through the Gateway API route. * @type {number} * @memberof HelmAdvancedSettings */ 'network.gateway_api.http_connection_idle_timeout_seconds'?: number | null; /** * Sets the number of retry attempts for requests proxied through the Gateway API route. * @type {number} * @memberof HelmAdvancedSettings */ 'network.gateway_api.retry.num_retries'?: number | null; /** * Comma-separated retry triggers (for example connect-failure,reset,refused-stream,retriable-status-codes) for requests proxied through the Gateway API route. * @type {string} * @memberof HelmAdvancedSettings */ 'network.gateway_api.retry.retry_on'?: string | null; /** * Comma-separated HTTP status codes (100..599) retried when retry_on includes retriable-status-codes. * @type {string} * @memberof HelmAdvancedSettings */ 'network.gateway_api.retry.http_status_codes'?: string | null; /** * Sets the timeout (in seconds) applied to each retry attempt for requests proxied through the Gateway API route. * @type {number} * @memberof HelmAdvancedSettings */ 'network.gateway_api.retry.per_try_timeout_seconds'?: number | null; } /** * * @export * @interface HelmCheckRequest */ export interface HelmCheckRequest { /** * * @type {HelmGitRepositoryRequest} * @memberof HelmCheckRequest */ 'git_repository': HelmGitRepositoryRequest; } /** * * @export * @interface HelmDefaultValuesRequest */ export interface HelmDefaultValuesRequest { /** * * @type {HelmDefaultValuesRequestAllOfSource} * @memberof HelmDefaultValuesRequest */ 'source': HelmDefaultValuesRequestAllOfSource; } /** * @type HelmDefaultValuesRequestAllOfSource * @export */ export type HelmDefaultValuesRequestAllOfSource = HelmRequestAllOfSourceOneOf | HelmRequestAllOfSourceOneOf1; /** * * @export * @interface HelmDeployRequest */ export interface HelmDeployRequest { /** * version of the chart to deploy. Cannot be set if `git_commit_id` is defined * @type {string} * @memberof HelmDeployRequest */ 'chart_version'?: string; /** * Commit to deploy for chart source. Cannot be set if `version` is defined * @type {string} * @memberof HelmDeployRequest */ 'git_commit_id'?: string; /** * Commit to deploy for values override * @type {string} * @memberof HelmDeployRequest */ 'values_override_git_commit_id'?: string; } /** * * @export * @interface HelmDeploymentRestrictionRequest */ export interface HelmDeploymentRestrictionRequest { /** * * @type {DeploymentRestrictionModeEnum} * @memberof HelmDeploymentRestrictionRequest */ 'mode': DeploymentRestrictionModeEnum; /** * * @type {DeploymentRestrictionTypeEnum} * @memberof HelmDeploymentRestrictionRequest */ 'type': DeploymentRestrictionTypeEnum; /** * For `PATH` restrictions, the value must not start with `/` * @type {string} * @memberof HelmDeploymentRestrictionRequest */ 'value': string; } /** * * @export * @interface HelmDeploymentRestrictionResponse */ export interface HelmDeploymentRestrictionResponse { /** * * @type {string} * @memberof HelmDeploymentRestrictionResponse */ 'id': string; /** * * @type {string} * @memberof HelmDeploymentRestrictionResponse */ 'created_at': string; /** * * @type {string} * @memberof HelmDeploymentRestrictionResponse */ 'updated_at'?: string; /** * * @type {DeploymentRestrictionModeEnum} * @memberof HelmDeploymentRestrictionResponse */ 'mode': DeploymentRestrictionModeEnum; /** * * @type {DeploymentRestrictionTypeEnum} * @memberof HelmDeploymentRestrictionResponse */ 'type': DeploymentRestrictionTypeEnum; /** * For `PATH` restrictions, the value must not start with `/` * @type {string} * @memberof HelmDeploymentRestrictionResponse */ 'value': string; } /** * * @export * @interface HelmDeploymentRestrictionResponseList */ export interface HelmDeploymentRestrictionResponseList { /** * * @type {Array} * @memberof HelmDeploymentRestrictionResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const HelmForceEvent: { readonly DIFF: "DIFF"; }; export type HelmForceEvent = typeof HelmForceEvent[keyof typeof HelmForceEvent]; /** * * @export * @interface HelmGitRepositoryRequest */ export interface HelmGitRepositoryRequest { /** * application git repository URL * @type {string} * @memberof HelmGitRepositoryRequest */ 'url': string; /** * Name of the branch to use. This is optional If not specified, then the branch used is the `main` or `master` one * @type {string} * @memberof HelmGitRepositoryRequest */ 'branch'?: string; /** * indicates the root path of the application. * @type {string} * @memberof HelmGitRepositoryRequest */ 'root_path'?: string; /** * The git token id on Qovery side * @type {string} * @memberof HelmGitRepositoryRequest */ 'git_token_id'?: string | null; } /** * * @export * @enum {string} */ export declare const HelmPortProtocolEnum: { readonly HTTP: "HTTP"; readonly GRPC: "GRPC"; }; export type HelmPortProtocolEnum = typeof HelmPortProtocolEnum[keyof typeof HelmPortProtocolEnum]; /** * * @export * @interface HelmPortRequest */ export interface HelmPortRequest { /** * * @type {Array} * @memberof HelmPortRequest */ 'ports'?: Array; } /** * * @export * @interface HelmPortRequestPortsInner */ export interface HelmPortRequestPortsInner { /** * * @type {string} * @memberof HelmPortRequestPortsInner */ 'name'?: string; /** * The listening port of your service. * @type {number} * @memberof HelmPortRequestPortsInner */ 'internal_port': number; /** * The exposed port for your service. This is optional. If not set a default port will be used. * @type {number} * @memberof HelmPortRequestPortsInner */ 'external_port'?: number; /** * * @type {string} * @memberof HelmPortRequestPortsInner */ 'namespace'?: string; /** * * @type {HelmPortProtocolEnum} * @memberof HelmPortRequestPortsInner */ 'protocol'?: HelmPortProtocolEnum; /** * is the default port to use for domain * @type {boolean} * @memberof HelmPortRequestPortsInner */ 'is_default'?: boolean; /** * * @type {Array} * @memberof HelmPortRequestPortsInner */ 'service_selectors'?: Array; /** * * @type {string} * @memberof HelmPortRequestPortsInner */ 'service_name'?: string; } /** * * @export * @interface HelmPortRequestPortsInnerAllOfOneOf */ export interface HelmPortRequestPortsInnerAllOfOneOf { /** * * @type {Array} * @memberof HelmPortRequestPortsInnerAllOfOneOf */ 'service_selectors'?: Array; } /** * * @export * @interface HelmPortRequestPortsInnerAllOfOneOf1 */ export interface HelmPortRequestPortsInnerAllOfOneOf1 { /** * * @type {string} * @memberof HelmPortRequestPortsInnerAllOfOneOf1 */ 'service_name'?: string; } /** * * @export * @interface HelmPortResponseBase */ export interface HelmPortResponseBase { /** * * @type {string} * @memberof HelmPortResponseBase */ 'id': string; /** * * @type {string} * @memberof HelmPortResponseBase */ 'port_type': string; /** * * @type {string} * @memberof HelmPortResponseBase */ 'name'?: string; /** * The listening port of your service. * @type {number} * @memberof HelmPortResponseBase */ 'internal_port': number; /** * The exposed port for your service. This is optional. If not set a default port will be used. * @type {number} * @memberof HelmPortResponseBase */ 'external_port'?: number; /** * * @type {string} * @memberof HelmPortResponseBase */ 'namespace'?: string; /** * * @type {HelmPortProtocolEnum} * @memberof HelmPortResponseBase */ 'protocol': HelmPortProtocolEnum; /** * is the default port to use for domain * @type {boolean} * @memberof HelmPortResponseBase */ 'is_default'?: boolean; } /** * * @export * @interface HelmPortResponseWithServiceName */ export interface HelmPortResponseWithServiceName { /** * * @type {string} * @memberof HelmPortResponseWithServiceName */ 'id': string; /** * * @type {string} * @memberof HelmPortResponseWithServiceName */ 'port_type': string; /** * * @type {string} * @memberof HelmPortResponseWithServiceName */ 'name'?: string; /** * The listening port of your service. * @type {number} * @memberof HelmPortResponseWithServiceName */ 'internal_port': number; /** * The exposed port for your service. This is optional. If not set a default port will be used. * @type {number} * @memberof HelmPortResponseWithServiceName */ 'external_port'?: number; /** * * @type {string} * @memberof HelmPortResponseWithServiceName */ 'namespace'?: string; /** * * @type {HelmPortProtocolEnum} * @memberof HelmPortResponseWithServiceName */ 'protocol': HelmPortProtocolEnum; /** * is the default port to use for domain * @type {boolean} * @memberof HelmPortResponseWithServiceName */ 'is_default'?: boolean; /** * * @type {string} * @memberof HelmPortResponseWithServiceName */ 'service_name': string; } /** * * @export * @interface HelmPortResponseWithServiceSelectors */ export interface HelmPortResponseWithServiceSelectors { /** * * @type {string} * @memberof HelmPortResponseWithServiceSelectors */ 'id': string; /** * * @type {string} * @memberof HelmPortResponseWithServiceSelectors */ 'port_type': string; /** * * @type {string} * @memberof HelmPortResponseWithServiceSelectors */ 'name'?: string; /** * The listening port of your service. * @type {number} * @memberof HelmPortResponseWithServiceSelectors */ 'internal_port': number; /** * The exposed port for your service. This is optional. If not set a default port will be used. * @type {number} * @memberof HelmPortResponseWithServiceSelectors */ 'external_port'?: number; /** * * @type {string} * @memberof HelmPortResponseWithServiceSelectors */ 'namespace'?: string; /** * * @type {HelmPortProtocolEnum} * @memberof HelmPortResponseWithServiceSelectors */ 'protocol': HelmPortProtocolEnum; /** * is the default port to use for domain * @type {boolean} * @memberof HelmPortResponseWithServiceSelectors */ 'is_default'?: boolean; /** * * @type {Array} * @memberof HelmPortResponseWithServiceSelectors */ 'service_selectors': Array; } /** * * @export * @enum {string} */ export declare const HelmRepositoryAssociatedServiceType: { readonly HELM: "HELM"; }; export type HelmRepositoryAssociatedServiceType = typeof HelmRepositoryAssociatedServiceType[keyof typeof HelmRepositoryAssociatedServiceType]; /** * * @export * @interface HelmRepositoryAssociatedServicesResponse */ export interface HelmRepositoryAssociatedServicesResponse { /** * * @type {string} * @memberof HelmRepositoryAssociatedServicesResponse */ 'project_id': string; /** * * @type {string} * @memberof HelmRepositoryAssociatedServicesResponse */ 'project_name': string; /** * * @type {string} * @memberof HelmRepositoryAssociatedServicesResponse */ 'environment_id': string; /** * * @type {string} * @memberof HelmRepositoryAssociatedServicesResponse */ 'environment_name': string; /** * * @type {string} * @memberof HelmRepositoryAssociatedServicesResponse */ 'service_id': string; /** * * @type {string} * @memberof HelmRepositoryAssociatedServicesResponse */ 'service_name': string; /** * * @type {HelmRepositoryAssociatedServiceType} * @memberof HelmRepositoryAssociatedServicesResponse */ 'service_type': HelmRepositoryAssociatedServiceType; } /** * * @export * @interface HelmRepositoryAssociatedServicesResponseList */ export interface HelmRepositoryAssociatedServicesResponseList { /** * * @type {Array} * @memberof HelmRepositoryAssociatedServicesResponseList */ 'results'?: Array; } /** * The type of your helm repository * @export * @enum {string} */ export declare const HelmRepositoryKindEnum: { readonly HTTPS: "HTTPS"; readonly OCI_ECR: "OCI_ECR"; readonly OCI_SCALEWAY_CR: "OCI_SCALEWAY_CR"; readonly OCI_DOCKER_HUB: "OCI_DOCKER_HUB"; readonly OCI_PUBLIC_ECR: "OCI_PUBLIC_ECR"; readonly OCI_GENERIC_CR: "OCI_GENERIC_CR"; readonly OCI_GITHUB_CR: "OCI_GITHUB_CR"; readonly OCI_GITLAB_CR: "OCI_GITLAB_CR"; }; export type HelmRepositoryKindEnum = typeof HelmRepositoryKindEnum[keyof typeof HelmRepositoryKindEnum]; /** * * @export * @interface HelmRepositoryRequest */ export interface HelmRepositoryRequest { /** * * @type {string} * @memberof HelmRepositoryRequest */ 'name': string; /** * * @type {HelmRepositoryKindEnum} * @memberof HelmRepositoryRequest */ 'kind': HelmRepositoryKindEnum; /** * * @type {string} * @memberof HelmRepositoryRequest */ 'description'?: string; /** * URL of the helm chart repository: * For `OCI`: it must start by oci:// * For `HTTPS`: it must be start by https:// * @type {string} * @memberof HelmRepositoryRequest */ 'url'?: string; /** * Bypass tls certificate verification when connecting to repository * @type {boolean} * @memberof HelmRepositoryRequest */ 'skip_tls_verification': boolean; /** * * @type {HelmRepositoryRequestConfig} * @memberof HelmRepositoryRequest */ 'config': HelmRepositoryRequestConfig; } /** * * @export * @interface HelmRepositoryRequestConfig */ export interface HelmRepositoryRequestConfig { /** * Required if the repository is private * @type {string} * @memberof HelmRepositoryRequestConfig */ 'username'?: string; /** * Required if the repository is private * @type {string} * @memberof HelmRepositoryRequestConfig */ 'password'?: string; /** * Required if kind is `ECR` or `PUBLIC_ECR` * @type {string} * @memberof HelmRepositoryRequestConfig */ 'access_key_id'?: string; /** * Required if kind is `ECR` or `PUBLIC_ECR` * @type {string} * @memberof HelmRepositoryRequestConfig */ 'secret_access_key'?: string; /** * Required if kind is `ECR` or `SCALEWAY_CR` * @type {string} * @memberof HelmRepositoryRequestConfig */ 'region'?: string; /** * Required if kind is `SCALEWAY_CR` * @type {string} * @memberof HelmRepositoryRequestConfig */ 'scaleway_access_key'?: string; /** * Required if kind is `SCALEWAY_CR` * @type {string} * @memberof HelmRepositoryRequestConfig */ 'scaleway_secret_key'?: string; /** * Required if kind is `SCALEWAY_CR` * @type {string} * @memberof HelmRepositoryRequestConfig */ 'scaleway_project_id'?: string; /** * Required if kind is `AZURE_CR`. * @type {string} * @memberof HelmRepositoryRequestConfig */ 'azure_tenant_id'?: string; /** * Required if kind is `AZURE_CR`. * @type {string} * @memberof HelmRepositoryRequestConfig */ 'azure_subscription_id'?: string; /** * For ECR, you can either set a static access_key or use a role arn that we are going to assume * @type {string} * @memberof HelmRepositoryRequestConfig */ 'role_arn'?: string; } /** * * @export * @interface HelmRepositoryResponse */ export interface HelmRepositoryResponse { /** * * @type {string} * @memberof HelmRepositoryResponse */ 'id': string; /** * * @type {string} * @memberof HelmRepositoryResponse */ 'created_at': string; /** * * @type {string} * @memberof HelmRepositoryResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof HelmRepositoryResponse */ 'name': string; /** * * @type {HelmRepositoryKindEnum} * @memberof HelmRepositoryResponse */ 'kind'?: HelmRepositoryKindEnum; /** * * @type {string} * @memberof HelmRepositoryResponse */ 'description'?: string; /** * URL of the helm repository * @type {string} * @memberof HelmRepositoryResponse */ 'url'?: string; /** * Bypass tls certificate verification when connecting to repository * @type {boolean} * @memberof HelmRepositoryResponse */ 'skip_tls_verification'?: boolean; /** * The number of services using this helm repository * @type {number} * @memberof HelmRepositoryResponse */ 'associated_services_count'?: number; /** * * @type {HelmRepositoryResponseAllOfConfig} * @memberof HelmRepositoryResponse */ 'config'?: HelmRepositoryResponseAllOfConfig; } /** * * @export * @interface HelmRepositoryResponseAllOfConfig */ export interface HelmRepositoryResponseAllOfConfig { /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'username'?: string; /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'region'?: string; /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'access_key_id'?: string; /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'role_arn'?: string; /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'scaleway_access_key'?: string; /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'scaleway_project_id'?: string; /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'azure_tenant_id'?: string; /** * * @type {string} * @memberof HelmRepositoryResponseAllOfConfig */ 'azure_subscription_id'?: string; } /** * * @export * @interface HelmRepositoryResponseList */ export interface HelmRepositoryResponseList { /** * * @type {Array} * @memberof HelmRepositoryResponseList */ 'results'?: Array; } /** * * @export * @interface HelmRequest */ export interface HelmRequest { /** * * @type {Array} * @memberof HelmRequest */ 'ports'?: Array; /** * name is case insensitive * @type {string} * @memberof HelmRequest */ 'name': string; /** * * @type {string} * @memberof HelmRequest */ 'description'?: string; /** * Maximum number of seconds allowed for helm to run before killing it and mark it as failed * @type {number} * @memberof HelmRequest */ 'timeout_sec'?: number; /** * Indicates if the \'environment preview option\' is enabled. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called or when a new commit is updated. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof HelmRequest */ 'auto_preview'?: boolean | null; /** * Specify if the helm will be automatically updated after receiving a new image tag or a new commit according to the source type. * @type {boolean} * @memberof HelmRequest */ 'auto_deploy': boolean; /** * * @type {HelmRequestAllOfSource} * @memberof HelmRequest */ 'source': HelmRequestAllOfSource; /** * The extra arguments to pass to helm * @type {Array} * @memberof HelmRequest */ 'arguments': Array; /** * If we should allow the chart to deploy object outside his specified namespace. Setting this flag to true, requires special rights * @type {boolean} * @memberof HelmRequest */ 'allow_cluster_wide_resources'?: boolean; /** * * @type {HelmRequestAllOfValuesOverride} * @memberof HelmRequest */ 'values_override': HelmRequestAllOfValuesOverride; /** * Icon URI representing the helm service. * @type {string} * @memberof HelmRequest */ 'icon_uri'?: string; } /** * @type HelmRequestAllOfSource * @export */ export type HelmRequestAllOfSource = HelmRequestAllOfSourceOneOf | HelmRequestAllOfSourceOneOf1; /** * * @export * @interface HelmRequestAllOfSourceOneOf */ export interface HelmRequestAllOfSourceOneOf { /** * * @type {HelmGitRepositoryRequest} * @memberof HelmRequestAllOfSourceOneOf */ 'git_repository'?: HelmGitRepositoryRequest; } /** * * @export * @interface HelmRequestAllOfSourceOneOf1 */ export interface HelmRequestAllOfSourceOneOf1 { /** * * @type {HelmRequestAllOfSourceOneOf1HelmRepository} * @memberof HelmRequestAllOfSourceOneOf1 */ 'helm_repository'?: HelmRequestAllOfSourceOneOf1HelmRepository; } /** * * @export * @interface HelmRequestAllOfSourceOneOf1HelmRepository */ export interface HelmRequestAllOfSourceOneOf1HelmRepository { /** * The id of the helm repository * @type {string} * @memberof HelmRequestAllOfSourceOneOf1HelmRepository */ 'repository'?: string | null; /** * The name of the chart in the repository * @type {string} * @memberof HelmRequestAllOfSourceOneOf1HelmRepository */ 'chart_name'?: string; /** * The version of the chart to use * @type {string} * @memberof HelmRequestAllOfSourceOneOf1HelmRepository */ 'chart_version'?: string; } /** * Specify helm values you want to set or override * @export * @interface HelmRequestAllOfValuesOverride */ export interface HelmRequestAllOfValuesOverride { /** * The input is in json array format: [ [$KEY,$VALUE], [...] ] * @type {Array>} * @memberof HelmRequestAllOfValuesOverride */ 'set'?: Array>; /** * The input is in json array format: [ [$KEY,$VALUE], [...] ] * @type {Array>} * @memberof HelmRequestAllOfValuesOverride */ 'set_string'?: Array>; /** * The input is in json array format: [ [$KEY,$VALUE], [...] ] * @type {Array>} * @memberof HelmRequestAllOfValuesOverride */ 'set_json'?: Array>; /** * * @type {HelmRequestAllOfValuesOverrideFile} * @memberof HelmRequestAllOfValuesOverride */ 'file'?: HelmRequestAllOfValuesOverrideFile | null; } /** * * @export * @interface HelmRequestAllOfValuesOverrideFile */ export interface HelmRequestAllOfValuesOverrideFile { /** * * @type {HelmRequestAllOfValuesOverrideFileGit} * @memberof HelmRequestAllOfValuesOverrideFile */ 'git'?: HelmRequestAllOfValuesOverrideFileGit | null; /** * * @type {HelmRequestAllOfValuesOverrideFileRaw} * @memberof HelmRequestAllOfValuesOverrideFile */ 'raw'?: HelmRequestAllOfValuesOverrideFileRaw | null; } /** * * @export * @interface HelmRequestAllOfValuesOverrideFileGit */ export interface HelmRequestAllOfValuesOverrideFileGit { /** * * @type {ApplicationGitRepositoryRequest} * @memberof HelmRequestAllOfValuesOverrideFileGit */ 'git_repository': ApplicationGitRepositoryRequest; /** * List of path inside your git repository to locate values file. Must start by a / * @type {Array} * @memberof HelmRequestAllOfValuesOverrideFileGit */ 'paths': Array; } /** * * @export * @interface HelmRequestAllOfValuesOverrideFileRaw */ export interface HelmRequestAllOfValuesOverrideFileRaw { /** * * @type {Array} * @memberof HelmRequestAllOfValuesOverrideFileRaw */ 'values'?: Array; } /** * * @export * @interface HelmRequestAllOfValuesOverrideFileRawValues */ export interface HelmRequestAllOfValuesOverrideFileRawValues { /** * The name of the value file * @type {string} * @memberof HelmRequestAllOfValuesOverrideFileRawValues */ 'name'?: string; /** * The content of the value file * @type {string} * @memberof HelmRequestAllOfValuesOverrideFileRawValues */ 'content'?: string; } /** * * @export * @interface HelmResponse */ export interface HelmResponse { /** * * @type {string} * @memberof HelmResponse */ 'id': string; /** * * @type {string} * @memberof HelmResponse */ 'created_at': string; /** * * @type {string} * @memberof HelmResponse */ 'updated_at'?: string; /** * * @type {ReferenceObject} * @memberof HelmResponse */ 'environment': ReferenceObject; /** * name is case insensitive * @type {string} * @memberof HelmResponse */ 'name': string; /** * * @type {string} * @memberof HelmResponse */ 'description'?: string; /** * Maximum number of seconds allowed for helm to run before killing it and mark it as failed * @type {number} * @memberof HelmResponse */ 'timeout_sec'?: number; /** * Indicates if the \'environment preview option\' is enabled. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof HelmResponse */ 'auto_preview': boolean; /** * Specify if the service will be automatically updated after receiving a new image tag or a new commit according to the source type. * @type {boolean} * @memberof HelmResponse */ 'auto_deploy': boolean; /** * * @type {Array} * @memberof HelmResponse */ 'ports'?: Array; /** * * @type {HelmResponseAllOfSource} * @memberof HelmResponse */ 'source': HelmResponseAllOfSource; /** * The extra arguments to pass to helm * @type {Array} * @memberof HelmResponse */ 'arguments': Array; /** * If we should allow the chart to deploy object outside his specified namespace. Setting this flag to true, requires special rights * @type {boolean} * @memberof HelmResponse */ 'allow_cluster_wide_resources': boolean; /** * * @type {HelmResponseAllOfValuesOverride} * @memberof HelmResponse */ 'values_override': HelmResponseAllOfValuesOverride; /** * Icon URI representing the helm service. * @type {string} * @memberof HelmResponse */ 'icon_uri': string; /** * * @type {ServiceTypeEnum} * @memberof HelmResponse */ 'service_type': ServiceTypeEnum; } /** * @type HelmResponseAllOfPorts * @export */ export type HelmResponseAllOfPorts = { port_type: 'SERVICE_NAME'; } & HelmPortResponseWithServiceName | { port_type: 'SERVICE_SELECTORS'; } & HelmPortResponseWithServiceSelectors; /** * @type HelmResponseAllOfSource * @export */ export type HelmResponseAllOfSource = HelmResponseAllOfSourceOneOf | HelmResponseAllOfSourceOneOf1; /** * * @export * @interface HelmResponseAllOfSourceOneOf */ export interface HelmResponseAllOfSourceOneOf { /** * * @type {HelmSourceGitResponse} * @memberof HelmResponseAllOfSourceOneOf */ 'git': HelmSourceGitResponse; } /** * * @export * @interface HelmResponseAllOfSourceOneOf1 */ export interface HelmResponseAllOfSourceOneOf1 { /** * * @type {HelmSourceRepositoryResponse} * @memberof HelmResponseAllOfSourceOneOf1 */ 'repository': HelmSourceRepositoryResponse; } /** * Specify helm values you want to set or override * @export * @interface HelmResponseAllOfValuesOverride */ export interface HelmResponseAllOfValuesOverride { /** * The input is in json array format: [ [$KEY,$VALUE], [...] ] * @type {Array>} * @memberof HelmResponseAllOfValuesOverride */ 'set'?: Array>; /** * The input is in json array format: [ [$KEY,$VALUE], [...] ] * @type {Array>} * @memberof HelmResponseAllOfValuesOverride */ 'set_string'?: Array>; /** * The input is in json array format: [ [$KEY,$VALUE], [...] ] * @type {Array>} * @memberof HelmResponseAllOfValuesOverride */ 'set_json'?: Array>; /** * * @type {HelmResponseAllOfValuesOverrideFile} * @memberof HelmResponseAllOfValuesOverride */ 'file'?: HelmResponseAllOfValuesOverrideFile | null; } /** * * @export * @interface HelmResponseAllOfValuesOverrideFile */ export interface HelmResponseAllOfValuesOverrideFile { /** * * @type {HelmResponseAllOfValuesOverrideFileRaw} * @memberof HelmResponseAllOfValuesOverrideFile */ 'raw'?: HelmResponseAllOfValuesOverrideFileRaw | null; /** * * @type {HelmResponseAllOfValuesOverrideFileGit} * @memberof HelmResponseAllOfValuesOverrideFile */ 'git'?: HelmResponseAllOfValuesOverrideFileGit | null; } /** * * @export * @interface HelmResponseAllOfValuesOverrideFileGit */ export interface HelmResponseAllOfValuesOverrideFileGit { /** * * @type {ApplicationGitRepository} * @memberof HelmResponseAllOfValuesOverrideFileGit */ 'git_repository': ApplicationGitRepository; /** * List of path inside your git repository to locate values file. Must start by a / * @type {Array} * @memberof HelmResponseAllOfValuesOverrideFileGit */ 'paths': Array; } /** * * @export * @interface HelmResponseAllOfValuesOverrideFileRaw */ export interface HelmResponseAllOfValuesOverrideFileRaw { /** * * @type {Array} * @memberof HelmResponseAllOfValuesOverrideFileRaw */ 'values': Array; } /** * * @export * @interface HelmResponseAllOfValuesOverrideFileRawValues */ export interface HelmResponseAllOfValuesOverrideFileRawValues { /** * The name of the value file * @type {string} * @memberof HelmResponseAllOfValuesOverrideFileRawValues */ 'name': string; /** * The content of the value file * @type {string} * @memberof HelmResponseAllOfValuesOverrideFileRawValues */ 'content': string; } /** * * @export * @interface HelmResponseList */ export interface HelmResponseList { /** * * @type {Array} * @memberof HelmResponseList */ 'results'?: Array; } /** * * @export * @interface HelmSourceGitResponse */ export interface HelmSourceGitResponse { /** * * @type {ApplicationGitRepository} * @memberof HelmSourceGitResponse */ 'git_repository': ApplicationGitRepository; } /** * * @export * @interface HelmSourceRepositoryResponse */ export interface HelmSourceRepositoryResponse { /** * * @type {string} * @memberof HelmSourceRepositoryResponse */ 'chart_name': string; /** * * @type {string} * @memberof HelmSourceRepositoryResponse */ 'chart_version': string; /** * * @type {HelmSourceRepositoryResponseRepository} * @memberof HelmSourceRepositoryResponse */ 'repository': HelmSourceRepositoryResponseRepository; } /** * * @export * @interface HelmSourceRepositoryResponseRepository */ export interface HelmSourceRepositoryResponseRepository { /** * * @type {string} * @memberof HelmSourceRepositoryResponseRepository */ 'id': string; /** * * @type {string} * @memberof HelmSourceRepositoryResponseRepository */ 'name': string; /** * * @type {string} * @memberof HelmSourceRepositoryResponseRepository */ 'url': string; } /** * * @export * @interface HelmVersionResponse */ export interface HelmVersionResponse { /** * * @type {string} * @memberof HelmVersionResponse */ 'chart_name'?: string; /** * * @type {Array} * @memberof HelmVersionResponse */ 'versions'?: Array; } /** * * @export * @interface HelmVersionResponseList */ export interface HelmVersionResponseList { /** * * @type {Array} * @memberof HelmVersionResponseList */ 'results'?: Array; } /** * @type InfrastructureOutputs * @export */ export type InfrastructureOutputs = { kind: 'AKS'; } & AksInfrastructureOutputs | { kind: 'EKS'; } & EksInfrastructureOutputs | { kind: 'GKE'; } & GkeInfrastructureOutputs | { kind: 'SCW_KAPSULE'; } & KapsuleInfrastructureOutputs; /** * * @export * @interface IngressDeploymentStatusResponse */ export interface IngressDeploymentStatusResponse { /** * * @type {string} * @memberof IngressDeploymentStatusResponse */ 'routerId'?: string; /** * * @type {StateEnum} * @memberof IngressDeploymentStatusResponse */ 'status'?: StateEnum; } /** * * @export * @interface InternalNetworkMonitoring */ export interface InternalNetworkMonitoring { /** * * @type {boolean} * @memberof InternalNetworkMonitoring */ 'enabled': boolean; } /** * * @export * @interface InviteMember */ export interface InviteMember { /** * * @type {string} * @memberof InviteMember */ 'id': string; /** * * @type {string} * @memberof InviteMember */ 'created_at': string; /** * * @type {string} * @memberof InviteMember */ 'updated_at'?: string; /** * * @type {string} * @memberof InviteMember */ 'email': string; /** * * @type {InviteMemberRoleEnum} * @memberof InviteMember */ 'role': InviteMemberRoleEnum; /** * * @type {string} * @memberof InviteMember */ 'invitation_link': string; /** * * @type {InviteStatusEnum} * @memberof InviteMember */ 'invitation_status': InviteStatusEnum; /** * * @type {string} * @memberof InviteMember */ 'organization_name'?: string; /** * * @type {string} * @memberof InviteMember */ 'inviter': string; /** * * @type {string} * @memberof InviteMember */ 'logo_url'?: string; /** * * @type {string} * @memberof InviteMember */ 'role_id'?: string; /** * * @type {string} * @memberof InviteMember */ 'role_name'?: string; } /** * * @export * @interface InviteMemberRequest */ export interface InviteMemberRequest { /** * * @type {string} * @memberof InviteMemberRequest */ 'email': string; /** * * @type {InviteMemberRoleEnum} * @memberof InviteMemberRequest */ 'role'?: InviteMemberRoleEnum; /** * the target role to attribute to the new member * @type {string} * @memberof InviteMemberRequest */ 'role_id'?: string; } /** * * @export * @interface InviteMemberResponseList */ export interface InviteMemberResponseList { /** * * @type {Array} * @memberof InviteMemberResponseList */ 'results'?: Array; } /** * deprecated * @export * @enum {string} */ export declare const InviteMemberRoleEnum: { readonly ADMIN: "ADMIN"; readonly DEVELOPER: "DEVELOPER"; readonly OWNER: "OWNER"; readonly VIEWER: "VIEWER"; }; export type InviteMemberRoleEnum = typeof InviteMemberRoleEnum[keyof typeof InviteMemberRoleEnum]; /** * * @export * @enum {string} */ export declare const InviteStatusEnum: { readonly EXPIRED: "EXPIRED"; readonly PENDING: "PENDING"; }; export type InviteStatusEnum = typeof InviteStatusEnum[keyof typeof InviteStatusEnum]; /** * * @export * @interface Invoice */ export interface Invoice { /** * * @type {number} * @memberof Invoice */ 'total_in_cents': number; /** * * @type {number} * @memberof Invoice */ 'total': number; /** * * @type {string} * @memberof Invoice */ 'currency_code': string; /** * * @type {string} * @memberof Invoice */ 'id': string; /** * * @type {string} * @memberof Invoice */ 'created_at': string; /** * * @type {InvoiceStatusEnum} * @memberof Invoice */ 'status': InvoiceStatusEnum; } /** * * @export * @interface InvoiceResponseList */ export interface InvoiceResponseList { /** * * @type {Array} * @memberof InvoiceResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const InvoiceStatusEnum: { readonly NOT_PAID: "NOT_PAID"; readonly PAID: "PAID"; readonly PAYMENT_DUE: "PAYMENT_DUE"; readonly PENDING: "PENDING"; readonly POSTED: "POSTED"; readonly UNKNOWN: "UNKNOWN"; readonly VOIDED: "VOIDED"; }; export type InvoiceStatusEnum = typeof InvoiceStatusEnum[keyof typeof InvoiceStatusEnum]; /** * * @export * @interface JobAdvancedSettings */ export interface JobAdvancedSettings { /** * define the max timeout for the build * @type {number} * @memberof JobAdvancedSettings */ 'build.timeout_max_sec'?: number; /** * define the max cpu resources (in milli) * @type {number} * @memberof JobAdvancedSettings */ 'build.cpu_max_in_milli'?: number; /** * define the max ram resources (in gib) * @type {number} * @memberof JobAdvancedSettings */ 'build.ram_max_in_gib'?: number; /** * disable buildkit registry cache during build * @type {boolean} * @memberof JobAdvancedSettings */ 'build.disable_buildkit_cache'?: boolean; /** * define how long in seconds an application is supposed to be stopped gracefully * @type {number} * @memberof JobAdvancedSettings */ 'deployment.termination_grace_period_seconds'?: number; /** * Set pod placement on specific Kubernetes nodes labels * @type {{ [key: string]: string; }} * @memberof JobAdvancedSettings */ 'deployment.affinity.node.required'?: { [key: string]: string; }; /** * * @type {number} * @memberof JobAdvancedSettings */ 'job.delete_ttl_seconds_after_finished'?: number | null; /** * * @type {string} * @memberof JobAdvancedSettings */ 'cronjob.concurrency_policy'?: string; /** * * @type {number} * @memberof JobAdvancedSettings */ 'cronjob.failed_jobs_history_limit'?: number; /** * * @type {number} * @memberof JobAdvancedSettings */ 'cronjob.success_jobs_history_limit'?: number; /** * Allows you to set an existing Kubernetes service account name * @type {string} * @memberof JobAdvancedSettings */ 'security.service_account_name'?: string; /** * Automount Kubernetes service account token to have access to Kubernetes API from pods * @type {boolean} * @memberof JobAdvancedSettings */ 'security.automount_service_account_token'?: boolean; /** * Mounts the container\'s root filesystem as read-only * @type {boolean} * @memberof JobAdvancedSettings */ 'security.read_only_root_filesystem'?: boolean; } /** * * @export * @interface JobCronSchedule */ export interface JobCronSchedule { /** * * @type {Array} * @memberof JobCronSchedule */ 'arguments': Array; /** * * @type {string} * @memberof JobCronSchedule */ 'entrypoint'?: string; /** * * @type {string} * @memberof JobCronSchedule */ 'scheduled_at': string; /** * * @type {string} * @memberof JobCronSchedule */ 'timezone': string; } /** * * @export * @interface JobDeployRequest */ export interface JobDeployRequest { /** * Image tag to deploy. Cannot be set if `git_commit_id` is defined * @type {string} * @memberof JobDeployRequest */ 'image_tag'?: string; /** * Commit to deploy Cannot be set if `image_tag` is defined * @type {string} * @memberof JobDeployRequest */ 'git_commit_id'?: string; } /** * * @export * @interface JobDeploymentRestrictionRequest */ export interface JobDeploymentRestrictionRequest { /** * * @type {DeploymentRestrictionModeEnum} * @memberof JobDeploymentRestrictionRequest */ 'mode': DeploymentRestrictionModeEnum; /** * * @type {DeploymentRestrictionTypeEnum} * @memberof JobDeploymentRestrictionRequest */ 'type': DeploymentRestrictionTypeEnum; /** * For `PATH` restrictions, the value must not start with `/` * @type {string} * @memberof JobDeploymentRestrictionRequest */ 'value': string; } /** * * @export * @interface JobDeploymentRestrictionResponse */ export interface JobDeploymentRestrictionResponse { /** * * @type {string} * @memberof JobDeploymentRestrictionResponse */ 'id': string; /** * * @type {string} * @memberof JobDeploymentRestrictionResponse */ 'created_at': string; /** * * @type {string} * @memberof JobDeploymentRestrictionResponse */ 'updated_at'?: string; /** * * @type {DeploymentRestrictionModeEnum} * @memberof JobDeploymentRestrictionResponse */ 'mode': DeploymentRestrictionModeEnum; /** * * @type {DeploymentRestrictionTypeEnum} * @memberof JobDeploymentRestrictionResponse */ 'type': DeploymentRestrictionTypeEnum; /** * For `PATH` restrictions, the value must not start with `/` * @type {string} * @memberof JobDeploymentRestrictionResponse */ 'value': string; } /** * * @export * @interface JobDeploymentRestrictionResponseList */ export interface JobDeploymentRestrictionResponseList { /** * * @type {Array} * @memberof JobDeploymentRestrictionResponseList */ 'results'?: Array; } /** * * @export * @enum {string} */ export declare const JobForceEvent: { readonly START: "START"; readonly STOP: "STOP"; readonly DELETE: "DELETE"; readonly CRON: "CRON"; }; export type JobForceEvent = typeof JobForceEvent[keyof typeof JobForceEvent]; /** * * @export * @enum {string} */ export declare const JobLifecycleTypeEnum: { readonly GENERIC: "GENERIC"; readonly TERRAFORM: "TERRAFORM"; readonly CLOUDFORMATION: "CLOUDFORMATION"; }; export type JobLifecycleTypeEnum = typeof JobLifecycleTypeEnum[keyof typeof JobLifecycleTypeEnum]; /** * * @export * @interface JobLifecyleSchedule */ export interface JobLifecyleSchedule { /** * * @type {Array} * @memberof JobLifecyleSchedule */ 'arguments': Array; /** * * @type {string} * @memberof JobLifecyleSchedule */ 'entrypoint'?: string; } /** * * @export * @interface JobRequest */ export interface JobRequest { /** * name is case insensitive * @type {string} * @memberof JobRequest */ 'name': string; /** * * @type {string} * @memberof JobRequest */ 'description'?: string; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof JobRequest */ 'cpu'?: number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof JobRequest */ 'memory'?: number; /** * * @type {number} * @memberof JobRequest */ 'gpu'?: number; /** * Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed * @type {number} * @memberof JobRequest */ 'max_nb_restart'?: number; /** * Maximum number of seconds allowed for the job to run before killing it and mark it as failed * @type {number} * @memberof JobRequest */ 'max_duration_seconds'?: number; /** * Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof JobRequest */ 'auto_preview'?: boolean; /** * Port where to run readiness and liveliness probes checks. The port will not be exposed externally * @type {number} * @memberof JobRequest */ 'port'?: number | null; /** * * @type {JobRequestAllOfSource} * @memberof JobRequest */ 'source'?: JobRequestAllOfSource; /** * * @type {Healthcheck} * @memberof JobRequest */ 'healthchecks': Healthcheck; /** * * @type {JobRequestAllOfSchedule} * @memberof JobRequest */ 'schedule'?: JobRequestAllOfSchedule; /** * Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the \"Auto Deploy job\" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments * @type {boolean} * @memberof JobRequest */ 'auto_deploy'?: boolean | null; /** * * @type {Array} * @memberof JobRequest */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof JobRequest */ 'labels_groups'?: Array; /** * Icon URI representing the job. * @type {string} * @memberof JobRequest */ 'icon_uri'?: string; } /** * If you want to define a Cron job, only the `cronjob` property must be filled A Lifecycle job should contain at least one property `on_XXX` among the 3 properties: `on_start`, `on_stop`, `on_delete` * @export * @interface JobRequestAllOfSchedule */ export interface JobRequestAllOfSchedule { /** * * @type {JobRequestAllOfScheduleOnStart} * @memberof JobRequestAllOfSchedule */ 'on_start'?: JobRequestAllOfScheduleOnStart; /** * * @type {JobRequestAllOfScheduleOnStart} * @memberof JobRequestAllOfSchedule */ 'on_stop'?: JobRequestAllOfScheduleOnStart; /** * * @type {JobRequestAllOfScheduleOnStart} * @memberof JobRequestAllOfSchedule */ 'on_delete'?: JobRequestAllOfScheduleOnStart; /** * * @type {JobRequestAllOfScheduleCronjob} * @memberof JobRequestAllOfSchedule */ 'cronjob'?: JobRequestAllOfScheduleCronjob; /** * * @type {JobLifecycleTypeEnum} * @memberof JobRequestAllOfSchedule */ 'lifecycle_type'?: JobLifecycleTypeEnum; } /** * * @export * @interface JobRequestAllOfScheduleCronjob */ export interface JobRequestAllOfScheduleCronjob { /** * * @type {Array} * @memberof JobRequestAllOfScheduleCronjob */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof JobRequestAllOfScheduleCronjob */ 'entrypoint'?: string; /** * Specify a timezone identifier to run the schedule at. By default Etc/UTC * @type {string} * @memberof JobRequestAllOfScheduleCronjob */ 'timezone'?: string; /** * Can only be set if the event is CRON. Represent the cron format for the job schedule without seconds. For example: `* * * * *` represent the cron to launch the job every minute. See https://crontab.guru/ to WISIWIG interface. Timezone is UTC * @type {string} * @memberof JobRequestAllOfScheduleCronjob */ 'scheduled_at': string; } /** * * @export * @interface JobRequestAllOfScheduleOnStart */ export interface JobRequestAllOfScheduleOnStart { /** * * @type {Array} * @memberof JobRequestAllOfScheduleOnStart */ 'arguments'?: Array; /** * optional entrypoint when launching container * @type {string} * @memberof JobRequestAllOfScheduleOnStart */ 'entrypoint'?: string; } /** * * @export * @interface JobRequestAllOfSource */ export interface JobRequestAllOfSource { /** * * @type {JobRequestAllOfSourceImage} * @memberof JobRequestAllOfSource */ 'image'?: JobRequestAllOfSourceImage | null; /** * * @type {JobRequestAllOfSourceDocker} * @memberof JobRequestAllOfSource */ 'docker'?: JobRequestAllOfSourceDocker | null; } /** * * @export * @interface JobRequestAllOfSourceDocker */ export interface JobRequestAllOfSourceDocker { /** * * @type {ApplicationGitRepositoryRequest} * @memberof JobRequestAllOfSourceDocker */ 'git_repository'?: ApplicationGitRepositoryRequest; /** * The path of the associated Dockerfile. Only if you are using build_mode = DOCKER * @type {string} * @memberof JobRequestAllOfSourceDocker */ 'dockerfile_path'?: string | null; /** * The content of your dockerfile if it is not stored inside your git repository * @type {string} * @memberof JobRequestAllOfSourceDocker */ 'dockerfile_raw'?: string | null; /** * The target build stage in the Dockerfile to build * @type {string} * @memberof JobRequestAllOfSourceDocker */ 'docker_target_build_stage'?: string | null; } /** * * @export * @interface JobRequestAllOfSourceImage */ export interface JobRequestAllOfSourceImage { /** * The image name pattern differs according to chosen container registry provider: * `ECR`: `repository` * `SCALEWAY_CR`: `namespace/image` * `DOCKER_HUB`: `image` or `repository/image` * `PUBLIC_ECR`: `registry_alias/repository` * @type {string} * @memberof JobRequestAllOfSourceImage */ 'image_name'?: string; /** * tag of the image container * @type {string} * @memberof JobRequestAllOfSourceImage */ 'tag'?: string; /** * tag of the image container * @type {string} * @memberof JobRequestAllOfSourceImage */ 'registry_id'?: string; } /** * @type JobResponse * @export */ export type JobResponse = { job_type: 'CRON'; } & CronJobResponse | { job_type: 'LIFECYCLE'; } & LifecycleJobResponse; /** * * @export * @interface JobResponseList */ export interface JobResponseList { /** * * @type {Array} * @memberof JobResponseList */ 'results'?: Array; } /** * On which event the job is going to run. ON_START means when a deployment is requested for the environment ON_STOP means when a stop of the environment is requested ON_DELETE means when an environment delete is requested CRON means at a scheduled interval * @export * @enum {string} */ export declare const JobScheduleEvent: { readonly ON_START: "ON_START"; readonly ON_STOP: "ON_STOP"; readonly ON_DELETE: "ON_DELETE"; readonly CRON: "CRON"; }; export type JobScheduleEvent = typeof JobScheduleEvent[keyof typeof JobScheduleEvent]; /** * * @export * @interface JobSourceDockerResponse */ export interface JobSourceDockerResponse { /** * * @type {ApplicationGitRepository} * @memberof JobSourceDockerResponse */ 'git_repository'?: ApplicationGitRepository; /** * The path of the associated Dockerfile. Only if you are using build_mode = DOCKER * @type {string} * @memberof JobSourceDockerResponse */ 'dockerfile_path'?: string | null; /** * The content of your dockerfile if it is not stored inside your git repository * @type {string} * @memberof JobSourceDockerResponse */ 'dockerfile_raw'?: string | null; /** * The target build stage in the Dockerfile to build * @type {string} * @memberof JobSourceDockerResponse */ 'docker_target_build_stage'?: string | null; } /** * type of job * @export * @enum {string} */ export declare const JobTypeEnum: { readonly LIFECYCLE: "LIFECYCLE"; readonly CRON: "CRON"; }; export type JobTypeEnum = typeof JobTypeEnum[keyof typeof JobTypeEnum]; /** * * @export * @interface KapsuleInfrastructureOutputs */ export interface KapsuleInfrastructureOutputs { /** * * @type {string} * @memberof KapsuleInfrastructureOutputs */ 'kind': KapsuleInfrastructureOutputsKindEnum; /** * * @type {string} * @memberof KapsuleInfrastructureOutputs */ 'cluster_name': string; } export declare const KapsuleInfrastructureOutputsKindEnum: { readonly SCW_KAPSULE: "SCW_KAPSULE"; }; export type KapsuleInfrastructureOutputsKindEnum = typeof KapsuleInfrastructureOutputsKindEnum[keyof typeof KapsuleInfrastructureOutputsKindEnum]; /** * * @export * @interface KarpenterCronjobNodePoolOverride */ export interface KarpenterCronjobNodePoolOverride { /** * * @type {KarpenterNodePoolConsolidation} * @memberof KarpenterCronjobNodePoolOverride */ 'consolidation'?: KarpenterNodePoolConsolidation; /** * * @type {KarpenterNodePoolLimits} * @memberof KarpenterCronjobNodePoolOverride */ 'limits'?: KarpenterNodePoolLimits; /** * Time to wait before consolidating empty or underutilized nodes (e.g., 1m, 10m, 1h). Maximum: 24h * @type {string} * @memberof KarpenterCronjobNodePoolOverride */ 'consolidate_after'?: string; } /** * * @export * @interface KarpenterDefaultNodePoolOverride */ export interface KarpenterDefaultNodePoolOverride { /** * * @type {KarpenterNodePoolLimits} * @memberof KarpenterDefaultNodePoolOverride */ 'limits'?: KarpenterNodePoolLimits; /** * Time to wait before consolidating empty or underutilized nodes (e.g., 1m, 10m, 1h). Maximum: 24h * @type {string} * @memberof KarpenterDefaultNodePoolOverride */ 'consolidate_after'?: string; } /** * * @export * @interface KarpenterGpuNodePoolOverride */ export interface KarpenterGpuNodePoolOverride { /** * * @type {KarpenterNodePoolConsolidation} * @memberof KarpenterGpuNodePoolOverride */ 'consolidation'?: KarpenterNodePoolConsolidation; /** * * @type {KarpenterNodePoolLimits} * @memberof KarpenterGpuNodePoolOverride */ 'limits'?: KarpenterNodePoolLimits; /** * * @type {Array} * @memberof KarpenterGpuNodePoolOverride */ 'requirements'?: Array; /** * * @type {number} * @memberof KarpenterGpuNodePoolOverride */ 'disk_size_in_gib'?: number; /** * Unit is operation/seconds. The disk IOPS to be used for the GPU node pool configuration * @type {number} * @memberof KarpenterGpuNodePoolOverride */ 'disk_iops'?: number; /** * Unit is in MB/s. The disk throughput to be used for the GPU node pool configuration * @type {number} * @memberof KarpenterGpuNodePoolOverride */ 'disk_throughput'?: number; /** * * @type {boolean} * @memberof KarpenterGpuNodePoolOverride */ 'spot_enabled'?: boolean; /** * Time to wait before consolidating empty or underutilized nodes (e.g., 1m, 10m, 1h). Maximum: 24h * @type {string} * @memberof KarpenterGpuNodePoolOverride */ 'consolidate_after'?: string; } /** * * @export * @interface KarpenterNodePool */ export interface KarpenterNodePool { /** * * @type {Array} * @memberof KarpenterNodePool */ 'requirements': Array; /** * * @type {KarpenterStableNodePoolOverride} * @memberof KarpenterNodePool */ 'stable_override'?: KarpenterStableNodePoolOverride; /** * * @type {KarpenterDefaultNodePoolOverride} * @memberof KarpenterNodePool */ 'default_override'?: KarpenterDefaultNodePoolOverride; /** * * @type {KarpenterGpuNodePoolOverride} * @memberof KarpenterNodePool */ 'gpu_override'?: KarpenterGpuNodePoolOverride; /** * * @type {KarpenterCronjobNodePoolOverride} * @memberof KarpenterNodePool */ 'cronjob_override'?: KarpenterCronjobNodePoolOverride; } /** * * @export * @interface KarpenterNodePoolConsolidation */ export interface KarpenterNodePoolConsolidation { /** * * @type {boolean} * @memberof KarpenterNodePoolConsolidation */ 'enabled': boolean; /** * * @type {Array} * @memberof KarpenterNodePoolConsolidation */ 'days': Array; /** * The start date of the consolidation. The format should follow ISO-8601 convention: \"PThh:mm\" * @type {string} * @memberof KarpenterNodePoolConsolidation */ 'start_time': string; /** * The duration during the consolidation will be active. The format should follow ISO-8601 convention: \"PThhHmmM\" * @type {string} * @memberof KarpenterNodePoolConsolidation */ 'duration': string; } /** * * @export * @interface KarpenterNodePoolLimits */ export interface KarpenterNodePoolLimits { /** * * @type {boolean} * @memberof KarpenterNodePoolLimits */ 'enabled': boolean; /** * CPU limit that will be applied for the node pool (in vCPU unit: 1 vCPU = 1000 millicores) * @type {number} * @memberof KarpenterNodePoolLimits */ 'max_cpu_in_vcpu': number; /** * Memory limit that will be applied for the node pool (in Gibibytes unit: 1Gi = 1024 mebibytes) * @type {number} * @memberof KarpenterNodePoolLimits */ 'max_memory_in_gibibytes': number; /** * GPU limit that will be applied for the node pool * @type {number} * @memberof KarpenterNodePoolLimits */ 'max_gpu': number; } /** * * @export * @interface KarpenterNodePoolRequirement */ export interface KarpenterNodePoolRequirement { /** * * @type {KarpenterNodePoolRequirementKey} * @memberof KarpenterNodePoolRequirement */ 'key': KarpenterNodePoolRequirementKey; /** * * @type {KarpenterNodePoolRequirementOperator} * @memberof KarpenterNodePoolRequirement */ 'operator': KarpenterNodePoolRequirementOperator; /** * * @type {Array} * @memberof KarpenterNodePoolRequirement */ 'values': Array; } /** * * @export * @enum {string} */ export declare const KarpenterNodePoolRequirementKey: { readonly INSTANCE_FAMILY: "InstanceFamily"; readonly INSTANCE_SIZE: "InstanceSize"; readonly ARCH: "Arch"; readonly SKU_FAMILY: "SkuFamily"; readonly SKU_VERSION: "SkuVersion"; }; export type KarpenterNodePoolRequirementKey = typeof KarpenterNodePoolRequirementKey[keyof typeof KarpenterNodePoolRequirementKey]; /** * * @export * @enum {string} */ export declare const KarpenterNodePoolRequirementOperator: { readonly IN: "In"; }; export type KarpenterNodePoolRequirementOperator = typeof KarpenterNodePoolRequirementOperator[keyof typeof KarpenterNodePoolRequirementOperator]; /** * * @export * @interface KarpenterStableNodePoolOverride */ export interface KarpenterStableNodePoolOverride { /** * * @type {KarpenterNodePoolConsolidation} * @memberof KarpenterStableNodePoolOverride */ 'consolidation'?: KarpenterNodePoolConsolidation; /** * * @type {KarpenterNodePoolLimits} * @memberof KarpenterStableNodePoolOverride */ 'limits'?: KarpenterNodePoolLimits; /** * Time to wait before consolidating empty or underutilized nodes (e.g., 1m, 10m, 1h). Maximum: 24h * @type {string} * @memberof KarpenterStableNodePoolOverride */ 'consolidate_after'?: string; } /** * * @export * @interface KedaAutoscalingRequest */ export interface KedaAutoscalingRequest { /** * * @type {AutoscalingMode} * @memberof KedaAutoscalingRequest */ 'mode': AutoscalingMode; /** * * @type {number} * @memberof KedaAutoscalingRequest */ 'polling_interval_seconds'?: number; /** * * @type {number} * @memberof KedaAutoscalingRequest */ 'cooldown_period_seconds'?: number; /** * * @type {Array} * @memberof KedaAutoscalingRequest */ 'scalers': Array; } /** * * @export * @interface KedaAutoscalingResponse */ export interface KedaAutoscalingResponse { /** * * @type {string} * @memberof KedaAutoscalingResponse */ 'id': string; /** * * @type {string} * @memberof KedaAutoscalingResponse */ 'created_at': string; /** * * @type {string} * @memberof KedaAutoscalingResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof KedaAutoscalingResponse */ 'service_id': string; /** * * @type {AutoscalingMode} * @memberof KedaAutoscalingResponse */ 'mode': AutoscalingMode; /** * * @type {number} * @memberof KedaAutoscalingResponse */ 'polling_interval_seconds': number; /** * * @type {number} * @memberof KedaAutoscalingResponse */ 'cooldown_period_seconds': number; /** * * @type {Array} * @memberof KedaAutoscalingResponse */ 'scalers': Array; } /** * * @export * @interface KedaScalerRequest */ export interface KedaScalerRequest { /** * * @type {string} * @memberof KedaScalerRequest */ 'scaler_type': string; /** * * @type {boolean} * @memberof KedaScalerRequest */ 'enabled'?: boolean; /** * * @type {KedaScalerRole} * @memberof KedaScalerRequest */ 'role': KedaScalerRole; /** * * @type {object} * @memberof KedaScalerRequest */ 'config_json'?: object; /** * * @type {string} * @memberof KedaScalerRequest */ 'config_yaml'?: string; /** * * @type {KedaTriggerAuthenticationRequest} * @memberof KedaScalerRequest */ 'trigger_authentication'?: KedaTriggerAuthenticationRequest; } /** * * @export * @interface KedaScalerResponse */ export interface KedaScalerResponse { /** * * @type {string} * @memberof KedaScalerResponse */ 'id': string; /** * * @type {string} * @memberof KedaScalerResponse */ 'created_at': string; /** * * @type {string} * @memberof KedaScalerResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof KedaScalerResponse */ 'scaler_type': string; /** * * @type {boolean} * @memberof KedaScalerResponse */ 'enabled': boolean; /** * * @type {KedaScalerRole} * @memberof KedaScalerResponse */ 'role': KedaScalerRole; /** * * @type {object} * @memberof KedaScalerResponse */ 'config_json'?: object | null; /** * * @type {string} * @memberof KedaScalerResponse */ 'config_yaml'?: string | null; /** * * @type {KedaTriggerAuthenticationResponse} * @memberof KedaScalerResponse */ 'trigger_authentication'?: KedaTriggerAuthenticationResponse; } /** * * @export * @enum {string} */ export declare const KedaScalerRole: { readonly PRIMARY: "PRIMARY"; readonly SAFETY: "SAFETY"; }; export type KedaScalerRole = typeof KedaScalerRole[keyof typeof KedaScalerRole]; /** * * @export * @interface KedaTriggerAuthenticationRequest */ export interface KedaTriggerAuthenticationRequest { /** * * @type {string} * @memberof KedaTriggerAuthenticationRequest */ 'name': string; /** * Optional raw KEDA TriggerAuthentication YAML configuration. * @type {string} * @memberof KedaTriggerAuthenticationRequest */ 'config_yaml'?: string; } /** * * @export * @interface KedaTriggerAuthenticationResponse */ export interface KedaTriggerAuthenticationResponse { /** * * @type {string} * @memberof KedaTriggerAuthenticationResponse */ 'id': string; /** * * @type {string} * @memberof KedaTriggerAuthenticationResponse */ 'created_at': string; /** * * @type {string} * @memberof KedaTriggerAuthenticationResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof KedaTriggerAuthenticationResponse */ 'organization_id': string; /** * * @type {string} * @memberof KedaTriggerAuthenticationResponse */ 'name': string; /** * Optional raw KEDA TriggerAuthentication YAML configuration. * @type {string} * @memberof KedaTriggerAuthenticationResponse */ 'config_yaml'?: string; } /** * * @export * @interface KedaTriggerAuthenticationResponseList */ export interface KedaTriggerAuthenticationResponseList { /** * * @type {Array} * @memberof KedaTriggerAuthenticationResponseList */ 'results'?: Array; } /** * * @export * @interface Key */ export interface Key { /** * * @type {string} * @memberof Key */ 'key': string; /** * optional variable description (255 characters maximum) * @type {string} * @memberof Key */ 'description'?: string | null; /** * * @type {boolean} * @memberof Key */ 'enable_interpolation_in_file'?: boolean | null; } /** * * @export * @enum {string} */ export declare const KubernetesEnum: { readonly MANAGED: "MANAGED"; readonly SELF_MANAGED: "SELF_MANAGED"; readonly PARTIALLY_MANAGED: "PARTIALLY_MANAGED"; }; export type KubernetesEnum = typeof KubernetesEnum[keyof typeof KubernetesEnum]; /** * * @export * @interface KubernetesMetadata */ export interface KubernetesMetadata { /** * * @type {string} * @memberof KubernetesMetadata */ 'name'?: string; } /** * * @export * @interface KubernetesSelector */ export interface KubernetesSelector { /** * * @type {string} * @memberof KubernetesSelector */ 'key': string; /** * * @type {string} * @memberof KubernetesSelector */ 'value': string; } /** * * @export * @interface KubernetesService */ export interface KubernetesService { /** * * @type {KubernetesMetadata} * @memberof KubernetesService */ 'metadata': KubernetesMetadata; /** * * @type {KubernetesServiceSpec} * @memberof KubernetesService */ 'service_spec': KubernetesServiceSpec; } /** * * @export * @interface KubernetesServicePort */ export interface KubernetesServicePort { /** * * @type {string} * @memberof KubernetesServicePort */ 'name'?: string; /** * * @type {number} * @memberof KubernetesServicePort */ 'port': number; } /** * * @export * @interface KubernetesServiceResponseList */ export interface KubernetesServiceResponseList { /** * * @type {Array} * @memberof KubernetesServiceResponseList */ 'results'?: Array; } /** * * @export * @interface KubernetesServiceSpec */ export interface KubernetesServiceSpec { /** * * @type {string} * @memberof KubernetesServiceSpec */ 'type'?: string; /** * * @type {Array} * @memberof KubernetesServiceSpec */ 'ports'?: Array; /** * * @type {Array} * @memberof KubernetesServiceSpec */ 'selectors'?: Array; } /** * * @export * @interface Label */ export interface Label { /** * * @type {string} * @memberof Label */ 'key': string; /** * * @type {string} * @memberof Label */ 'value': string; /** * * @type {boolean} * @memberof Label */ 'propagate_to_cloud_provider': boolean; } /** * Labels Group Associated Item Type * @export * @enum {string} */ export declare const LabelsGroupAssociatedItemType: { readonly APPLICATION: "APPLICATION"; readonly DATABASE: "DATABASE"; readonly CONTAINER: "CONTAINER"; readonly LIFECYCLE: "LIFECYCLE"; readonly ENVIRONMENT: "ENVIRONMENT"; readonly CLUSTER: "CLUSTER"; readonly CRON: "CRON"; }; export type LabelsGroupAssociatedItemType = typeof LabelsGroupAssociatedItemType[keyof typeof LabelsGroupAssociatedItemType]; /** * * @export * @interface LifecycleJobResponse */ export interface LifecycleJobResponse { /** * * @type {string} * @memberof LifecycleJobResponse */ 'id': string; /** * * @type {string} * @memberof LifecycleJobResponse */ 'created_at': string; /** * * @type {string} * @memberof LifecycleJobResponse */ 'updated_at'?: string; /** * * @type {ReferenceObject} * @memberof LifecycleJobResponse */ 'environment': ReferenceObject; /** * Maximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof LifecycleJobResponse */ 'maximum_cpu': number; /** * Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof LifecycleJobResponse */ 'maximum_memory': number; /** * Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB * @type {number} * @memberof LifecycleJobResponse */ 'maximum_gpu': number; /** * name is case insensitive * @type {string} * @memberof LifecycleJobResponse */ 'name': string; /** * * @type {string} * @memberof LifecycleJobResponse */ 'description'?: string; /** * unit is millicores (m). 1000m = 1 cpu * @type {number} * @memberof LifecycleJobResponse */ 'cpu': number; /** * unit is MB. 1024 MB = 1GB * @type {number} * @memberof LifecycleJobResponse */ 'memory': number; /** * * @type {number} * @memberof LifecycleJobResponse */ 'gpu': number; /** * Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed * @type {number} * @memberof LifecycleJobResponse */ 'max_nb_restart'?: number; /** * Maximum number of seconds allowed for the job to run before killing it and mark it as failed * @type {number} * @memberof LifecycleJobResponse */ 'max_duration_seconds'?: number; /** * Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment. * @type {boolean} * @memberof LifecycleJobResponse */ 'auto_preview': boolean; /** * Port where to run readiness and liveliness probes checks. The port will not be exposed externally * @type {number} * @memberof LifecycleJobResponse */ 'port'?: number | null; /** * * @type {BaseJobResponseAllOfSource} * @memberof LifecycleJobResponse */ 'source': BaseJobResponseAllOfSource; /** * * @type {Healthcheck} * @memberof LifecycleJobResponse */ 'healthchecks': Healthcheck; /** * Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the \"Auto Deploy job\" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments * @type {boolean} * @memberof LifecycleJobResponse */ 'auto_deploy'?: boolean; /** * Icon URI representing the job. * @type {string} * @memberof LifecycleJobResponse */ 'icon_uri': string; /** * * @type {ServiceTypeEnum} * @memberof LifecycleJobResponse */ 'service_type': ServiceTypeEnum; /** * * @type {JobTypeEnum} * @memberof LifecycleJobResponse */ 'job_type': JobTypeEnum; /** * * @type {LifecycleJobResponseAllOfSchedule} * @memberof LifecycleJobResponse */ 'schedule': LifecycleJobResponseAllOfSchedule; /** * * @type {Array} * @memberof LifecycleJobResponse */ 'annotations_groups'?: Array; /** * * @type {Array} * @memberof LifecycleJobResponse */ 'labels_groups'?: Array; } /** * * @export * @interface LifecycleJobResponseAllOfSchedule */ export interface LifecycleJobResponseAllOfSchedule { /** * * @type {JobRequestAllOfScheduleOnStart} * @memberof LifecycleJobResponseAllOfSchedule */ 'on_start'?: JobRequestAllOfScheduleOnStart; /** * * @type {JobRequestAllOfScheduleOnStart} * @memberof LifecycleJobResponseAllOfSchedule */ 'on_stop'?: JobRequestAllOfScheduleOnStart; /** * * @type {JobRequestAllOfScheduleOnStart} * @memberof LifecycleJobResponseAllOfSchedule */ 'on_delete'?: JobRequestAllOfScheduleOnStart; /** * * @type {JobLifecycleTypeEnum} * @memberof LifecycleJobResponseAllOfSchedule */ 'lifecycle_type'?: JobLifecycleTypeEnum; } /** * * @export * @interface LifecycleTemplateListResponse */ export interface LifecycleTemplateListResponse { /** * * @type {Array} * @memberof LifecycleTemplateListResponse */ 'results': Array; } /** * * @export * @interface LifecycleTemplateListResponseResultsInner */ export interface LifecycleTemplateListResponseResultsInner { /** * * @type {string} * @memberof LifecycleTemplateListResponseResultsInner */ 'id': string; /** * * @type {string} * @memberof LifecycleTemplateListResponseResultsInner */ 'name': string; /** * * @type {string} * @memberof LifecycleTemplateListResponseResultsInner */ 'description': string; } /** * * @export * @interface LifecycleTemplateResponse */ export interface LifecycleTemplateResponse { /** * * @type {string} * @memberof LifecycleTemplateResponse */ 'id': string; /** * * @type {string} * @memberof LifecycleTemplateResponse */ 'name': string; /** * * @type {string} * @memberof LifecycleTemplateResponse */ 'description': string; /** * location of the template * @type {string} * @memberof LifecycleTemplateResponse */ 'sourceUrl': string; /** * * @type {CloudProviderEnum} * @memberof LifecycleTemplateResponse */ 'cloud_provider': CloudProviderEnum; /** * lis of pre-defined command for each event * @type {Array} * @memberof LifecycleTemplateResponse */ 'events': Array; /** * Job max allowed duration in seconds. After this allowed time, the job is going to be killed. * @type {number} * @memberof LifecycleTemplateResponse */ 'max_duration_in_sec': number; /** * * @type {LifecycleTemplateResponseResources} * @memberof LifecycleTemplateResponse */ 'resources': LifecycleTemplateResponseResources; /** * Variables to inject at the creation of this lifecycle job * @type {Array} * @memberof LifecycleTemplateResponse */ 'variables': Array; /** * Dockerfile of the template * @type {string} * @memberof LifecycleTemplateResponse */ 'dockerfile': string; } /** * * @export * @interface LifecycleTemplateResponseEventsInner */ export interface LifecycleTemplateResponseEventsInner { /** * * @type {string} * @memberof LifecycleTemplateResponseEventsInner */ 'name': string; /** * * @type {string} * @memberof LifecycleTemplateResponseEventsInner */ 'entrypoint'?: string; /** * * @type {Array} * @memberof LifecycleTemplateResponseEventsInner */ 'command': Array; } /** * * @export * @interface LifecycleTemplateResponseResources */ export interface LifecycleTemplateResponseResources { /** * * @type {number} * @memberof LifecycleTemplateResponseResources */ 'cpu_milli': number; /** * * @type {number} * @memberof LifecycleTemplateResponseResources */ 'ram_mib': number; } /** * * @export * @interface LifecycleTemplateResponseVariablesInner */ export interface LifecycleTemplateResponseVariablesInner { /** * * @type {string} * @memberof LifecycleTemplateResponseVariablesInner */ 'name': string; /** * Short description to explain the purpose of the variable * @type {string} * @memberof LifecycleTemplateResponseVariablesInner */ 'description': string; /** * Default value for the variable * @type {string} * @memberof LifecycleTemplateResponseVariablesInner */ 'default': string; /** * If the variable should be injected as a secret * @type {boolean} * @memberof LifecycleTemplateResponseVariablesInner */ 'is_secret': boolean; /** * * @type {LifecycleTemplateResponseVariablesInnerFile} * @memberof LifecycleTemplateResponseVariablesInner */ 'file'?: LifecycleTemplateResponseVariablesInnerFile; } /** * If present, the variable should be a file instead of a raw value * @export * @interface LifecycleTemplateResponseVariablesInnerFile */ export interface LifecycleTemplateResponseVariablesInnerFile { /** * * @type {string} * @memberof LifecycleTemplateResponseVariablesInnerFile */ 'path': string; /** * if we should interpolate variable inside the file * @type {boolean} * @memberof LifecycleTemplateResponseVariablesInnerFile */ 'enable_interpolation'?: boolean; } /** * * @export * @interface Link */ export interface Link { /** * ID of the associated service * @type {string} * @memberof Link */ 'service_id': string; /** * * @type {ServiceTypeEnum} * @memberof Link */ 'service_type': ServiceTypeEnum; /** * URL to access the service * @type {string} * @memberof Link */ 'url': string; /** * The port from which the service is reachable from within the cluster * @type {number} * @memberof Link */ 'internal_port': number; /** * The port from which the service is reachable from externally (i.e: 443 for HTTPS) * @type {number} * @memberof Link */ 'external_port': number; /** * True if the domain is managed by Qovery, false if it belongs to the user * @type {boolean} * @memberof Link */ 'is_qovery_domain': boolean; /** * Indicate if the link is using the root of the domain and not one derivated from port i.e: p8080.zxxxx.jvm.worl => is_default = false, is_qovery = true zxxxx.jvm.world => is_default = true, is_qovery = true p8080-my-super-domain.com => is_default = false, is_qovery = false my-super-domain.com => is_default = true, is_qovery = false * @type {boolean} * @memberof Link */ 'is_default': boolean; } /** * * @export * @interface LinkResponseList */ export interface LinkResponseList { /** * * @type {Array} * @memberof LinkResponseList */ 'results'?: Array; } /** * type of the service (application, database, job, gateway...) * @export * @enum {string} */ export declare const LinkedServiceTypeEnum: { readonly APPLICATION: "APPLICATION"; readonly CONTAINER: "CONTAINER"; readonly DATABASE: "DATABASE"; readonly JOB: "JOB"; readonly HELM: "HELM"; readonly TERRAFORM: "TERRAFORM"; }; export type LinkedServiceTypeEnum = typeof LinkedServiceTypeEnum[keyof typeof LinkedServiceTypeEnum]; /** * * @export * @interface ListContainerDeploymentHistory200Response */ export interface ListContainerDeploymentHistory200Response { /** * * @type {number} * @memberof ListContainerDeploymentHistory200Response */ 'page': number; /** * * @type {number} * @memberof ListContainerDeploymentHistory200Response */ 'page_size': number; /** * * @type {Array} * @memberof ListContainerDeploymentHistory200Response */ 'results'?: Array; } /** * * @export * @interface ListDatabaseDeploymentHistory200Response */ export interface ListDatabaseDeploymentHistory200Response { /** * * @type {number} * @memberof ListDatabaseDeploymentHistory200Response */ 'page': number; /** * * @type {number} * @memberof ListDatabaseDeploymentHistory200Response */ 'page_size': number; /** * * @type {Array} * @memberof ListDatabaseDeploymentHistory200Response */ 'results'?: Array; } /** * * @export * @interface ListDeploymentRequestByEnvironmentId200Response */ export interface ListDeploymentRequestByEnvironmentId200Response { /** * * @type {Array} * @memberof ListDeploymentRequestByEnvironmentId200Response */ 'results'?: Array; } /** * * @export * @interface ListDeploymentRequestByServiceId200Response */ export interface ListDeploymentRequestByServiceId200Response { /** * * @type {Array} * @memberof ListDeploymentRequestByServiceId200Response */ 'results'?: Array; } /** * * @export * @interface ListDirectoriesFromGitRepository200Response */ export interface ListDirectoriesFromGitRepository200Response { /** * * @type {Array} * @memberof ListDirectoriesFromGitRepository200Response */ 'results'?: Array; } /** * * @export * @interface ListEnvironmentsByOrganizationId200Response */ export interface ListEnvironmentsByOrganizationId200Response { /** * * @type {Array} * @memberof ListEnvironmentsByOrganizationId200Response */ 'results'?: Array; } /** * * @export * @interface ListHelmDeploymentHistory200Response */ export interface ListHelmDeploymentHistory200Response { /** * * @type {number} * @memberof ListHelmDeploymentHistory200Response */ 'page': number; /** * * @type {number} * @memberof ListHelmDeploymentHistory200Response */ 'page_size': number; /** * * @type {Array} * @memberof ListHelmDeploymentHistory200Response */ 'results'?: Array; } /** * * @export * @interface ListJobDeploymentHistory200Response */ export interface ListJobDeploymentHistory200Response { /** * * @type {number} * @memberof ListJobDeploymentHistory200Response */ 'page': number; /** * * @type {number} * @memberof ListJobDeploymentHistory200Response */ 'page_size': number; /** * * @type {Array} * @memberof ListJobDeploymentHistory200Response */ 'results'?: Array; } /** * * @export * @interface ListOrganizationAnnotationsGroup200Response */ export interface ListOrganizationAnnotationsGroup200Response { /** * * @type {Array} * @memberof ListOrganizationAnnotationsGroup200Response */ 'results'?: Array; } /** * * @export * @interface ListOrganizationLabelsGroup200Response */ export interface ListOrganizationLabelsGroup200Response { /** * * @type {Array} * @memberof ListOrganizationLabelsGroup200Response */ 'results'?: Array; } /** * * @export * @interface ListServicesByEnvironmentId200Response */ export interface ListServicesByEnvironmentId200Response { /** * * @type {Array} * @memberof ListServicesByEnvironmentId200Response */ 'results'?: Array; } /** * @type ListServicesByEnvironmentId200ResponseResultsInner * @export */ export type ListServicesByEnvironmentId200ResponseResultsInner = { service_type: 'APPLICATION'; } & Application | { service_type: 'ARGOCD_APP'; } & ArgocdAppResponse | { service_type: 'CONTAINER'; } & ContainerResponse | { service_type: 'DATABASE'; } & Database | { service_type: 'HELM'; } & HelmResponse | { service_type: 'JOB'; } & JobResponse | { service_type: 'TERRAFORM'; } & TerraformResponse; /** * * @export * @interface ListServicesByOrganizationId200Response */ export interface ListServicesByOrganizationId200Response { /** * * @type {Array} * @memberof ListServicesByOrganizationId200Response */ 'results'?: Array; } /** * * @export * @interface ListTfVarsFilesFromGitRepo200Response */ export interface ListTfVarsFilesFromGitRepo200Response { /** * * @type {Array} * @memberof ListTfVarsFilesFromGitRepo200Response */ 'results'?: Array; } /** * * @export * @interface Log */ export interface Log { /** * * @type {string} * @memberof Log */ 'id': string; /** * * @type {string} * @memberof Log */ 'created_at': string; /** * * @type {string} * @memberof Log */ 'message': string; /** * * @type {string} * @memberof Log */ 'pod_name'?: string; /** * * @type {string} * @memberof Log */ 'version'?: string; } /** * * @export * @interface LogResponseList */ export interface LogResponseList { /** * * @type {Array} * @memberof LogResponseList */ 'results'?: Array; } /** * * @export * @interface ManagedDatabaseInstanceTypeResponse */ export interface ManagedDatabaseInstanceTypeResponse { /** * * @type {string} * @memberof ManagedDatabaseInstanceTypeResponse */ 'name': string; } /** * * @export * @interface ManagedDatabaseInstanceTypeResponseList */ export interface ManagedDatabaseInstanceTypeResponseList { /** * * @type {Array} * @memberof ManagedDatabaseInstanceTypeResponseList */ 'results'?: Array; } /** * * @export * @interface ManagedDatabaseTypeResponse */ export interface ManagedDatabaseTypeResponse { /** * * @type {string} * @memberof ManagedDatabaseTypeResponse */ 'name': string; } /** * * @export * @interface ManagedDatabaseTypeResponseList */ export interface ManagedDatabaseTypeResponseList { /** * * @type {Array} * @memberof ManagedDatabaseTypeResponseList */ 'results'?: Array; } /** * * @export * @interface Member */ export interface Member { /** * * @type {string} * @memberof Member */ 'id': string; /** * * @type {string} * @memberof Member */ 'created_at': string; /** * * @type {string} * @memberof Member */ 'updated_at'?: string; /** * * @type {string} * @memberof Member */ 'name'?: string; /** * * @type {string} * @memberof Member */ 'nickname'?: string; /** * * @type {string} * @memberof Member */ 'email': string; /** * * @type {string} * @memberof Member */ 'profile_picture_url'?: string; /** * last time the user was connected * @type {string} * @memberof Member */ 'last_activity_at'?: string; /** * * @type {InviteMemberRoleEnum} * @memberof Member */ 'role'?: InviteMemberRoleEnum; /** * the role linked to the user * @type {string} * @memberof Member */ 'role_name'?: string; /** * * @type {string} * @memberof Member */ 'role_id'?: string; } /** * * @export * @interface MemberResponseList */ export interface MemberResponseList { /** * * @type {Array} * @memberof MemberResponseList */ 'results'?: Array; } /** * * @export * @interface MemberRoleUpdateRequest */ export interface MemberRoleUpdateRequest { /** * specify the git provider user id * @type {string} * @memberof MemberRoleUpdateRequest */ 'user_id': string; /** * * @type {string} * @memberof MemberRoleUpdateRequest */ 'role_id': string; } /** * * @export * @interface MetricsConfigurationManagedByQovery */ export interface MetricsConfigurationManagedByQovery { /** * * @type {string} * @memberof MetricsConfigurationManagedByQovery */ 'kind'?: MetricsConfigurationManagedByQoveryKindEnum; /** * * @type {ObservabilityResourceProfile} * @memberof MetricsConfigurationManagedByQovery */ 'resource_profile'?: ObservabilityResourceProfile; /** * * @type {CloudWatchExportConfig} * @memberof MetricsConfigurationManagedByQovery */ 'cloud_watch_export_config'?: CloudWatchExportConfig; /** * * @type {boolean} * @memberof MetricsConfigurationManagedByQovery */ 'high_availability'?: boolean; /** * * @type {InternalNetworkMonitoring} * @memberof MetricsConfigurationManagedByQovery */ 'internal_network_monitoring'?: InternalNetworkMonitoring; /** * * @type {AlertingConfig} * @memberof MetricsConfigurationManagedByQovery */ 'alerting'?: AlertingConfig; } export declare const MetricsConfigurationManagedByQoveryKindEnum: { readonly MANAGED_BY_QOVERY: "MANAGED_BY_QOVERY"; }; export type MetricsConfigurationManagedByQoveryKindEnum = typeof MetricsConfigurationManagedByQoveryKindEnum[keyof typeof MetricsConfigurationManagedByQoveryKindEnum]; /** * * @export * @interface MetricsParameters */ export interface MetricsParameters { /** * * @type {boolean} * @memberof MetricsParameters */ 'enabled'?: boolean; /** * * @type {MetricsParametersConfiguration} * @memberof MetricsParameters */ 'configuration'?: MetricsParametersConfiguration; } /** * @type MetricsParametersConfiguration * @export */ export type MetricsParametersConfiguration = { kind: 'MANAGED_BY_QOVERY'; } & MetricsConfigurationManagedByQovery; /** * * @export * @enum {string} */ export declare const ObservabilityResourceProfile: { readonly LOW: "LOW"; readonly NORMAL: "NORMAL"; readonly HIGH: "HIGH"; }; export type ObservabilityResourceProfile = typeof ObservabilityResourceProfile[keyof typeof ObservabilityResourceProfile]; /** * * @export * @interface OnPremiseCredentialsRequest */ export interface OnPremiseCredentialsRequest { /** * * @type {string} * @memberof OnPremiseCredentialsRequest */ 'name': string; } /** * * @export * @interface Organization */ export interface Organization { /** * * @type {string} * @memberof Organization */ 'id': string; /** * * @type {string} * @memberof Organization */ 'created_at': string; /** * * @type {string} * @memberof Organization */ 'updated_at'?: string; /** * name is case insensitive * @type {string} * @memberof Organization */ 'name': string; /** * * @type {string} * @memberof Organization */ 'description'?: string | null; /** * * @type {PlanEnum} * @memberof Organization */ 'plan': PlanEnum; /** * * @type {string} * @memberof Organization */ 'website_url'?: string | null; /** * * @type {string} * @memberof Organization */ 'repository'?: string | null; /** * * @type {string} * @memberof Organization */ 'logo_url'?: string | null; /** * * @type {string} * @memberof Organization */ 'icon_url'?: string | null; /** * * @type {Array} * @memberof Organization */ 'admin_emails'?: Array | null; /** * uuid of the user owning the organization * @type {string} * @memberof Organization */ 'owner'?: string; /** * If set, indicates a billing-related restriction on the organization. \'NO_CREDIT_CARD\' means the organization is on a free trial without a credit card — managed cluster creation and deployments on managed clusters are blocked, but demo cluster usage is allowed. Any other value blocks all deployments. null means no restriction. * @type {string} * @memberof Organization */ 'billing_deployment_restriction'?: string | null; /** * * @type {OrganizationAllOfOrganizationPlan} * @memberof Organization */ 'organization_plan'?: OrganizationAllOfOrganizationPlan; } /** * * @export * @interface OrganizationAllOfOrganizationPlan */ export interface OrganizationAllOfOrganizationPlan { /** * * @type {PlanEnum} * @memberof OrganizationAllOfOrganizationPlan */ 'plan'?: PlanEnum; /** * audit logs maximum period available in days * @type {number} * @memberof OrganizationAllOfOrganizationPlan */ 'audit_logs_retention_in_days'?: number; } /** * * @export * @interface OrganizationAnnotationsGroupAssociatedItemsResponseList */ export interface OrganizationAnnotationsGroupAssociatedItemsResponseList { /** * * @type {Array} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseList */ 'results'?: Array; } /** * * @export * @interface OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ export interface OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner { /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'cluster_id'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'cluster_name'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'project_id'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'project_name'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'environment_id'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'environment_name'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'item_id': string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'item_name': string; /** * * @type {AnnotationsGroupAssociatedItemType} * @memberof OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner */ 'item_type': AnnotationsGroupAssociatedItemType; } /** * * @export * @interface OrganizationAnnotationsGroupCreateRequest */ export interface OrganizationAnnotationsGroupCreateRequest { /** * name of the annotations group * @type {string} * @memberof OrganizationAnnotationsGroupCreateRequest */ 'name': string; /** * * @type {Array} * @memberof OrganizationAnnotationsGroupCreateRequest */ 'annotations': Array; /** * * @type {Array} * @memberof OrganizationAnnotationsGroupCreateRequest */ 'scopes': Array; } /** * * @export * @interface OrganizationAnnotationsGroupEnrichedResponse */ export interface OrganizationAnnotationsGroupEnrichedResponse { /** * * @type {string} * @memberof OrganizationAnnotationsGroupEnrichedResponse */ 'id': string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupEnrichedResponse */ 'created_at': string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupEnrichedResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupEnrichedResponse */ 'name': string; /** * * @type {Array} * @memberof OrganizationAnnotationsGroupEnrichedResponse */ 'annotations': Array; /** * * @type {Array} * @memberof OrganizationAnnotationsGroupEnrichedResponse */ 'scopes': Array; /** * * @type {number} * @memberof OrganizationAnnotationsGroupEnrichedResponse */ 'associated_items_count'?: number; } /** * * @export * @interface OrganizationAnnotationsGroupResponse */ export interface OrganizationAnnotationsGroupResponse { /** * * @type {string} * @memberof OrganizationAnnotationsGroupResponse */ 'id': string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupResponse */ 'created_at': string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupResponse */ 'updated_at'?: string; /** * * @type {string} * @memberof OrganizationAnnotationsGroupResponse */ 'name': string; /** * * @type {Array} * @memberof OrganizationAnnotationsGroupResponse */ 'annotations': Array; /** * * @type {Array} * @memberof OrganizationAnnotationsGroupResponse */ 'scopes': Array; } /** * Annotations Group Scope * @export * @enum {string} */ export declare const OrganizationAnnotationsGroupScopeEnum: { readonly DEPLOYMENTS: "DEPLOYMENTS"; readonly STATEFUL_SETS: "STATEFUL_SETS"; readonly SERVICES: "SERVICES"; readonly INGRESS: "INGRESS"; readonly GATEWAY_API_ROUTES: "GATEWAY_API_ROUTES"; readonly HPA: "HPA"; readonly PODS: "PODS"; readonly SECRETS: "SECRETS"; readonly JOBS: "JOBS"; readonly CRON_JOBS: "CRON_JOBS"; }; export type OrganizationAnnotationsGroupScopeEnum = typeof OrganizationAnnotationsGroupScopeEnum[keyof typeof OrganizationAnnotationsGroupScopeEnum]; /** * * @export * @interface OrganizationApiToken */ export interface OrganizationApiToken { /** * * @type {string} * @memberof OrganizationApiToken */ 'id': string; /** * * @type {string} * @memberof OrganizationApiToken */ 'created_at': string; /** * * @type {string} * @memberof OrganizationApiToken */ 'updated_at'?: string; /** * * @type {string} * @memberof OrganizationApiToken */ 'name'?: string; /** * * @type {string} * @memberof OrganizationApiToken */ 'description'?: string; /** * * @type {string} * @memberof OrganizationApiToken */ 'role_name'?: string; /** * * @type {string} * @memberof OrganizationApiToken */ 'role_id'?: string; } /** * * @export * @interface OrganizationApiTokenCreate */ export interface OrganizationApiTokenCreate { /** * * @type {string} * @memberof OrganizationApiTokenCreate */ 'id': string; /** * * @type {string} * @memberof OrganizationApiTokenCreate */ 'created_at': string; /** * * @type {string} * @memberof OrganizationApiTokenCreate */ 'updated_at'?: string; /** * * @type {string} * @memberof OrganizationApiTokenCreate */ 'name'?: string; /** * * @type {string} * @memberof OrganizationApiTokenCreate */ 'description'?: string; /** * the generated token to send in \'Authorization\' header prefixed by \'Token \' * @type {string} * @memberof OrganizationApiTokenCreate */ 'token'?: string; /** * * @type {string} * @memberof OrganizationApiTokenCreate */ 'role_name'?: string; /** * * @type {string} * @memberof OrganizationApiTokenCreate */ 'role_id'?: string; } /** * * @export * @interface OrganizationApiTokenCreateRequest */ export interface OrganizationApiTokenCreateRequest { /** * * @type {string} * @memberof OrganizationApiTokenCreateRequest */ 'name': string; /** * * @type {string} * @memberof OrganizationApiTokenCreateRequest */ 'description'?: string; /** * * @type {OrganizationApiTokenScope} * @memberof OrganizationApiTokenCreateRequest */ 'scope'?: OrganizationApiTokenScope | null; /** * the roleId provided by the \"List organization custom roles\" endpoint. * @type {string} * @memberof OrganizationApiTokenCreateRequest */ 'role_id': string | null; } /** * * @export * @interface OrganizationApiTokenResponseList */ export interface OrganizationApiTokenResponseList { /** * * @type {Array} * @memberof OrganizationApiTokenResponseList */ 'results'?: Array; } /** * deprecated * @export * @enum {string} */ export declare const OrganizationApiTokenScope: { readonly ADMIN: "ADMIN"; }; export type OrganizationApiTokenScope = typeof OrganizationApiTokenScope[keyof typeof OrganizationApiTokenScope]; /** * * @export * @interface OrganizationAvailableRole */ export interface OrganizationAvailableRole { /** * * @type {string} * @memberof OrganizationAvailableRole */ 'id': string; /** * * @type {string} * @memberof OrganizationAvailableRole */ 'name': string; } /** * * @export * @interface OrganizationAvailableRoleList */ export interface OrganizationAvailableRoleList { /** * * @type {Array} * @memberof OrganizationAvailableRoleList */ 'results'?: Array; } /** * * @export * @interface OrganizationBillingUsageReportRequest */ export interface OrganizationBillingUsageReportRequest { /** * The start date of the report * @type {string} * @memberof OrganizationBillingUsageReportRequest */ 'from': string; /** * The end date of the report * @type {string} * @memberof OrganizationBillingUsageReportRequest */ 'to': string; /** * The number of seconds the report will be publicly available * @type {number} * @memberof OrganizationBillingUsageReportRequest */ 'report_expiration_in_seconds': number; } /** * * @export * @interface OrganizationBillingUsageReportResponse */ export interface OrganizationBillingUsageReportResponse { /** * The URL of the report * @type {string} * @memberof OrganizationBillingUsageReportResponse */ 'report_url'?: string; /** * The URL to delete the report. Use this URL to pro-actively delete the report before it expires * @type {string} * @memberof OrganizationBillingUsageReportResponse */ 'delete_report_url'?: string; } /** * * @export * @interface OrganizationChangePlanRequest */ export interface OrganizationChangePlanRequest { /** * * @type {string} * @memberof OrganizationChangePlanRequest */ 'plan'?: string; } /** * * @export * @interface OrganizationContainerAutoDeployRequest */ export interface OrganizationContainerAutoDeployRequest { /** * the container image name to deploy * @type {string} * @memberof OrganizationContainerAutoDeployRequest */ 'image_name'?: string; /** * the new tag to deploy * @type {string} * @memberof OrganizationContainerAutoDeployRequest */ 'tag'?: string; } /** * * @export * @interface OrganizationContainerPreviewRequest */ export interface OrganizationContainerPreviewRequest { /** * the container image name to trigger preview environment * @type {string} * @memberof OrganizationContainerPreviewRequest */ 'image_name'?: string; /** * the tag to be used in the preview environment * @type {string} * @memberof OrganizationContainerPreviewRequest */ 'tag'?: string; } /** * * @export * @interface OrganizationCreditCodeRequest */ export interface OrganizationCreditCodeRequest { /** * * @type {string} * @memberof OrganizationCreditCodeRequest */ 'code'?: string; } /** * * @export * @interface OrganizationCrendentialsResponseList */ export interface OrganizationCrendentialsResponseList { /** * * @type {Array} * @memberof OrganizationCrendentialsResponseList */ 'results'?: Array; } /** * * @export * @interface OrganizationCrendentialsResponseListResultsInner */ export interface OrganizationCrendentialsResponseListResultsInner { /** * * @type {ClusterCredentials} * @memberof OrganizationCrendentialsResponseListResultsInner */ 'credential'?: ClusterCredentials; /** * * @type {Array} * @memberof OrganizationCrendentialsResponseListResultsInner */ 'clusters'?: Array; } /** * * @export * @interface OrganizationCurrentCost */ export interface OrganizationCurrentCost { /** * * @type {PlanEnum} * @memberof OrganizationCurrentCost */ 'plan'?: PlanEnum; /** * number of days remaining before the end of the trial period * @type {number} * @memberof OrganizationCurrentCost */ 'remaining_trial_day'?: number; /** * date when the current plan will be renewed * @type {string} * @memberof OrganizationCurrentCost */ 'renewal_at'?: string | null; /** * * @type {Cost} * @memberof OrganizationCurrentCost */ 'cost'?: Cost; } /** * * @export * @interface OrganizationCustomRole */ export interface OrganizationCustomRole { /** * * @type {string} * @memberof OrganizationCustomRole */ 'id'?: string; /** * * @type {string} * @memberof OrganizationCustomRole */ 'name'?: string; /** * * @type {string} * @memberof OrganizationCustomRole */ 'description'?: string; /** * * @type {Array} * @memberof OrganizationCustomRole */ 'cluster_permissions'?: Array; /** * * @type {Array} * @memberof OrganizationCustomRole */ 'project_permissions'?: Array; } /** * Indicates the permission for a target cluster, from the lowest to the highest: - `VIEWER` user has only read access on target cluster - `ENV_CREATOR` user can deploy on the cluster - `ADMIN` user can modify the cluster settings * @export * @enum {string} */ export declare const OrganizationCustomRoleClusterPermission: { readonly VIEWER: "VIEWER"; readonly ENV_CREATOR: "ENV_CREATOR"; readonly ADMIN: "ADMIN"; }; export type OrganizationCustomRoleClusterPermission = typeof OrganizationCustomRoleClusterPermission[keyof typeof OrganizationCustomRoleClusterPermission]; /** * * @export * @interface OrganizationCustomRoleClusterPermissionsInner */ export interface OrganizationCustomRoleClusterPermissionsInner { /** * * @type {string} * @memberof OrganizationCustomRoleClusterPermissionsInner */ 'cluster_id'?: string; /** * * @type {string} * @memberof OrganizationCustomRoleClusterPermissionsInner */ 'cluster_name'?: string; /** * * @type {OrganizationCustomRoleClusterPermission} * @memberof OrganizationCustomRoleClusterPermissionsInner */ 'permission'?: OrganizationCustomRoleClusterPermission; } /** * * @export * @interface OrganizationCustomRoleCreateRequest */ export interface OrganizationCustomRoleCreateRequest { /** * * @type {string} * @memberof OrganizationCustomRoleCreateRequest */ 'name': string; /** * * @type {string} * @memberof OrganizationCustomRoleCreateRequest */ 'description'?: string; } /** * * @export * @interface OrganizationCustomRoleList */ export interface OrganizationCustomRoleList { /** * * @type {Array} * @memberof OrganizationCustomRoleList */ 'results'?: Array; } /** * Indicates the permission for a target project and a given environment type, from the lowest to the highest: - `NO_ACCESS` user has no access - `VIEWER` user can access the environment (and applications / containers / databases / variables) - `DEPLOYER` user can deploy the environment (dependent on the required cluster permission `ENV_CREATOR`) - `MANAGER` user can create an environment (and applications / containers / databases / variables) * @export * @enum {string} */ export declare const OrganizationCustomRoleProjectPermission: { readonly NO_ACCESS: "NO_ACCESS"; readonly VIEWER: "VIEWER"; readonly DEPLOYER: "DEPLOYER"; readonly MANAGER: "MANAGER"; }; export type OrganizationCustomRoleProjectPermission = typeof OrganizationCustomRoleProjectPermission[keyof typeof OrganizationCustomRoleProjectPermission]; /** * * @export * @interface OrganizationCustomRoleProjectPermissionsInner */ export interface OrganizationCustomRoleProjectPermissionsInner { /** * * @type {string} * @memberof OrganizationCustomRoleProjectPermissionsInner */ 'project_id'?: string; /** * * @type {string} * @memberof OrganizationCustomRoleProjectPermissionsInner */ 'project_name'?: string; /** * If `is_admin` is `true`, the user is: - automatically `MANAGER` for each environment type - allowed to manage project deployment rules - able to delete the project Note that `permissions` can then be ignored for this project * @type {boolean} * @memberof OrganizationCustomRoleProjectPermissionsInner */ 'is_admin'?: boolean; /** * * @type {Array} * @memberof OrganizationCustomRoleProjectPermissionsInner */ 'permissions'?: Array; } /** * * @export * @interface OrganizationCustomRoleUpdateRequest */ export interface OrganizationCustomRoleUpdateRequest { /** * * @type {string} * @memberof OrganizationCustomRoleUpdateRequest */ 'name': string; /** * * @type {string} * @memberof OrganizationCustomRoleUpdateRequest */ 'description'?: string; /** * Should contain an entry for every existing cluster * @type {Array} * @memberof OrganizationCustomRoleUpdateRequest */ 'cluster_permissions': Array; /** * Should contain an entry for every existing project * @type {Array} * @memberof OrganizationCustomRoleUpdateRequest */ 'project_permissions': Array; } /** * * @export * @interface OrganizationCustomRoleUpdateRequestClusterPermissionsInner */ export interface OrganizationCustomRoleUpdateRequestClusterPermissionsInner { /** * * @type {string} * @memberof OrganizationCustomRoleUpdateRequestClusterPermissionsInner */ 'cluster_id'?: string; /** * * @type {OrganizationCustomRoleClusterPermission} * @memberof OrganizationCustomRoleUpdateRequestClusterPermissionsInner */ 'permission'?: OrganizationCustomRoleClusterPermission; } /** * * @export * @interface OrganizationCustomRoleUpdateRequestProjectPermissionsInner */ export interface OrganizationCustomRoleUpdateRequestProjectPermissionsInner { /** * * @type {string} * @memberof OrganizationCustomRoleUpdateRequestProjectPermissionsInner */ 'project_id'?: string; /** * If `is_admin` is `true`, the user is: - automatically `MANAGER` for each environment type - allowed to manage project deployment rules - able to delete the project Note that `permissions` can then be ignored for this project * @type {boolean} * @memberof OrganizationCustomRoleUpdateRequestProjectPermissionsInner */ 'is_admin'?: boolean; /** * Mandatory if `is_admin` is `false` Should contain an entry for every environment type: - `DEVELOPMENT` - `PREVIEW` - `STAGING` - `PRODUCTION` * @type {Array} * @memberof OrganizationCustomRoleUpdateRequestProjectPermissionsInner */ 'permissions'?: Array; } /** * * @export * @interface OrganizationCustomRoleUpdateRequestProjectPermissionsInnerPermissionsInner */ export interface OrganizationCustomRoleUpdateRequestProjectPermissionsInnerPermissionsInner { /** * * @type {EnvironmentModeEnum} * @memberof OrganizationCustomRoleUpdateRequestProjectPermissionsInnerPermissionsInner */ 'environment_type'?: EnvironmentModeEnum; /** * * @type {OrganizationCustomRoleProjectPermission} * @memberof OrganizationCustomRoleUpdateRequestProjectPermissionsInnerPermissionsInner */ 'permission'?: OrganizationCustomRoleProjectPermission; } /** * * @export * @interface OrganizationEditRequest */ export interface OrganizationEditRequest { /** * name is case insensitive * @type {string} * @memberof OrganizationEditRequest */ 'name': string; /** * * @type {string} * @memberof OrganizationEditRequest */ 'description'?: string; /** * * @type {string} * @memberof OrganizationEditRequest */ 'website_url'?: string | null; /** * * @type {string} * @memberof OrganizationEditRequest */ 'repository'?: string | null; /** * * @type {string} * @memberof OrganizationEditRequest */ 'logo_url'?: string | null; /** * * @type {string} * @memberof OrganizationEditRequest */ 'icon_url'?: string | null; /** * * @type {Array} * @memberof OrganizationEditRequest */ 'admin_emails'?: Array | null; } /** * * @export * @interface OrganizationEnvironmentResponse */ export interface OrganizationEnvironmentResponse { /** * * @type {string} * @memberof OrganizationEnvironmentResponse */ 'id': string; /** * * @type {string} * @memberof OrganizationEnvironmentResponse */ 'created_at': string; /** * * @type {string} * @memberof OrganizationEnvironmentResponse */ 'updated_at'?: string; /** * name is case insensitive * @type {string} * @memberof OrganizationEnvironmentResponse */ 'name': string; /** * * @type {ReferenceObject} * @memberof OrganizationEnvironmentResponse */ 'organization': ReferenceObject; /** * * @type {ReferenceObject} * @memberof OrganizationEnvironmentResponse */ 'project': ReferenceObject; /** * * @type {EnvironmentModeEnum} * @memberof OrganizationEnvironmentResponse */ 'mode': EnvironmentModeEnum; } /** * Origin of the organization event * @export * @enum {string} */ export declare const OrganizationEventOrigin: { readonly API: "API"; readonly CLI: "CLI"; readonly CONSOLE: "CONSOLE"; readonly GIT: "GIT"; readonly QOVERY_INTERNAL: "QOVERY_INTERNAL"; readonly TERRAFORM_PROVIDER: "TERRAFORM_PROVIDER"; }; export type OrganizationEventOrigin = typeof OrganizationEventOrigin[keyof typeof OrganizationEventOrigin]; /** * * @export * @interface OrganizationEventResponse */ export interface OrganizationEventResponse { /** * * @type {string} * @memberof OrganizationEventResponse */ 'id'?: string; /** * * @type {string} * @memberof OrganizationEventResponse */ 'timestamp'?: string; /** * * @type {OrganizationEventType} * @memberof OrganizationEventResponse */ 'event_type'?: OrganizationEventType; /** * * @type {string} * @memberof OrganizationEventResponse */ 'target_id'?: string | null; /** * * @type {string} * @memberof OrganizationEventResponse */ 'target_name'?: string; /** * * @type {OrganizationEventTargetType} * @memberof OrganizationEventResponse */ 'target_type'?: OrganizationEventTargetType; /** * * @type {OrganizationEventSubTargetType} * @memberof OrganizationEventResponse */ 'sub_target_type'?: OrganizationEventSubTargetType | null; /** * * @type {string} * @memberof OrganizationEventResponse */ 'change'?: string; /** * * @type {OrganizationEventOrigin} * @memberof OrganizationEventResponse */ 'origin'?: OrganizationEventOrigin; /** * * @type {string} * @memberof OrganizationEventResponse */ 'triggered_by'?: string; /** * * @type {string} * @memberof OrganizationEventResponse */ 'project_id'?: string | null; /** * * @type {string} * @memberof OrganizationEventResponse */ 'project_name'?: string; /** * * @type {string} * @memberof OrganizationEventResponse */ 'environment_id'?: string | null; /** * * @type {string} * @memberof OrganizationEventResponse */ 'environment_name'?: string; /** * * @type {string} * @memberof OrganizationEventResponse */ 'user_agent'?: string | null; /** * * @type {string} * @memberof OrganizationEventResponse */ 'original_change'?: string | null; } /** * * @export * @interface OrganizationEventResponseList */ export interface OrganizationEventResponseList { /** * * @type {OrganizationEventResponseListLinks} * @memberof OrganizationEventResponseList */ 'links'?: OrganizationEventResponseListLinks; /** * Indicates if you cannot see previous logs according to your organization max limit * @type {boolean} * @memberof OrganizationEventResponseList */ 'organization_max_limit_reached'?: boolean; /** * * @type {Array} * @memberof OrganizationEventResponseList */ 'events'?: Array; } /** * * @export * @interface OrganizationEventResponseListLinks */ export interface OrganizationEventResponseListLinks { /** * * @type {string} * @memberof OrganizationEventResponseListLinks */ 'previous'?: string; /** * * @type {string} * @memberof OrganizationEventResponseListLinks */ 'next'?: string; } /** * Type of the organization event * @export * @enum {string} */ export declare const OrganizationEventSubTargetType: { readonly ADVANCED_SETTINGS: "ADVANCED_SETTINGS"; readonly ALERT_RULE: "ALERT_RULE"; readonly ANNOTATIONS_GROUP: "ANNOTATIONS_GROUP"; readonly API_TOKEN: "API_TOKEN"; readonly BILLING_INFO: "BILLING_INFO"; readonly BILLING_USAGE_REPORT: "BILLING_USAGE_REPORT"; readonly CLOUD_PROVIDER_CREDENTIALS: "CLOUD_PROVIDER_CREDENTIALS"; readonly CLUSTER_CREDENTIALS: "CLUSTER_CREDENTIALS"; readonly CLUSTER_ROUTING_TABLE: "CLUSTER_ROUTING_TABLE"; readonly CONFIG: "CONFIG"; readonly CREDIT_CARD: "CREDIT_CARD"; readonly CREDIT_CODE: "CREDIT_CODE"; readonly CUSTOM_DOMAIN: "CUSTOM_DOMAIN"; readonly CUSTOM_ROLE: "CUSTOM_ROLE"; readonly DEPLOYMENT_RULE: "DEPLOYMENT_RULE"; readonly DEPLOYMENT_STAGE: "DEPLOYMENT_STAGE"; readonly GITHUB_APP: "GITHUB_APP"; readonly GIT_REPOSITORY: "GIT_REPOSITORY"; readonly GIT_TOKEN: "GIT_TOKEN"; readonly INVITATION: "INVITATION"; readonly KUBERNETES_CONFIGURATION: "KUBERNETES_CONFIGURATION"; readonly KUBERNETES_CREDENTIALS: "KUBERNETES_CREDENTIALS"; readonly LABELS_GROUP: "LABELS_GROUP"; readonly MEMBER_ROLE: "MEMBER_ROLE"; readonly PLAN: "PLAN"; readonly REMOTE_ACCESS: "REMOTE_ACCESS"; readonly SECRET: "SECRET"; readonly SSO: "SSO"; readonly TERRAFORM: "TERRAFORM"; readonly TRANSFER_OWNERSHIP: "TRANSFER_OWNERSHIP"; readonly VARIABLE: "VARIABLE"; }; export type OrganizationEventSubTargetType = typeof OrganizationEventSubTargetType[keyof typeof OrganizationEventSubTargetType]; /** * The target level to fetch * @export * @enum {string} */ export declare const OrganizationEventTargetLevel: { readonly PROJECT: "PROJECT"; readonly ENVIRONMENT: "ENVIRONMENT"; }; export type OrganizationEventTargetLevel = typeof OrganizationEventTargetLevel[keyof typeof OrganizationEventTargetLevel]; /** * * @export * @interface OrganizationEventTargetResponseList */ export interface OrganizationEventTargetResponseList { /** * * @type {Array} * @memberof OrganizationEventTargetResponseList */ 'targets'?: Array; } /** * Type of the organization event * @export * @enum {string} */ export declare const OrganizationEventTargetType: { readonly APPLICATION: "APPLICATION"; readonly CLUSTER: "CLUSTER"; readonly CONTAINER: "CONTAINER"; readonly CONTAINER_REGISTRY: "CONTAINER_REGISTRY"; readonly DATABASE: "DATABASE"; readonly ENTERPRISE_CONNECTION: "ENTERPRISE_CONNECTION"; readonly ENVIRONMENT: "ENVIRONMENT"; readonly JOB: "JOB"; readonly HELM: "HELM"; readonly HELM_REPOSITORY: "HELM_REPOSITORY"; readonly MEMBERS_AND_ROLES: "MEMBERS_AND_ROLES"; readonly ORGANIZATION: "ORGANIZATION"; readonly PROJECT: "PROJECT"; readonly WEBHOOK: "WEBHOOK"; readonly TERRAFORM: "TERRAFORM"; }; export type OrganizationEventTargetType = typeof OrganizationEventTargetType[keyof typeof OrganizationEventTargetType]; /** * Type of the organization event * @export * @enum {string} */ export declare const OrganizationEventType: { readonly CREATE: "CREATE"; readonly UPDATE: "UPDATE"; readonly DELETE: "DELETE"; readonly ACCEPT: "ACCEPT"; readonly EXPORT: "EXPORT"; readonly CLONE: "CLONE"; readonly DEPLOY_QUEUED: "DEPLOY_QUEUED"; readonly STOP_QUEUED: "STOP_QUEUED"; readonly RESTART_QUEUED: "RESTART_QUEUED"; readonly DELETE_QUEUED: "DELETE_QUEUED"; readonly UNINSTALL_QUEUED: "UNINSTALL_QUEUED"; readonly MAINTENANCE: "MAINTENANCE"; readonly DRY_RUN: "DRY_RUN"; readonly TRIGGER_REDEPLOY: "TRIGGER_REDEPLOY"; readonly TRIGGER_CANCEL: "TRIGGER_CANCEL"; readonly FORCE_RUN_QUEUED: "FORCE_RUN_QUEUED"; readonly FORCE_RUN_QUEUED_DEPLOY: "FORCE_RUN_QUEUED_DEPLOY"; readonly FORCE_RUN_QUEUED_STOP: "FORCE_RUN_QUEUED_STOP"; readonly FORCE_RUN_QUEUED_DELETE: "FORCE_RUN_QUEUED_DELETE"; readonly TRIGGER_DEPLOY: "TRIGGER_DEPLOY"; readonly TRIGGER_STOP: "TRIGGER_STOP"; readonly TRIGGER_RESTART: "TRIGGER_RESTART"; readonly TRIGGER_DELETE: "TRIGGER_DELETE"; readonly TRIGGER_UNINSTALL: "TRIGGER_UNINSTALL"; readonly TRIGGER_DEPLOY_DRY_RUN: "TRIGGER_DEPLOY_DRY_RUN"; readonly TRIGGER_TERRAFORM_FORCE_UNLOCK: "TRIGGER_TERRAFORM_FORCE_UNLOCK"; readonly TRIGGER_TERRAFORM_MIGRATE_STATE: "TRIGGER_TERRAFORM_MIGRATE_STATE"; readonly TRIGGER_FORCE_RUN: "TRIGGER_FORCE_RUN"; readonly TRIGGER_FORCE_RUN_DEPLOY: "TRIGGER_FORCE_RUN_DEPLOY"; readonly TRIGGER_FORCE_RUN_STOP: "TRIGGER_FORCE_RUN_STOP"; readonly TRIGGER_FORCE_RUN_DELETE: "TRIGGER_FORCE_RUN_DELETE"; readonly DEPLOYED: "DEPLOYED"; readonly STOPPED: "STOPPED"; readonly DELETED: "DELETED"; readonly UNINSTALLED: "UNINSTALLED"; readonly RESTARTED: "RESTARTED"; readonly DEPLOYED_DRY_RUN: "DEPLOYED_DRY_RUN"; readonly FORCE_RUN_SUCCEEDED: "FORCE_RUN_SUCCEEDED"; readonly TERRAFORM_FORCE_UNLOCK_SUCCEEDED: "TERRAFORM_FORCE_UNLOCK_SUCCEEDED"; readonly TERRAFORM_MIGRATE_STATE_SUCCEEDED: "TERRAFORM_MIGRATE_STATE_SUCCEEDED"; readonly DEPLOY_FAILED: "DEPLOY_FAILED"; readonly STOP_FAILED: "STOP_FAILED"; readonly DELETE_FAILED: "DELETE_FAILED"; readonly UNINSTALL_FAILED: "UNINSTALL_FAILED"; readonly RESTART_FAILED: "RESTART_FAILED"; readonly DEPLOYED_DRY_RUN_FAILED: "DEPLOYED_DRY_RUN_FAILED"; readonly FORCE_RUN_FAILED: "FORCE_RUN_FAILED"; readonly TERRAFORM_FORCE_UNLOCK_FAILED: "TERRAFORM_FORCE_UNLOCK_FAILED"; readonly TERRAFORM_MIGRATE_STATE_FAILED: "TERRAFORM_MIGRATE_STATE_FAILED"; readonly SHELL: "SHELL"; readonly PORT_FORWARD: "PORT_FORWARD"; readonly REMOTE_DEBUG: "REMOTE_DEBUG"; readonly IMPORT: "IMPORT"; readonly LOCK: "LOCK"; readonly UNLOCK: "UNLOCK"; }; export type OrganizationEventType = typeof OrganizationEventType[keyof typeof OrganizationEventType]; /** * * @export * @interface OrganizationGithubAppConnectRequest */ export interface OrganizationGithubAppConnectRequest { /** * * @type {string} * @memberof OrganizationGithubAppConnectRequest */ 'installation_id': string; /** * * @type {string} * @memberof OrganizationGithubAppConnectRequest */ 'code': string; } /** * * @export * @interface OrganizationJobAutoDeployRequest */ export interface OrganizationJobAutoDeployRequest { /** * the job image name to deploy * @type {string} * @memberof OrganizationJobAutoDeployRequest */ 'image_name'?: string; /** * the new tag to deploy * @type {string} * @memberof OrganizationJobAutoDeployRequest */ 'tag'?: string; } /** * * @export * @interface OrganizationLabelsGroupAssociatedItemsResponseList */ export interface OrganizationLabelsGroupAssociatedItemsResponseList { /** * * @type {Array} * @memberof OrganizationLabelsGroupAssociatedItemsResponseList */ 'results'?: Array; } /** * * @export * @interface OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ export interface OrganizationLabelsGroupAssociatedItemsResponseListResultsInner { /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'cluster_id'?: string; /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'cluster_name'?: string; /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'project_id'?: string; /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'project_name'?: string; /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'environment_id'?: string; /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'environment_name'?: string; /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'item_id': string; /** * * @type {string} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'item_name': string; /** * * @type {LabelsGroupAssociatedItemType} * @memberof OrganizationLabelsGroupAssociatedItemsResponseListResultsInner */ 'item_type': LabelsGroupAssociatedItemType; } /** * * @export * @interface OrganizationLabelsGroupCreateRequest */ export interface OrganizationLabelsGroupCreateRequest { /** * name of the labels group * @type {string} * @memberof OrganizationLabelsGroupCreateRequest */ 'name': string; /** * * @type {Array