oci-jmsutils 2.118.0

package/lib/client.d.ts

@@ -0,0 +1,270 @@
+/**
+ * Java Management Service Utilities API
+ * The APIs for Analyze Applications and other utilities of Java Management Service.
+ * OpenAPI spec version: 20250521
+ *
+ *
+ * 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 { JmsUtilsWaiter } from "./jmsutils-waiter";
+declare const Breaker: any;
+export declare enum JmsUtilsApiKeys {
+}
+/**
+ * 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 JmsUtilsClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": JmsUtilsWaiter;
+    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 JmsUtilsWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): JmsUtilsWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): JmsUtilsWaiter;
+    /**
+     * 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/jmsutils/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * Deletes a Java Migration Analysis.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteJavaMigrationAnalysisRequest
+     * @return DeleteJavaMigrationAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/DeleteJavaMigrationAnalysis.ts.html |here} to see how to use DeleteJavaMigrationAnalysis API.
+     */
+    deleteJavaMigrationAnalysis(deleteJavaMigrationAnalysisRequest: requests.DeleteJavaMigrationAnalysisRequest): Promise<responses.DeleteJavaMigrationAnalysisResponse>;
+    /**
+     * Deletes a Performance Tuning Analysis.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeletePerformanceTuningAnalysisRequest
+     * @return DeletePerformanceTuningAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/DeletePerformanceTuningAnalysis.ts.html |here} to see how to use DeletePerformanceTuningAnalysis API.
+     */
+    deletePerformanceTuningAnalysis(deletePerformanceTuningAnalysisRequest: requests.DeletePerformanceTuningAnalysisRequest): Promise<responses.DeletePerformanceTuningAnalysisResponse>;
+    /**
+     * Returns the configuration for analyzing applications.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetAnalyzeApplicationsConfigurationRequest
+     * @return GetAnalyzeApplicationsConfigurationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/GetAnalyzeApplicationsConfiguration.ts.html |here} to see how to use GetAnalyzeApplicationsConfiguration API.
+     */
+    getAnalyzeApplicationsConfiguration(getAnalyzeApplicationsConfigurationRequest: requests.GetAnalyzeApplicationsConfigurationRequest): Promise<responses.GetAnalyzeApplicationsConfigurationResponse>;
+    /**
+     * Gets information about a Java Migration Analysis.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetJavaMigrationAnalysisRequest
+     * @return GetJavaMigrationAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/GetJavaMigrationAnalysis.ts.html |here} to see how to use GetJavaMigrationAnalysis API.
+     */
+    getJavaMigrationAnalysis(getJavaMigrationAnalysisRequest: requests.GetJavaMigrationAnalysisRequest): Promise<responses.GetJavaMigrationAnalysisResponse>;
+    /**
+     * Gets information about a Performance Tuning Analysis.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetPerformanceTuningAnalysisRequest
+     * @return GetPerformanceTuningAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/GetPerformanceTuningAnalysis.ts.html |here} to see how to use GetPerformanceTuningAnalysis API.
+     */
+    getPerformanceTuningAnalysis(getPerformanceTuningAnalysisRequest: requests.GetPerformanceTuningAnalysisRequest): Promise<responses.GetPerformanceTuningAnalysisResponse>;
+    /**
+     * Returns the configuration for subscription acknowledgment.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetSubscriptionAcknowledgmentConfigurationRequest
+     * @return GetSubscriptionAcknowledgmentConfigurationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/GetSubscriptionAcknowledgmentConfiguration.ts.html |here} to see how to use GetSubscriptionAcknowledgmentConfiguration API.
+     */
+    getSubscriptionAcknowledgmentConfiguration(getSubscriptionAcknowledgmentConfigurationRequest: requests.GetSubscriptionAcknowledgmentConfigurationRequest): Promise<responses.GetSubscriptionAcknowledgmentConfigurationResponse>;
+    /**
+     * 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/jmsutils/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Gets a list of Java Migration Analysis.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListJavaMigrationAnalysisRequest
+     * @return ListJavaMigrationAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/ListJavaMigrationAnalysis.ts.html |here} to see how to use ListJavaMigrationAnalysis API.
+     */
+    listJavaMigrationAnalysis(listJavaMigrationAnalysisRequest: requests.ListJavaMigrationAnalysisRequest): Promise<responses.ListJavaMigrationAnalysisResponse>;
+    /**
+     * Gets a list of Performance tuning Analysis.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListPerformanceTuningAnalysisRequest
+     * @return ListPerformanceTuningAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/ListPerformanceTuningAnalysis.ts.html |here} to see how to use ListPerformanceTuningAnalysis API.
+     */
+    listPerformanceTuningAnalysis(listPerformanceTuningAnalysisRequest: requests.ListPerformanceTuningAnalysisRequest): Promise<responses.ListPerformanceTuningAnalysisResponse>;
+    /**
+     * Retrieve a paginated list of work items for a specified work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkItemsRequest
+     * @return ListWorkItemsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/ListWorkItems.ts.html |here} to see how to use ListWorkItems API.
+     */
+    listWorkItems(listWorkItemsRequest: requests.ListWorkItemsRequest): Promise<responses.ListWorkItemsResponse>;
+    /**
+     * 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/jmsutils/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/jmsutils/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/jmsutils/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Requests Java Migration Analysis.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param RequestJavaMigrationAnalysisRequest
+     * @return RequestJavaMigrationAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/RequestJavaMigrationAnalysis.ts.html |here} to see how to use RequestJavaMigrationAnalysis API.
+     */
+    requestJavaMigrationAnalysis(requestJavaMigrationAnalysisRequest: requests.RequestJavaMigrationAnalysisRequest): Promise<responses.RequestJavaMigrationAnalysisResponse>;
+    /**
+     * Requests Performance Tuning Analysis.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param RequestPerformanceTuningAnalysisRequest
+     * @return RequestPerformanceTuningAnalysisResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/RequestPerformanceTuningAnalysis.ts.html |here} to see how to use RequestPerformanceTuningAnalysis API.
+     */
+    requestPerformanceTuningAnalysis(requestPerformanceTuningAnalysisRequest: requests.RequestPerformanceTuningAnalysisRequest): Promise<responses.RequestPerformanceTuningAnalysisResponse>;
+    /**
+     * Updates the configuration for analyze application.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateAnalyzeApplicationsConfigurationRequest
+     * @return UpdateAnalyzeApplicationsConfigurationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/UpdateAnalyzeApplicationsConfiguration.ts.html |here} to see how to use UpdateAnalyzeApplicationsConfiguration API.
+     */
+    updateAnalyzeApplicationsConfiguration(updateAnalyzeApplicationsConfigurationRequest: requests.UpdateAnalyzeApplicationsConfigurationRequest): Promise<responses.UpdateAnalyzeApplicationsConfigurationResponse>;
+    /**
+     * Updates the configuration for subscription acknowledgment.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateSubscriptionAcknowledgmentConfigurationRequest
+     * @return UpdateSubscriptionAcknowledgmentConfigurationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/jmsutils/UpdateSubscriptionAcknowledgmentConfiguration.ts.html |here} to see how to use UpdateSubscriptionAcknowledgmentConfiguration API.
+     */
+    updateSubscriptionAcknowledgmentConfiguration(updateSubscriptionAcknowledgmentConfigurationRequest: requests.UpdateSubscriptionAcknowledgmentConfigurationRequest): Promise<responses.UpdateSubscriptionAcknowledgmentConfigurationResponse>;
+}
+export {};