Package com.azure.resourcemanager.streamanalytics.models

Interface Functions

public interface Functions

Resource collection API of Functions.

Method Summary

Modifier and Type	Method	Description
Function.DefinitionStages.Blank	define(String name)	Begins definition for a new Function resource.
void	delete(String resourceGroupName, String jobName, String functionName)	Deletes a function from the streaming job.
void	deleteById(String id)	Deletes a function from the streaming job.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a function from the streaming job.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String jobName, String functionName, com.azure.core.util.Context context)	Deletes a function from the streaming job.
Function	get(String resourceGroupName, String jobName, String functionName)	Gets details about the specified function.
Function	getById(String id)	Gets details about the specified function.
com.azure.core.http.rest.Response<Function>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets details about the specified function.
com.azure.core.http.rest.Response<Function>	getWithResponse(String resourceGroupName, String jobName, String functionName, com.azure.core.util.Context context)	Gets details about the specified function.
com.azure.core.http.rest.PagedIterable<Function>	listByStreamingJob(String resourceGroupName, String jobName)	Lists all of the functions under the specified streaming job.
com.azure.core.http.rest.PagedIterable<Function>	listByStreamingJob(String resourceGroupName, String jobName, String select, com.azure.core.util.Context context)	Lists all of the functions under the specified streaming job.
Function	retrieveDefaultDefinition(String resourceGroupName, String jobName, String functionName)	Retrieves the default definition of a function based on the parameters specified.
com.azure.core.http.rest.Response<Function>	retrieveDefaultDefinitionWithResponse(String resourceGroupName, String jobName, String functionName, FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters, com.azure.core.util.Context context)	Retrieves the default definition of a function based on the parameters specified.
ResourceTestStatus	test(String resourceGroupName, String jobName, String functionName)	Tests if the information provided for a function is valid.
ResourceTestStatus	test(String resourceGroupName, String jobName, String functionName, FunctionInner function)	Tests if the information provided for a function is valid.
ResourceTestStatus	test(String resourceGroupName, String jobName, String functionName, FunctionInner function, com.azure.core.util.Context context)	Tests if the information provided for a function is valid.

Method Detail

delete

void delete(String resourceGroupName,
            String jobName,
            String functionName)

Deletes a function from the streaming job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the 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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String jobName,
                                                           String functionName,
                                                           com.azure.core.util.Context context)

Deletes a function from the streaming job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

context - The context to associate with this operation.

Returns:

the response.

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.

get

Function get(String resourceGroupName,
             String jobName,
             String functionName)

Gets details about the specified function.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

Returns:

details about the specified 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.

getWithResponse

com.azure.core.http.rest.Response<Function> getWithResponse(String resourceGroupName,
                                                            String jobName,
                                                            String functionName,
                                                            com.azure.core.util.Context context)

Gets details about the specified function.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

context - The context to associate with this operation.

Returns:

details about the specified 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.

listByStreamingJob

com.azure.core.http.rest.PagedIterable<Function> listByStreamingJob(String resourceGroupName,
                                                                    String jobName)

Lists all of the functions under the specified streaming job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

Returns:

object containing a list of functions under a streaming job.

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.

listByStreamingJob

com.azure.core.http.rest.PagedIterable<Function> listByStreamingJob(String resourceGroupName,
                                                                    String jobName,
                                                                    String select,
                                                                    com.azure.core.util.Context context)

Lists all of the functions under the specified streaming job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

select - The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or "*" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value.

context - The context to associate with this operation.

Returns:

object containing a list of functions under a streaming job.

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(String resourceGroupName,
                        String jobName,
                        String functionName,
                        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:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

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(String resourceGroupName,
                        String jobName,
                        String functionName)

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:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

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(String resourceGroupName,
                        String jobName,
                        String functionName,
                        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:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

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(String resourceGroupName,
                                   String jobName,
                                   String functionName)

Retrieves the default definition of a function based on the parameters specified.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

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.

retrieveDefaultDefinitionWithResponse

com.azure.core.http.rest.Response<Function> retrieveDefaultDefinitionWithResponse(String resourceGroupName,
                                                                                  String jobName,
                                                                                  String functionName,
                                                                                  FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters,
                                                                                  com.azure.core.util.Context context)

Retrieves the default definition of a function based on the parameters specified.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

jobName - The name of the streaming job.

functionName - The name of the function.

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.

getById

Function getById(String id)

Gets details about the specified function.

Parameters:

id - the resource ID.

Returns:

details about the specified 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.

getByIdWithResponse

com.azure.core.http.rest.Response<Function> getByIdWithResponse(String id,
                                                                com.azure.core.util.Context context)

Gets details about the specified function.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

details about the specified 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.

deleteById

void deleteById(String id)

Deletes a function from the streaming job.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Deletes a function from the streaming job.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the response.

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.

define

Function.DefinitionStages.Blank define(String name)

Begins definition for a new Function resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Function definition.