oci-managedkafka 2.116.1

package/lib/client.d.ts

@@ -0,0 +1,310 @@
+/**
+ * Oracle Streaming with Apache Kafka (OSAK) API
+ * Use Oracle Streaming with Apache Kafka Control Plane API to create/update/delete managed Kafka clusters.
+ * OpenAPI spec version: 20240901
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2025, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as responses from "./response";
+import { KafkaClusterWaiter } from "./kafkacluster-waiter";
+declare const Breaker: any;
+export declare enum KafkaClusterApiKeys {
+}
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+export declare class KafkaClusterClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": KafkaClusterWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: typeof Breaker | null;
+    protected _httpOptions: any;
+    protected _bodyDuplexMode: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    protected _httpClient: common.HttpClient;
+    protected _authProvider: common.AuthenticationDetailsProvider | undefined;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Determines whether realm specific endpoint should be used or not.
+     * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
+     * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+     */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Creates a new KafkaClusterWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): KafkaClusterWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): KafkaClusterWaiter;
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker(): void;
+    /**
+     * Close the provider if possible which in turn shuts down any associated circuit breaker
+     */
+    closeProvider(): void;
+    /**
+     * Close the client once it is no longer needed
+     */
+    close(): void;
+    /**
+     * Cancels a work request.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CancelWorkRequestRequest
+     * @return CancelWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * Moves a KafkaCluster into a different compartment within the same tenancy. For information about moving resources between
+     * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ChangeKafkaClusterCompartmentRequest
+     * @return ChangeKafkaClusterCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ChangeKafkaClusterCompartment.ts.html |here} to see how to use ChangeKafkaClusterCompartment API.
+     */
+    changeKafkaClusterCompartment(changeKafkaClusterCompartmentRequest: requests.ChangeKafkaClusterCompartmentRequest): Promise<responses.ChangeKafkaClusterCompartmentResponse>;
+    /**
+     * Moves a KafkaClusterConfig into a different compartment within the same tenancy. For information about moving resources between
+     * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ChangeKafkaClusterConfigCompartmentRequest
+     * @return ChangeKafkaClusterConfigCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ChangeKafkaClusterConfigCompartment.ts.html |here} to see how to use ChangeKafkaClusterConfigCompartment API.
+     */
+    changeKafkaClusterConfigCompartment(changeKafkaClusterConfigCompartmentRequest: requests.ChangeKafkaClusterConfigCompartmentRequest): Promise<responses.ChangeKafkaClusterConfigCompartmentResponse>;
+    /**
+     * Creates a KafkaCluster.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateKafkaClusterRequest
+     * @return CreateKafkaClusterResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/CreateKafkaCluster.ts.html |here} to see how to use CreateKafkaCluster API.
+     */
+    createKafkaCluster(createKafkaClusterRequest: requests.CreateKafkaClusterRequest): Promise<responses.CreateKafkaClusterResponse>;
+    /**
+     * Creates a KafkaClusterConfig.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateKafkaClusterConfigRequest
+     * @return CreateKafkaClusterConfigResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/CreateKafkaClusterConfig.ts.html |here} to see how to use CreateKafkaClusterConfig API.
+     */
+    createKafkaClusterConfig(createKafkaClusterConfigRequest: requests.CreateKafkaClusterConfigRequest): Promise<responses.CreateKafkaClusterConfigResponse>;
+    /**
+     * Deletes a KafkaCluster.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteKafkaClusterRequest
+     * @return DeleteKafkaClusterResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/DeleteKafkaCluster.ts.html |here} to see how to use DeleteKafkaCluster API.
+     */
+    deleteKafkaCluster(deleteKafkaClusterRequest: requests.DeleteKafkaClusterRequest): Promise<responses.DeleteKafkaClusterResponse>;
+    /**
+     * Deletes a KafkaClusterConfig.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteKafkaClusterConfigRequest
+     * @return DeleteKafkaClusterConfigResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/DeleteKafkaClusterConfig.ts.html |here} to see how to use DeleteKafkaClusterConfig API.
+     */
+    deleteKafkaClusterConfig(deleteKafkaClusterConfigRequest: requests.DeleteKafkaClusterConfigRequest): Promise<responses.DeleteKafkaClusterConfigResponse>;
+    /**
+     * Deletes a KafkaClusterConfig version.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteKafkaClusterConfigVersionRequest
+     * @return DeleteKafkaClusterConfigVersionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/DeleteKafkaClusterConfigVersion.ts.html |here} to see how to use DeleteKafkaClusterConfigVersion API.
+     */
+    deleteKafkaClusterConfigVersion(deleteKafkaClusterConfigVersionRequest: requests.DeleteKafkaClusterConfigVersionRequest): Promise<responses.DeleteKafkaClusterConfigVersionResponse>;
+    /**
+     * Removes the SASL superuser to the Kafka cluster.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DisableSuperuserRequest
+     * @return DisableSuperuserResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/DisableSuperuser.ts.html |here} to see how to use DisableSuperuser API.
+     */
+    disableSuperuser(disableSuperuserRequest: requests.DisableSuperuserRequest): Promise<responses.DisableSuperuserResponse>;
+    /**
+     * Adds a SASL superuser to the Kafka cluster. A generated password will be updated to the specified vault.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param EnableSuperuserRequest
+     * @return EnableSuperuserResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/EnableSuperuser.ts.html |here} to see how to use EnableSuperuser API.
+     */
+    enableSuperuser(enableSuperuserRequest: requests.EnableSuperuserRequest): Promise<responses.EnableSuperuserResponse>;
+    /**
+     * Gets information about a KafkaCluster.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetKafkaClusterRequest
+     * @return GetKafkaClusterResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/GetKafkaCluster.ts.html |here} to see how to use GetKafkaCluster API.
+     */
+    getKafkaCluster(getKafkaClusterRequest: requests.GetKafkaClusterRequest): Promise<responses.GetKafkaClusterResponse>;
+    /**
+     * Gets information about a KafkaClusterConfig.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetKafkaClusterConfigRequest
+     * @return GetKafkaClusterConfigResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/GetKafkaClusterConfig.ts.html |here} to see how to use GetKafkaClusterConfig API.
+     */
+    getKafkaClusterConfig(getKafkaClusterConfigRequest: requests.GetKafkaClusterConfigRequest): Promise<responses.GetKafkaClusterConfigResponse>;
+    /**
+     * Gets information about a KafkaClusterConfig version.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetKafkaClusterConfigVersionRequest
+     * @return GetKafkaClusterConfigVersionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/GetKafkaClusterConfigVersion.ts.html |here} to see how to use GetKafkaClusterConfigVersion API.
+     */
+    getKafkaClusterConfigVersion(getKafkaClusterConfigVersionRequest: requests.GetKafkaClusterConfigVersionRequest): Promise<responses.GetKafkaClusterConfigVersionResponse>;
+    /**
+     * Gets the details of a work request.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetWorkRequestRequest
+     * @return GetWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Gets a list of KafkaClusterConfig Versions.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListKafkaClusterConfigVersionsRequest
+     * @return ListKafkaClusterConfigVersionsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ListKafkaClusterConfigVersions.ts.html |here} to see how to use ListKafkaClusterConfigVersions API.
+     */
+    listKafkaClusterConfigVersions(listKafkaClusterConfigVersionsRequest: requests.ListKafkaClusterConfigVersionsRequest): Promise<responses.ListKafkaClusterConfigVersionsResponse>;
+    /**
+     * Gets a list of KafkaClusterConfigs.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListKafkaClusterConfigsRequest
+     * @return ListKafkaClusterConfigsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ListKafkaClusterConfigs.ts.html |here} to see how to use ListKafkaClusterConfigs API.
+     */
+    listKafkaClusterConfigs(listKafkaClusterConfigsRequest: requests.ListKafkaClusterConfigsRequest): Promise<responses.ListKafkaClusterConfigsResponse>;
+    /**
+     * Gets a list of KafkaClusters.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListKafkaClustersRequest
+     * @return ListKafkaClustersResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ListKafkaClusters.ts.html |here} to see how to use ListKafkaClusters API.
+     */
+    listKafkaClusters(listKafkaClustersRequest: requests.ListKafkaClustersRequest): Promise<responses.ListKafkaClustersResponse>;
+    /**
+     * Lists the errors for a work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestErrorsRequest
+     * @return ListWorkRequestErrorsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     */
+    listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
+    /**
+     * Lists the logs for a work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestLogsRequest
+     * @return ListWorkRequestLogsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     */
+    listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
+    /**
+     * Lists the work requests in a compartment.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestsRequest
+     * @return ListWorkRequestsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Updates a KafkaCluster.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateKafkaClusterRequest
+     * @return UpdateKafkaClusterResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/UpdateKafkaCluster.ts.html |here} to see how to use UpdateKafkaCluster API.
+     */
+    updateKafkaCluster(updateKafkaClusterRequest: requests.UpdateKafkaClusterRequest): Promise<responses.UpdateKafkaClusterResponse>;
+    /**
+     * Updates a KafkaClusterConfig.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateKafkaClusterConfigRequest
+     * @return UpdateKafkaClusterConfigResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/managedkafka/UpdateKafkaClusterConfig.ts.html |here} to see how to use UpdateKafkaClusterConfig API.
+     */
+    updateKafkaClusterConfig(updateKafkaClusterConfigRequest: requests.UpdateKafkaClusterConfigRequest): Promise<responses.UpdateKafkaClusterConfigResponse>;
+}
+export {};