/** * Functions Service API * API for the Functions service. * OpenAPI spec version: 20181201 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, 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 model from "./model"; import * as responses from "./response"; import { FunctionsManagementWaiter } from "./functionsmanagement-waiter"; declare const Breaker: any; export declare enum FunctionsInvokeApiKeys { } /** * 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 FunctionsInvokeClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: 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); /** * 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; /** * Invokes a function * This operation does not retry by default if the user has not defined a retry configuration. * @param InvokeFunctionRequest * @return InvokeFunctionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/InvokeFunction.ts.html |here} to see how to use InvokeFunction API. */ invokeFunction(invokeFunctionRequest: requests.InvokeFunctionRequest): Promise; } export declare enum FunctionsManagementApiKeys { } /** * 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 FunctionsManagementClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": FunctionsManagementWaiter; 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 FunctionsManagementWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): FunctionsManagementWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): FunctionsManagementWaiter; /** * 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; /** * Moves an application into a different compartment within the same tenancy. * For information about moving resources between compartments, see [Moving Resources Between Compartments](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 ChangeApplicationCompartmentRequest * @return ChangeApplicationCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/ChangeApplicationCompartment.ts.html |here} to see how to use ChangeApplicationCompartment API. */ changeApplicationCompartment(changeApplicationCompartmentRequest: requests.ChangeApplicationCompartmentRequest): Promise; /** * Creates a new application. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateApplicationRequest * @return CreateApplicationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/CreateApplication.ts.html |here} to see how to use CreateApplication API. */ createApplication(createApplicationRequest: requests.CreateApplicationRequest): Promise; /** * Creates a new function. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateFunctionRequest * @return CreateFunctionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/CreateFunction.ts.html |here} to see how to use CreateFunction API. */ createFunction(createFunctionRequest: requests.CreateFunctionRequest): Promise; /** * Deletes an application. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteApplicationRequest * @return DeleteApplicationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/DeleteApplication.ts.html |here} to see how to use DeleteApplication API. */ deleteApplication(deleteApplicationRequest: requests.DeleteApplicationRequest): Promise; /** * Deletes a function. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteFunctionRequest * @return DeleteFunctionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/DeleteFunction.ts.html |here} to see how to use DeleteFunction API. */ deleteFunction(deleteFunctionRequest: requests.DeleteFunctionRequest): Promise; /** * Retrieves an application. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetApplicationRequest * @return GetApplicationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/GetApplication.ts.html |here} to see how to use GetApplication API. */ getApplication(getApplicationRequest: requests.GetApplicationRequest): Promise; /** * Retrieves a function. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetFunctionRequest * @return GetFunctionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/GetFunction.ts.html |here} to see how to use GetFunction API. */ getFunction(getFunctionRequest: requests.GetFunctionRequest): Promise; /** * Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetPbfListingRequest * @return GetPbfListingResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/GetPbfListing.ts.html |here} to see how to use GetPbfListing API. */ getPbfListing(getPbfListingRequest: requests.GetPbfListingRequest): Promise; /** * Gets a PbfListingVersion by identifier for a PbfListing. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetPbfListingVersionRequest * @return GetPbfListingVersionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/GetPbfListingVersion.ts.html |here} to see how to use GetPbfListingVersion API. */ getPbfListingVersion(getPbfListingVersionRequest: requests.GetPbfListingVersionRequest): Promise; /** * Lists applications for a compartment. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListApplicationsRequest * @return ListApplicationsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/ListApplications.ts.html |here} to see how to use ListApplications API. */ listApplications(listApplicationsRequest: requests.ListApplicationsRequest): Promise; /** * NOTE: This function is deprecated in favor of listApplicationsRecordIterator function. * Creates a new async iterator which will iterate over the models.ApplicationSummary objects * contained in responses from the listApplications operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllApplications(request: requests.ListApplicationsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listApplicationsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listApplications operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllApplicationsResponses(request: requests.ListApplicationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ApplicationSummary objects * contained in responses from the listApplications operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listApplicationsRecordIterator(request: requests.ListApplicationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listApplications operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listApplicationsResponseIterator(request: requests.ListApplicationsRequest): AsyncIterableIterator; /** * Lists functions for an application. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListFunctionsRequest * @return ListFunctionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/ListFunctions.ts.html |here} to see how to use ListFunctions API. */ listFunctions(listFunctionsRequest: requests.ListFunctionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listFunctionsRecordIterator function. * Creates a new async iterator which will iterate over the models.FunctionSummary objects * contained in responses from the listFunctions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllFunctions(request: requests.ListFunctionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listFunctionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listFunctions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllFunctionsResponses(request: requests.ListFunctionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.FunctionSummary objects * contained in responses from the listFunctions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listFunctionsRecordIterator(request: requests.ListFunctionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listFunctions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listFunctionsResponseIterator(request: requests.ListFunctionsRequest): AsyncIterableIterator; /** * Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection * containing an array of PbfListingVersionSummary response models. *

Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall * be thrown. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListPbfListingVersionsRequest * @return ListPbfListingVersionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/ListPbfListingVersions.ts.html |here} to see how to use ListPbfListingVersions API. */ listPbfListingVersions(listPbfListingVersionsRequest: requests.ListPbfListingVersionsRequest): Promise; /** * Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing * an array of PbfListingSummary response models. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListPbfListingsRequest * @return ListPbfListingsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/ListPbfListings.ts.html |here} to see how to use ListPbfListings API. */ listPbfListings(listPbfListingsRequest: requests.ListPbfListingsRequest): Promise; /** * Returns a list of Triggers. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListTriggersRequest * @return ListTriggersResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/ListTriggers.ts.html |here} to see how to use ListTriggers API. */ listTriggers(listTriggersRequest: requests.ListTriggersRequest): Promise; /** * Modifies an application * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateApplicationRequest * @return UpdateApplicationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/UpdateApplication.ts.html |here} to see how to use UpdateApplication API. */ updateApplication(updateApplicationRequest: requests.UpdateApplicationRequest): Promise; /** * Modifies a function * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateFunctionRequest * @return UpdateFunctionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/functions/UpdateFunction.ts.html |here} to see how to use UpdateFunction API. */ updateFunction(updateFunctionRequest: requests.UpdateFunctionRequest): Promise; } export {};