Interface FunctionsManagementAsync

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

        Future<CreateApplicationResponse> createApplication​(CreateApplicationRequest request,
                                                            AsyncHandler<CreateApplicationRequest,​CreateApplicationResponse> handler)
        Creates a new application.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • createFunction

        Future<CreateFunctionResponse> createFunction​(CreateFunctionRequest request,
                                                      AsyncHandler<CreateFunctionRequest,​CreateFunctionResponse> handler)
        Creates a new function.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • deleteApplication

        Future<DeleteApplicationResponse> deleteApplication​(DeleteApplicationRequest request,
                                                            AsyncHandler<DeleteApplicationRequest,​DeleteApplicationResponse> handler)
        Deletes an application.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • deleteFunction

        Future<DeleteFunctionResponse> deleteFunction​(DeleteFunctionRequest request,
                                                      AsyncHandler<DeleteFunctionRequest,​DeleteFunctionResponse> handler)
        Deletes a function.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • getApplication

        Future<GetApplicationResponse> getApplication​(GetApplicationRequest request,
                                                      AsyncHandler<GetApplicationRequest,​GetApplicationResponse> handler)
        Retrieves an application.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • getFunction

        Future<GetFunctionResponse> getFunction​(GetFunctionRequest request,
                                                AsyncHandler<GetFunctionRequest,​GetFunctionResponse> handler)
        Retrieves a function.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • getPbfListing

        Future<GetPbfListingResponse> getPbfListing​(GetPbfListingRequest request,
                                                    AsyncHandler<GetPbfListingRequest,​GetPbfListingResponse> handler)
        Fetches a Pre-built Function(PBF) Listing.

        Returns a PbfListing response model.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • getPbfListingVersion

        Future<GetPbfListingVersionResponse> getPbfListingVersion​(GetPbfListingVersionRequest request,
                                                                  AsyncHandler<GetPbfListingVersionRequest,​GetPbfListingVersionResponse> handler)
        Gets a PbfListingVersion by identifier for a PbfListing.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listApplications

        Future<ListApplicationsResponse> listApplications​(ListApplicationsRequest request,
                                                          AsyncHandler<ListApplicationsRequest,​ListApplicationsResponse> handler)
        Lists applications for a compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listFunctions

        Future<ListFunctionsResponse> listFunctions​(ListFunctionsRequest request,
                                                    AsyncHandler<ListFunctionsRequest,​ListFunctionsResponse> handler)
        Lists functions for an application.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listPbfListingVersions

        Future<ListPbfListingVersionsResponse> listPbfListingVersions​(ListPbfListingVersionsRequest request,
                                                                      AsyncHandler<ListPbfListingVersionsRequest,​ListPbfListingVersionsResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listPbfListings

        Future<ListPbfListingsResponse> listPbfListings​(ListPbfListingsRequest request,
                                                        AsyncHandler<ListPbfListingsRequest,​ListPbfListingsResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listTriggers

        Future<ListTriggersResponse> listTriggers​(ListTriggersRequest request,
                                                  AsyncHandler<ListTriggersRequest,​ListTriggersResponse> handler)
        Returns a list of Triggers.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • updateApplication

        Future<UpdateApplicationResponse> updateApplication​(UpdateApplicationRequest request,
                                                            AsyncHandler<UpdateApplicationRequest,​UpdateApplicationResponse> handler)
        Modifies an application
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • updateFunction

        Future<UpdateFunctionResponse> updateFunction​(UpdateFunctionRequest request,
                                                      AsyncHandler<UpdateFunctionRequest,​UpdateFunctionResponse> handler)
        Modifies a function
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.