Inputs Interface

public interface Inputs

Resource collection API of Inputs.

Method Summary

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

Begins definition for a new Input resource.

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

Deletes an input from the streaming job.

abstract void deleteById(String id)

Deletes an input from the streaming job.

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

Deletes an input from the streaming job.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String jobName, String inputName, Context context)

Deletes an input from the streaming job.

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

Gets details about the specified input.

abstract Input getById(String id)

Gets details about the specified input.

abstract Response<Input> getByIdWithResponse(String id, Context context)

Gets details about the specified input.

abstract Response<Input> getWithResponse(String resourceGroupName, String jobName, String inputName, Context context)

Gets details about the specified input.

abstract PagedIterable<Input> listByStreamingJob(String resourceGroupName, String jobName)

Lists all of the inputs under the specified streaming job.

abstract PagedIterable<Input> listByStreamingJob(String resourceGroupName, String jobName, String select, Context context)

Lists all of the inputs under the specified streaming job.

abstract ResourceTestStatus test(String resourceGroupName, String jobName, String inputName)

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

abstract ResourceTestStatus test(String resourceGroupName, String jobName, String inputName, InputInner input, Context context)

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

Method Details

define

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

delete

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

deleteById

public abstract void deleteById(String id)

Deletes an input from the streaming job.

Parameters:

id - the resource ID.

deleteByIdWithResponse

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

Deletes an input 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 inputName, 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:

get

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

getById

public abstract Input getById(String id)

Gets details about the specified input.

Parameters:

id - the resource ID.

Returns:

details about the specified input.

getByIdWithResponse

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

getWithResponse

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

listByStreamingJob

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

listByStreamingJob

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

test

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

test

public abstract ResourceTestStatus test(String resourceGroupName, String jobName, String inputName, InputInner input, 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.

Applies to