Package com.azure.resourcemanager.streamanalytics.fluent

Interface FunctionsClient

public interface FunctionsClient

An instance of this class provides access to all the operations defined in FunctionsClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ResourceTestStatusInner>,ResourceTestStatusInner>	beginTest(String resourceGroupName, String jobName, String functionName, FunctionInner function)	Tests if the information provided for a function is valid.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ResourceTestStatusInner>,ResourceTestStatusInner>	beginTest(String resourceGroupName, String jobName, String functionName, FunctionInner function, com.azure.core.util.Context context)	Tests if the information provided for a function is valid.
FunctionInner	createOrReplace(String resourceGroupName, String jobName, String functionName, FunctionInner function)	Creates a function or replaces an already existing function under an existing streaming job.
FunctionsCreateOrReplaceResponse	createOrReplaceWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, String ifNoneMatch, com.azure.core.util.Context context)	Creates a function or replaces an already existing function under an existing streaming job.
void	delete(String resourceGroupName, String jobName, String functionName)	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.
FunctionInner	get(String resourceGroupName, String jobName, String functionName)	Gets details about the specified function.
FunctionsGetResponse	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<FunctionInner>	listByStreamingJob(String resourceGroupName, String jobName)	Lists all of the functions under the specified streaming job.
com.azure.core.http.rest.PagedIterable<FunctionInner>	listByStreamingJob(String resourceGroupName, String jobName, String select, com.azure.core.util.Context context)	Lists all of the functions under the specified streaming job.
FunctionInner	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<FunctionInner>	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.
ResourceTestStatusInner	test(String resourceGroupName, String jobName, String functionName)	Tests if the information provided for a function is valid.
ResourceTestStatusInner	test(String resourceGroupName, String jobName, String functionName, FunctionInner function)	Tests if the information provided for a function is valid.
ResourceTestStatusInner	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.
FunctionInner	update(String resourceGroupName, String jobName, String functionName, FunctionInner function)	Updates an existing function under an existing streaming job.
FunctionsUpdateResponse	updateWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, com.azure.core.util.Context context)	Updates an existing function under an existing streaming job.

Method Detail

createOrReplace

FunctionInner createOrReplace(String resourceGroupName,
                              String jobName,
                              String functionName,
                              FunctionInner function)

Creates a function or replaces an already existing function under an existing 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.

function - The definition of the function that will be used to create a new function or replace the existing one under the streaming job.

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.

createOrReplaceWithResponse

FunctionsCreateOrReplaceResponse createOrReplaceWithResponse(String resourceGroupName,
                                                             String jobName,
                                                             String functionName,
                                                             FunctionInner function,
                                                             String ifMatch,
                                                             String ifNoneMatch,
                                                             com.azure.core.util.Context context)

Creates a function or replaces an already existing function under an existing 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.

function - The definition of the function that will be used to create a new function or replace the existing one under the streaming job.

ifMatch - The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

ifNoneMatch - Set to '*' to allow a new function to be created, but to prevent updating an existing function. Other values will result in a 412 Pre-condition Failed response.

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.

update

FunctionInner update(String resourceGroupName,
                     String jobName,
                     String functionName,
                     FunctionInner function)

Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition.

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 - A function object. The properties specified here will overwrite the corresponding properties in the existing function (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing function will remain the same and not change as a result of this PATCH 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.

updateWithResponse

FunctionsUpdateResponse updateWithResponse(String resourceGroupName,
                                           String jobName,
                                           String functionName,
                                           FunctionInner function,
                                           String ifMatch,
                                           com.azure.core.util.Context context)

Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition.

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 - A function object. The properties specified here will overwrite the corresponding properties in the existing function (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing function will remain the same and not change as a result of this PATCH operation.

ifMatch - The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

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.

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

FunctionInner 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

FunctionsGetResponse 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<FunctionInner> 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<FunctionInner> 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.

beginTest

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(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.

beginTest

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(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.

test

ResourceTestStatusInner 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

ResourceTestStatusInner 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

ResourceTestStatusInner 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

FunctionInner 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<FunctionInner> 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.