Package com.azure.resourcemanager.streamanalytics.fluent

Interface OutputsClient

public interface OutputsClient

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

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 outputName, OutputInner output)	Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ResourceTestStatusInner>,ResourceTestStatusInner>	beginTest(String resourceGroupName, String jobName, String outputName, OutputInner output, com.azure.core.util.Context context)	Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
OutputInner	createOrReplace(String resourceGroupName, String jobName, String outputName, OutputInner output)	Creates an output or replaces an already existing output under an existing streaming job.
OutputsCreateOrReplaceResponse	createOrReplaceWithResponse(String resourceGroupName, String jobName, String outputName, OutputInner output, String ifMatch, String ifNoneMatch, com.azure.core.util.Context context)	Creates an output or replaces an already existing output under an existing streaming job.
void	delete(String resourceGroupName, String jobName, String outputName)	Deletes an output from the streaming job.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String jobName, String outputName, com.azure.core.util.Context context)	Deletes an output from the streaming job.
OutputInner	get(String resourceGroupName, String jobName, String outputName)	Gets details about the specified output.
OutputsGetResponse	getWithResponse(String resourceGroupName, String jobName, String outputName, com.azure.core.util.Context context)	Gets details about the specified output.
com.azure.core.http.rest.PagedIterable<OutputInner>	listByStreamingJob(String resourceGroupName, String jobName)	Lists all of the outputs under the specified streaming job.
com.azure.core.http.rest.PagedIterable<OutputInner>	listByStreamingJob(String resourceGroupName, String jobName, String select, com.azure.core.util.Context context)	Lists all of the outputs under the specified streaming job.
ResourceTestStatusInner	test(String resourceGroupName, String jobName, String outputName)	Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
ResourceTestStatusInner	test(String resourceGroupName, String jobName, String outputName, OutputInner output)	Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
ResourceTestStatusInner	test(String resourceGroupName, String jobName, String outputName, OutputInner output, com.azure.core.util.Context context)	Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
OutputInner	update(String resourceGroupName, String jobName, String outputName, OutputInner output)	Updates an existing output under an existing streaming job.
OutputsUpdateResponse	updateWithResponse(String resourceGroupName, String jobName, String outputName, OutputInner output, String ifMatch, com.azure.core.util.Context context)	Updates an existing output under an existing streaming job.

Method Detail

createOrReplace

OutputInner createOrReplace(String resourceGroupName,
                            String jobName,
                            String outputName,
                            OutputInner output)

Creates an output or replaces an already existing output 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.

outputName - The name of the output.

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

Returns:

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

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

OutputsCreateOrReplaceResponse createOrReplaceWithResponse(String resourceGroupName,
                                                           String jobName,
                                                           String outputName,
                                                           OutputInner output,
                                                           String ifMatch,
                                                           String ifNoneMatch,
                                                           com.azure.core.util.Context context)

Creates an output or replaces an already existing output 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.

outputName - The name of the output.

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

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

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

context - The context to associate with this operation.

Returns:

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

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

OutputInner update(String resourceGroupName,
                   String jobName,
                   String outputName,
                   OutputInner output)

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

Parameters:

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

jobName - The name of the streaming job.

outputName - The name of the output.

output - An Output object. The properties specified here will overwrite the corresponding properties in the existing output (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing output will remain the same and not change as a result of this PATCH operation.

Returns:

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

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

OutputsUpdateResponse updateWithResponse(String resourceGroupName,
                                         String jobName,
                                         String outputName,
                                         OutputInner output,
                                         String ifMatch,
                                         com.azure.core.util.Context context)

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

Parameters:

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

jobName - The name of the streaming job.

outputName - The name of the output.

output - An Output object. The properties specified here will overwrite the corresponding properties in the existing output (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing output will remain the same and not change as a result of this PATCH operation.

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

context - The context to associate with this operation.

Returns:

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

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 outputName)

Deletes an output from the streaming job.

Parameters:

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

jobName - The name of the streaming job.

outputName - The name of the output.

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

Deletes an output from the streaming job.

Parameters:

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

jobName - The name of the streaming job.

outputName - The name of the output.

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

OutputInner get(String resourceGroupName,
                String jobName,
                String outputName)

Gets details about the specified output.

Parameters:

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

jobName - The name of the streaming job.

outputName - The name of the output.

Returns:

details about the specified output.

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

OutputsGetResponse getWithResponse(String resourceGroupName,
                                   String jobName,
                                   String outputName,
                                   com.azure.core.util.Context context)

Gets details about the specified output.

Parameters:

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

jobName - The name of the streaming job.

outputName - The name of the output.

context - The context to associate with this operation.

Returns:

details about the specified output.

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

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

Lists all of the outputs 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 outputs 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 outputName,
                                                                                                                                                      OutputInner output)

Tests whether an output’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.

outputName - The name of the output.

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

Tests whether an output’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.

outputName - The name of the output.

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

Tests whether an output’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.

outputName - The name of the output.

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

Tests whether an output’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.

outputName - The name of the output.

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

Tests whether an output’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.

outputName - The name of the output.

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