Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FunctionsManagementClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • FunctionsManagementClient

Constructors

constructor

  • new FunctionsManagementClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): FunctionsManagementClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "FunctionsManagement"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://functions.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • 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}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeApplicationCompartment

close

  • close(): void

createApplication

createFunction

  • Creates a new function. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateFunction API.

    Parameters

    Returns Promise<CreateFunctionResponse>

    CreateFunctionResponse

createWaiters

deleteApplication

deleteFunction

  • Deletes a function. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteFunction API.

    Parameters

    Returns Promise<DeleteFunctionResponse>

    DeleteFunctionResponse

getApplication

  • Retrieves an application. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetApplication API.

    Parameters

    Returns Promise<GetApplicationResponse>

    GetApplicationResponse

getFunction

  • Retrieves a function. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetFunction API.

    Parameters

    Returns Promise<GetFunctionResponse>

    GetFunctionResponse

getPbfListing

  • 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.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPbfListing API.

    Parameters

    Returns Promise<GetPbfListingResponse>

    GetPbfListingResponse

getPbfListingVersion

  • 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.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPbfListingVersion API.

    Parameters

    Returns Promise<GetPbfListingVersionResponse>

    GetPbfListingVersionResponse

getWaiters

listAllApplications

  • 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.

    Parameters

    Returns AsyncIterableIterator<ApplicationSummary>

listAllApplicationsResponses

  • 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.

    Parameters

    Returns AsyncIterableIterator<ListApplicationsResponse>

listAllFunctions

  • 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.

    Parameters

    Returns AsyncIterableIterator<FunctionSummary>

listAllFunctionsResponses

  • 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.

    Parameters

    Returns AsyncIterableIterator<ListFunctionsResponse>

listApplications

  • Lists applications for a compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListApplications API.

    Parameters

    Returns Promise<ListApplicationsResponse>

    ListApplicationsResponse

listApplicationsRecordIterator

  • 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.

    Parameters

    Returns AsyncIterableIterator<ApplicationSummary>

listApplicationsResponseIterator

listFunctions

  • Lists functions for an application. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFunctions API.

    Parameters

    Returns Promise<ListFunctionsResponse>

    ListFunctionsResponse

listFunctionsRecordIterator

  • 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.

    Parameters

    Returns AsyncIterableIterator<FunctionSummary>

listFunctionsResponseIterator

listPbfListingVersions

  • 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.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPbfListingVersions API.

    Parameters

    Returns Promise<ListPbfListingVersionsResponse>

    ListPbfListingVersionsResponse

listPbfListings

  • 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.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPbfListings API.

    Parameters

    Returns Promise<ListPbfListingsResponse>

    ListPbfListingsResponse

listTriggers

  • Returns a list of Triggers.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTriggers API.

    Parameters

    Returns Promise<ListTriggersResponse>

    ListTriggersResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateApplication

updateFunction

  • Modifies a function This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateFunction API.

    Parameters

    Returns Promise<UpdateFunctionResponse>

    UpdateFunctionResponse