Package com.azure.resourcemanager.streamanalytics.models

Interface Inputs

public interface Inputs

Resource collection API of Inputs.

Method Summary

Modifier and Type	Method	Description
Input.DefinitionStages.Blank	define(String name)	Begins definition for a new Input resource.
void	delete(String resourceGroupName, String jobName, String inputName)	Deletes an input from the streaming job.
void	deleteById(String id)	Deletes an input from the streaming job.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes an input from the streaming job.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String jobName, String inputName, com.azure.core.util.Context context)	Deletes an input from the streaming job.
Input	get(String resourceGroupName, String jobName, String inputName)	Gets details about the specified input.
Input	getById(String id)	Gets details about the specified input.
com.azure.core.http.rest.Response<Input>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets details about the specified input.
com.azure.core.http.rest.Response<Input>	getWithResponse(String resourceGroupName, String jobName, String inputName, com.azure.core.util.Context context)	Gets details about the specified input.
com.azure.core.http.rest.PagedIterable<Input>	listByStreamingJob(String resourceGroupName, String jobName)	Lists all of the inputs under the specified streaming job.
com.azure.core.http.rest.PagedIterable<Input>	listByStreamingJob(String resourceGroupName, String jobName, String select, com.azure.core.util.Context context)	Lists all of the inputs under the specified streaming job.
ResourceTestStatus	test(String resourceGroupName, String jobName, String inputName)	Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.
ResourceTestStatus	test(String resourceGroupName, String jobName, String inputName, InputInner input)	Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.
ResourceTestStatus	test(String resourceGroupName, String jobName, String inputName, InputInner input, com.azure.core.util.Context context)	Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.

Method Detail

delete

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

Deletes an input from the streaming job.

Parameters:

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

jobName - The name of the streaming job.

inputName - The name of the input.

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 inputName,
                                                           com.azure.core.util.Context context)

Deletes an input from the streaming job.

Parameters:

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

jobName - The name of the streaming job.

inputName - The name of the input.

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

Input get(String resourceGroupName,
          String jobName,
          String inputName)

Gets details about the specified input.

Parameters:

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

jobName - The name of the streaming job.

inputName - The name of the input.

Returns:

details about the specified input.

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<Input> getWithResponse(String resourceGroupName,
                                                         String jobName,
                                                         String inputName,
                                                         com.azure.core.util.Context context)

Gets details about the specified input.

Parameters:

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

jobName - The name of the streaming job.

inputName - The name of the input.

context - The context to associate with this operation.

Returns:

details about the specified input.

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

Lists all of the inputs 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 inputs 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<Input> listByStreamingJob(String resourceGroupName,
                                                                 String jobName,
                                                                 String select,
                                                                 com.azure.core.util.Context context)

Lists all of the inputs 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 inputs 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 inputName,
                        InputInner input)

Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.

Parameters:

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

jobName - The name of the streaming job.

inputName - The name of the input.

input - If the input specified does not already exist, this parameter must contain the full input definition intended to be tested. If the input specified already exists, this parameter can be left null to test the existing input as is or if specified, the properties specified will overwrite the corresponding properties in the existing input (exactly like a PATCH operation) and the resulting input 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 inputName)

Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.

Parameters:

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

jobName - The name of the streaming job.

inputName - The name of the input.

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 inputName,
                        InputInner input,
                        com.azure.core.util.Context context)

Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.

Parameters:

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

jobName - The name of the streaming job.

inputName - The name of the input.

input - If the input specified does not already exist, this parameter must contain the full input definition intended to be tested. If the input specified already exists, this parameter can be left null to test the existing input as is or if specified, the properties specified will overwrite the corresponding properties in the existing input (exactly like a PATCH operation) and the resulting input 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.

getById

Input getById(String id)

Gets details about the specified input.

Parameters:

id - the resource ID.

Returns:

details about the specified input.

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<Input> getByIdWithResponse(String id,
                                                             com.azure.core.util.Context context)

Gets details about the specified input.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

details about the specified input.

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 an input 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 an input 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

Input.DefinitionStages.Blank define(String name)

Begins definition for a new Input resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Input definition.