Package com.oracle.bmc.functions

Interface FunctionsManagement

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    FunctionsManagementClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public interface FunctionsManagement
extends AutoCloseable
    API for the Functions service.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        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 - flag to enable the use of realm specific endpoint template

      • changeApplicationCompartment

        ChangeApplicationCompartmentResponse changeApplicationCompartment​(ChangeApplicationCompartmentRequest request)
        Moves an application into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources Between Compartments.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/ChangeApplicationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeApplicationCompartment API.

      • createApplication

        CreateApplicationResponse createApplication​(CreateApplicationRequest request)
        Creates a new application.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/CreateApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateApplication API.

      • createFunction

        CreateFunctionResponse createFunction​(CreateFunctionRequest request)
        Creates a new function.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/CreateFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateFunction API.

      • deleteApplication

        DeleteApplicationResponse deleteApplication​(DeleteApplicationRequest request)
        Deletes an application.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/DeleteApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteApplication API.

      • deleteFunction

        DeleteFunctionResponse deleteFunction​(DeleteFunctionRequest request)
        Deletes a function.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/DeleteFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteFunction API.

      • getApplication

        GetApplicationResponse getApplication​(GetApplicationRequest request)
        Retrieves an application.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/GetApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetApplication API.

      • getFunction

        GetFunctionResponse getFunction​(GetFunctionRequest request)
        Retrieves a function.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/GetFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFunction API.

      • getPbfListing

        GetPbfListingResponse getPbfListing​(GetPbfListingRequest request)
        Fetches a Pre-built Function(PBF) Listing.

        Returns a PbfListing response model.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/GetPbfListingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPbfListing API.

      • getPbfListingVersion

        GetPbfListingVersionResponse getPbfListingVersion​(GetPbfListingVersionRequest request)
        Gets a PbfListingVersion by identifier for a PbfListing.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/GetPbfListingVersionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPbfListingVersion API.

      • listApplications

        ListApplicationsResponse listApplications​(ListApplicationsRequest request)
        Lists applications for a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/ListApplicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListApplications API.

      • listFunctions

        ListFunctionsResponse listFunctions​(ListFunctionsRequest request)
        Lists functions for an application.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/ListFunctionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFunctions API.

      • listPbfListingVersions

        ListPbfListingVersionsResponse listPbfListingVersions​(ListPbfListingVersionsRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/ListPbfListingVersionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPbfListingVersions API.

      • listPbfListings

        ListPbfListingsResponse listPbfListings​(ListPbfListingsRequest request)
        Fetches a wrapped list of all Pre-built Function(PBF) Listings.

        Returns a PbfListingCollection containing an array of PbfListingSummary response models.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/ListPbfListingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPbfListings API.

      • listTriggers

        ListTriggersResponse listTriggers​(ListTriggersRequest request)
        Returns a list of Triggers.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/ListTriggersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTriggers API.

      • updateApplication

        UpdateApplicationResponse updateApplication​(UpdateApplicationRequest request)
        Modifies an application
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/UpdateApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateApplication API.

      • updateFunction

        UpdateFunctionResponse updateFunction​(UpdateFunctionRequest request)
        Modifies a function
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/UpdateFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateFunction API.

      • getWaiters

        FunctionsManagementWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        FunctionsManagementPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.