InputsClient Interface

public interface InputsClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(String resourceGroupName, String jobName, String inputName)

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

abstract SyncPoller<PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(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.

abstract InputInner createOrReplace(String resourceGroupName, String jobName, String inputName, InputInner input)

Creates an input or replaces an already existing input under an existing streaming job.

abstract InputsCreateOrReplaceResponse createOrReplaceWithResponse(String resourceGroupName, String jobName, String inputName, InputInner input, String ifMatch, String ifNoneMatch, Context context)

Creates an input or replaces an already existing input under an existing streaming job.

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

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 InputInner get(String resourceGroupName, String jobName, String inputName)

Gets details about the specified input.

abstract InputsGetResponse getWithResponse(String resourceGroupName, String jobName, String inputName, Context context)

Gets details about the specified input.

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

Lists all of the inputs under the specified streaming job.

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

Lists all of the inputs under the specified streaming job.

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

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

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

abstract InputInner update(String resourceGroupName, String jobName, String inputName, InputInner input)

Updates an existing input under an existing streaming job.

abstract InputsUpdateResponse updateWithResponse(String resourceGroupName, String jobName, String inputName, InputInner input, String ifMatch, Context context)

Updates an existing input under an existing streaming job.

Method Details

beginTest

public abstract SyncPoller<PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(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:

the SyncPoller<T,U> for polling of describes the status of the test operation along with error information, if applicable.

beginTest

public abstract SyncPoller<PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(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:

the SyncPoller<T,U> for polling of describes the status of the test operation along with error information, if applicable.

createOrReplace

public abstract InputInner createOrReplace(String resourceGroupName, String jobName, String inputName, InputInner input)

Creates an input or replaces an already existing input 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.
inputName - The name of the input.
input - The definition of the input that will be used to create a new input or replace the existing one under the streaming job.

Returns:

an input object, containing all information associated with the named input.

createOrReplaceWithResponse

public abstract InputsCreateOrReplaceResponse createOrReplaceWithResponse(String resourceGroupName, String jobName, String inputName, InputInner input, String ifMatch, String ifNoneMatch, Context context)

Creates an input or replaces an already existing input 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.
inputName - The name of the input.
input - The definition of the input that will be used to create a new input or replace the existing one under the streaming job.
ifMatch - The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new input to be created, but to prevent updating an existing input. Other values will result in a 412 Pre-condition Failed response.
context - The context to associate with this operation.

Returns:

an input object, containing all information associated with the named input.

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.

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

getWithResponse

public abstract InputsGetResponse 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<InputInner> 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<InputInner> 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 ResourceTestStatusInner 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 ResourceTestStatusInner 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.

update

public abstract InputInner update(String resourceGroupName, String jobName, String inputName, InputInner input)

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

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

Returns:

an input object, containing all information associated with the named input.

updateWithResponse

public abstract InputsUpdateResponse updateWithResponse(String resourceGroupName, String jobName, String inputName, InputInner input, String ifMatch, Context context)

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

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 - An Input object. The properties specified here will overwrite the corresponding properties in the existing input (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation.
ifMatch - The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
context - The context to associate with this operation.

Returns:

an input object, containing all information associated with the named input.

Applies to