Package com.azure.resourcemanager.streamanalytics.models

Interface Function

  • public interface Function
    An immutable client-side representation of Function.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • properties

        FunctionProperties properties()
        Gets the properties property: The properties that are associated with a function.
        Returns:
        the properties value.

      • name

        String name()
        Gets the name property: Resource name.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: Resource type.
        Returns:
        the type value.

      • innerModel

        FunctionInner innerModel()
        Gets the inner com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner object.
        Returns:
        the inner object.

      • update

        Function.Update update()
        Begins update for the Function resource.
        Returns:
        the stage of resource update.

      • refresh

        Function refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        Function refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • test

        ResourceTestStatus test​(FunctionInner function)
        Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.
        Parameters:
        function - If the function specified does not already exist, this parameter must contain the full function definition intended to be tested. If the function specified already exists, this parameter can be left null to test the existing function as is or if specified, the properties specified will overwrite the corresponding properties in the existing function (exactly like a PATCH operation) and the resulting function will be tested.
        Returns:
        describes the status of the test operation along with error information, if applicable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • test

        ResourceTestStatus test()
        Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.
        Returns:
        describes the status of the test operation along with error information, if applicable.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • test

        ResourceTestStatus test​(FunctionInner function,
                        com.azure.core.util.Context context)
        Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.
        Parameters:
        function - If the function specified does not already exist, this parameter must contain the full function definition intended to be tested. If the function specified already exists, this parameter can be left null to test the existing function as is or if specified, the properties specified will overwrite the corresponding properties in the existing function (exactly like a PATCH operation) and the resulting function will be tested.
        context - The context to associate with this operation.
        Returns:
        describes the status of the test operation along with error information, if applicable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • retrieveDefaultDefinition

        Function retrieveDefaultDefinition()
        Retrieves the default definition of a function based on the parameters specified.
        Returns:
        a function object, containing all information associated with the named function.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • retrieveDefaultDefinitionWithResponse

        com.azure.core.http.rest.Response<Function> retrieveDefaultDefinitionWithResponse​(FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters,
                                                                                  com.azure.core.util.Context context)
        Retrieves the default definition of a function based on the parameters specified.
        Parameters:
        functionRetrieveDefaultDefinitionParameters - Parameters used to specify the type of function to retrieve the default definition for.
        context - The context to associate with this operation.
        Returns:
        a function object, containing all information associated with the named function.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.