@scaleway/sdk-kafka 2.1.1

package/dist/v1alpha1/types.gen.d.ts

@@ -0,0 +1,564 @@
+import type { Region as ScwRegion } from '@scaleway/sdk-client';
+export type ClusterStatus = 'unknown_status' | 'ready' | 'creating' | 'configuring' | 'deleting' | 'error' | 'locked' | 'stopped';
+export type ListClustersRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc' | 'status_asc' | 'status_desc';
+export type ListUsersRequestOrderBy = 'name_asc' | 'name_desc';
+export type NodeTypeStock = 'unknown_stock' | 'low_stock' | 'out_of_stock' | 'available';
+export type VolumeType = 'unknown_type' | 'sbs_5k' | 'sbs_15k';
+/**
+ * Private Network details.
+ */
+export interface EndpointPrivateNetworkDetails {
+    /**
+     * UUID of the Private Network.
+     */
+    privateNetworkId: string;
+}
+/**
+ * Public Access details.
+ */
+export interface EndpointPublicDetails {
+}
+export interface VersionAvailableSettingBooleanProperty {
+    defaultValue: boolean;
+}
+export interface VersionAvailableSettingFloatProperty {
+    min: number;
+    max: number;
+    defaultValue: number;
+    unit?: string;
+}
+export interface VersionAvailableSettingIntegerProperty {
+    min: number;
+    max: number;
+    defaultValue: number;
+    unit?: string;
+}
+export interface VersionAvailableSettingStringProperty {
+    stringConstraint?: string;
+    defaultValue: string;
+}
+export interface EndpointSpecPrivateNetworkDetails {
+    /**
+     * UUID of the Private Network.
+     */
+    privateNetworkId: string;
+}
+export interface EndpointSpecPublicDetails {
+}
+export interface ClusterSetting {
+    /**
+     * Name of the setting.
+     */
+    name: string;
+    /**
+     * Boolean value of the setting.
+     *
+     * One-of ('value'): at most one of 'boolValue', 'stringValue', 'intValue', 'floatValue' could be set.
+     */
+    boolValue?: boolean;
+    /**
+     * String value of the setting.
+     *
+     * One-of ('value'): at most one of 'boolValue', 'stringValue', 'intValue', 'floatValue' could be set.
+     */
+    stringValue?: string;
+    /**
+     * Integer value of the setting.
+     *
+     * One-of ('value'): at most one of 'boolValue', 'stringValue', 'intValue', 'floatValue' could be set.
+     */
+    intValue?: number;
+    /**
+     * Float value of the setting.
+     *
+     * One-of ('value'): at most one of 'boolValue', 'stringValue', 'intValue', 'floatValue' could be set.
+     */
+    floatValue?: number;
+}
+export interface Endpoint {
+    /**
+     * UUID of the endpoint.
+     */
+    id: string;
+    /**
+     * List of DNS records of the endpoint.
+     */
+    dnsRecords: string[];
+    /**
+     * TCP port of the endpoint.
+     */
+    port: number;
+    /**
+     * Private Network endpoint details.
+     *
+     * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could be set.
+     */
+    privateNetwork?: EndpointPrivateNetworkDetails;
+    /**
+     * Public endpoint details.
+     *
+     * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could be set.
+     */
+    publicNetwork?: EndpointPublicDetails;
+}
+export interface Volume {
+    /**
+     * Type of volume where data is stored.
+     */
+    type: VolumeType;
+    /**
+     * Volume size.
+     */
+    sizeBytes: number;
+}
+export interface NodeTypeVolumeType {
+    /**
+     * Volume type.
+     */
+    type: VolumeType;
+    /**
+     * The description of the volume.
+     */
+    description: string;
+    /**
+     * Minimum size required for the volume.
+     */
+    minSizeBytes: number;
+    /**
+     * Maximum size required for the volume.
+     */
+    maxSizeBytes: number;
+    /**
+     * Minimum increment level for a Block Storage volume size.
+     */
+    chunkSizeBytes: number;
+}
+export interface VersionAvailableSetting {
+    /**
+     * Kafka cluster setting name.
+     */
+    name: string;
+    /**
+     * Defines whether this setting can be applied without needing a restart.
+     */
+    hotConfigurable: boolean;
+    /**
+     * Setting description.
+     */
+    description: string;
+    /**
+     * Boolean property, if the setting is a boolean.
+     *
+     * One-of ('property'): at most one of 'boolProperty', 'stringProperty', 'intProperty', 'floatProperty' could be set.
+     */
+    boolProperty?: VersionAvailableSettingBooleanProperty;
+    /**
+     * String property, if the setting is a string.
+     *
+     * One-of ('property'): at most one of 'boolProperty', 'stringProperty', 'intProperty', 'floatProperty' could be set.
+     */
+    stringProperty?: VersionAvailableSettingStringProperty;
+    /**
+     * Integer property, if the setting is an integer.
+     *
+     * One-of ('property'): at most one of 'boolProperty', 'stringProperty', 'intProperty', 'floatProperty' could be set.
+     */
+    intProperty?: VersionAvailableSettingIntegerProperty;
+    /**
+     * Float property, if the setting is a float.
+     *
+     * One-of ('property'): at most one of 'boolProperty', 'stringProperty', 'intProperty', 'floatProperty' could be set.
+     */
+    floatProperty?: VersionAvailableSettingFloatProperty;
+}
+export interface CreateClusterRequestVolumeSpec {
+    /**
+     * Volume size.
+     */
+    sizeBytes: number;
+    /**
+     * Type of volume where data is stored.
+     */
+    type: VolumeType;
+}
+export interface EndpointSpec {
+    /**
+     *
+     * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could be set.
+     */
+    publicNetwork?: EndpointSpecPublicDetails;
+    /**
+     *
+     * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could be set.
+     */
+    privateNetwork?: EndpointSpecPrivateNetworkDetails;
+}
+export interface Cluster {
+    /**
+     * UUID of the Kafka cluster.
+     */
+    id: string;
+    /**
+     * Name of the Kafka cluster.
+     */
+    name: string;
+    /**
+     * Project ID the Kafka cluster belongs to.
+     */
+    projectId: string;
+    /**
+     * Organisation ID the Kafka cluster belongs to.
+     */
+    organizationId: string;
+    /**
+     * Status of the Kafka cluster.
+     */
+    status: ClusterStatus;
+    /**
+     * Kafka version of the Kafka cluster.
+     */
+    version: string;
+    /**
+     * List of tags applied to the Kafka cluster.
+     */
+    tags: string[];
+    /**
+     * Advanced settings of the Kafka cluster.
+     */
+    settings: ClusterSetting[];
+    /**
+     * Number of nodes in Kafka cluster.
+     */
+    nodeAmount: number;
+    /**
+     * Node type of the Kafka cluster.
+     */
+    nodeType: string;
+    /**
+     * Volumes of the Kafka cluster.
+     */
+    volume?: Volume;
+    /**
+     * List of Kafka cluster endpoints.
+     */
+    endpoints: Endpoint[];
+    /**
+     * Creation date (must follow the ISO 8601 format).
+     */
+    createdAt?: Date;
+    /**
+     * Last update date (must follow the ISO 8601 format).
+     */
+    updatedAt?: Date;
+    /**
+     * Region the Kafka cluster is in.
+     */
+    region: ScwRegion;
+}
+export interface NodeType {
+    /**
+     * Node type name identifier.
+     */
+    name: string;
+    /**
+     * Current stock status for the node type.
+     */
+    stockStatus: NodeTypeStock;
+    /**
+     * Current specifications of the node type offer.
+     */
+    description: string;
+    /**
+     * Number of virtual CPUs of the node type.
+     */
+    vcpus: number;
+    /**
+     * Quantity of RAM.
+     */
+    memoryBytes: number;
+    /**
+     * Available storage options for the node type.
+     */
+    availableVolumeTypes: NodeTypeVolumeType[];
+    /**
+     * Defines whether the node type is currently disabled.
+     */
+    disabled: boolean;
+    /**
+     * Defines whether the node type is currently in beta.
+     */
+    beta: boolean;
+    /**
+     * Cluster range associated with the node type offer.
+     */
+    clusterRange: string;
+}
+export interface User {
+    username: string;
+}
+export interface Version {
+    /**
+     * Kafka version.
+     */
+    version: string;
+    /**
+     * Date of End of Life for the version.
+     */
+    endOfLifeAt?: Date;
+    /**
+     * Cluster configuration settings you are able to change for clusters running this version. Each item in `available_settings` describes one configurable cluster setting.
+     */
+    availableSettings: VersionAvailableSetting[];
+}
+export type CreateClusterRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * The ID of the Project in which the Kafka cluster will be created.
+     */
+    projectId?: string;
+    /**
+     * Name of the Kafka cluster.
+     */
+    name?: string;
+    /**
+     * Version of Kafka.
+     */
+    version: string;
+    /**
+     * Tags to apply to the Kafka cluster.
+     */
+    tags?: string[];
+    /**
+     * Number of nodes to use for the Kafka cluster.
+     */
+    nodeAmount: number;
+    /**
+     * Type of node to use for the Kafka cluster.
+     */
+    nodeType: string;
+    /**
+     * Kafka volume information.
+     */
+    volume?: CreateClusterRequestVolumeSpec;
+    /**
+     * One or multiple EndpointSpec used to expose your Kafka cluster.
+     */
+    endpoints?: EndpointSpec[];
+    /**
+     * Username for the kafka user.
+     */
+    userName?: string;
+    /**
+     * Password for the kafka user.
+     */
+    password?: string;
+};
+export type CreateEndpointRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Kafka Cluster.
+     */
+    clusterId: string;
+    /**
+     * Endpoint object (`EndpointSpec`) used to expose your Kafka EndpointSpec.
+     */
+    endpoint: EndpointSpec;
+};
+export type DeleteClusterRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Kafka Cluster to delete.
+     */
+    clusterId: string;
+};
+export type DeleteEndpointRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the endpoint to delete.
+     */
+    endpointId: string;
+};
+export type GetClusterCertificateAuthorityRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Kafka Cluster.
+     */
+    clusterId: string;
+};
+export type GetClusterRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Kafka Cluster.
+     */
+    clusterId: string;
+};
+export type ListClustersRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * List Kafka cluster with a given tag.
+     */
+    tags?: string[];
+    /**
+     * Lists Kafka clusters that match a name pattern.
+     */
+    name?: string;
+    /**
+     * Criteria to use when ordering Kafka cluster listings.
+     */
+    orderBy?: ListClustersRequestOrderBy;
+    /**
+     * Organization ID of the Kafka cluster.
+     */
+    organizationId?: string;
+    /**
+     * Project ID.
+     */
+    projectId?: string;
+    page?: number;
+    pageSize?: number;
+};
+export interface ListClustersResponse {
+    /**
+     * List of all Kafka cluster available in an Organization or Project.
+     */
+    clusters: Cluster[];
+    /**
+     * Total count of Kafka cluster available in an Organization or Project.
+     */
+    totalCount: number;
+}
+export type ListNodeTypesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Defines whether or not to include disabled types.
+     */
+    includeDisabledTypes?: boolean;
+    page?: number;
+    pageSize?: number;
+};
+export interface ListNodeTypesResponse {
+    /**
+     * Types of the node.
+     */
+    nodeTypes: NodeType[];
+    /**
+     * Total count of node types available.
+     */
+    totalCount: number;
+}
+export type ListUsersRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    clusterId: string;
+    page?: number;
+    pageSize?: number;
+    orderBy?: ListUsersRequestOrderBy;
+    name?: string;
+};
+export interface ListUsersResponse {
+    users: User[];
+    totalCount: number;
+}
+export type ListVersionsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Kafka version to filter for.
+     */
+    version?: string;
+    /**
+     * The page number to return, from the paginated results.
+     */
+    page?: number;
+    /**
+     * The number of items to return.
+     */
+    pageSize?: number;
+};
+export interface ListVersionsResponse {
+    /**
+     * Available Kafka versions.
+     */
+    versions: Version[];
+    /**
+     * Total count of Kafka versions available.
+     */
+    totalCount: number;
+}
+export type RenewClusterCertificateAuthorityRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Kafka Cluster.
+     */
+    clusterId: string;
+};
+export type UpdateClusterRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Kafka Clusters to update.
+     */
+    clusterId: string;
+    /**
+     * Name of the Kafka Cluster.
+     */
+    name?: string;
+    /**
+     * Tags of a Kafka Cluster.
+     */
+    tags?: string[];
+};
+/**
+ * Update a user of a Kafka cluster.
+ */
+export type UpdateUserRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * ID of the cluster in which to update the user's password.
+     */
+    clusterId: string;
+    /**
+     * Username of the Kafka cluster user.
+     */
+    username: string;
+    /**
+     * New password for the Kafka cluster user.
+     */
+    password?: string;
+};

package/dist/v1alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,95 @@
+export declare const CreateClusterRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    nodeAmount: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    nodeType: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    password: {
+        maxLength: number;
+        minLength: number;
+    };
+    userName: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    version: {
+        pattern: RegExp;
+    };
+};
+export declare const ListClustersRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListNodeTypesRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListUsersRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListVersionsRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    version: {
+        pattern: RegExp;
+    };
+};
+export declare const UpdateClusterRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};
+export declare const UpdateUserRequest: {
+    password: {
+        maxLength: number;
+        minLength: number;
+    };
+    username: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};