oci-lustrefilestorage 2.106.2

package/lib/client.d.ts

@@ -0,0 +1,204 @@
+/**
+ * File Storage with Lustre API
+ * Use the File Storage with Lustre API to manage Lustre file systems and related resources. For more information, see [File Storage with Lustre](https://docs.oracle.com/iaas/Content/lustre/home.htm).
+ * OpenAPI spec version: 20250228
+ *
+ *
+ * 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 { LustreFileStorageWaiter } from "./lustrefilestorage-waiter";
+declare const Breaker: any;
+export declare enum LustreFileStorageApiKeys {
+}
+/**
+ * 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 LustreFileStorageClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": LustreFileStorageWaiter;
+    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 LustreFileStorageWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): LustreFileStorageWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): LustreFileStorageWaiter;
+    /**
+     * 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/lustrefilestorage/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * Moves a Lustre file system 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 ChangeLustreFileSystemCompartmentRequest
+     * @return ChangeLustreFileSystemCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/lustrefilestorage/ChangeLustreFileSystemCompartment.ts.html |here} to see how to use ChangeLustreFileSystemCompartment API.
+     */
+    changeLustreFileSystemCompartment(changeLustreFileSystemCompartmentRequest: requests.ChangeLustreFileSystemCompartmentRequest): Promise<responses.ChangeLustreFileSystemCompartmentResponse>;
+    /**
+     * Creates a Lustre file system.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateLustreFileSystemRequest
+     * @return CreateLustreFileSystemResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/lustrefilestorage/CreateLustreFileSystem.ts.html |here} to see how to use CreateLustreFileSystem API.
+     */
+    createLustreFileSystem(createLustreFileSystemRequest: requests.CreateLustreFileSystemRequest): Promise<responses.CreateLustreFileSystemResponse>;
+    /**
+     * Deletes a Lustre file system.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteLustreFileSystemRequest
+     * @return DeleteLustreFileSystemResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/lustrefilestorage/DeleteLustreFileSystem.ts.html |here} to see how to use DeleteLustreFileSystem API.
+     */
+    deleteLustreFileSystem(deleteLustreFileSystemRequest: requests.DeleteLustreFileSystemRequest): Promise<responses.DeleteLustreFileSystemResponse>;
+    /**
+     * Gets information about a Lustre file system.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetLustreFileSystemRequest
+     * @return GetLustreFileSystemResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/lustrefilestorage/GetLustreFileSystem.ts.html |here} to see how to use GetLustreFileSystem API.
+     */
+    getLustreFileSystem(getLustreFileSystemRequest: requests.GetLustreFileSystemRequest): Promise<responses.GetLustreFileSystemResponse>;
+    /**
+     * 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/lustrefilestorage/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Gets a list of Lustre file systems.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListLustreFileSystemsRequest
+     * @return ListLustreFileSystemsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/lustrefilestorage/ListLustreFileSystems.ts.html |here} to see how to use ListLustreFileSystems API.
+     */
+    listLustreFileSystems(listLustreFileSystemsRequest: requests.ListLustreFileSystemsRequest): Promise<responses.ListLustreFileSystemsResponse>;
+    /**
+     * 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/lustrefilestorage/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/lustrefilestorage/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/lustrefilestorage/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Updates a Lustre file system.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateLustreFileSystemRequest
+     * @return UpdateLustreFileSystemResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/lustrefilestorage/UpdateLustreFileSystem.ts.html |here} to see how to use UpdateLustreFileSystem API.
+     */
+    updateLustreFileSystem(updateLustreFileSystemRequest: requests.UpdateLustreFileSystemRequest): Promise<responses.UpdateLustreFileSystemResponse>;
+}
+export {};