Functions Interface

Package:
com.azure.resourcemanager.streamanalytics.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-streamanalytics:1.0.0

public interface Functions

Resource collection API of Functions.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Function resource.
abstract void delete(String resourceGroupName, String jobName, String functionName)

Deletes a function from the streaming job.
abstract void deleteById(String id)

Deletes a function from the streaming job.
abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Deletes a function from the streaming job.
abstract Response<Void> deleteWithResponse(String resourceGroupName, String jobName, String functionName, Context context)

Deletes a function from the streaming job.
abstract Function get(String resourceGroupName, String jobName, String functionName)

Gets details about the specified function.
abstract Function getById(String id)

Gets details about the specified function.
abstract Response<Function> getByIdWithResponse(String id, Context context)

Gets details about the specified function.
abstract Response<Function> getWithResponse(String resourceGroupName, String jobName, String functionName, Context context)

Gets details about the specified function.
abstract PagedIterable<Function> listByStreamingJob(String resourceGroupName, String jobName)

Lists all of the functions under the specified streaming job.
abstract PagedIterable<Function> listByStreamingJob(String resourceGroupName, String jobName, String select, Context context)

Lists all of the functions under the specified streaming job.
abstract Function retrieveDefaultDefinition(String resourceGroupName, String jobName, String functionName)

Retrieves the default definition of a function based on the parameters specified.
abstract Response<Function> retrieveDefaultDefinitionWithResponse(String resourceGroupName, String jobName, String functionName, FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters, Context context)

Retrieves the default definition of a function based on the parameters specified.
abstract ResourceTestStatus test(String resourceGroupName, String jobName, String functionName)

Tests if the information provided for a function is valid.
abstract ResourceTestStatus test(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)

Tests if the information provided for a function is valid.

Method Details

define

public abstract 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.

delete

public abstract 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.

deleteById

public abstract void deleteById(String id)

Deletes a function from the streaming job.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Deletes a function from the streaming job.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String jobName, String functionName, 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:

get

public abstract 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.

getById

public abstract Function getById(String id)

Gets details about the specified function.

Parameters:

id - the resource ID.

Returns:

details about the specified function.

getByIdWithResponse

public abstract Response<Function> getByIdWithResponse(String id, 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.

getWithResponse

public abstract Response<Function> getWithResponse(String resourceGroupName, String jobName, String functionName, 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.

listByStreamingJob

public abstract 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 as paginated response with PagedIterable<T>.

listByStreamingJob

public abstract PagedIterable<Function> listByStreamingJob(String resourceGroupName, String jobName, String select, 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 as paginated response with PagedIterable<T>.

retrieveDefaultDefinition

public abstract 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.

retrieveDefaultDefinitionWithResponse

public abstract Response<Function> retrieveDefaultDefinitionWithResponse(String resourceGroupName, String jobName, String functionName, FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters, 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 along with Response<T>.

test

public abstract 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.

test

public abstract ResourceTestStatus test(String resourceGroupName, String jobName, String functionName, FunctionInner function, 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.

Applies to