Package com.azure.resourcemanager.streamanalytics.models

Interface Outputs

public interface Outputs

Resource collection API of Outputs.

Method Summary

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

Method Detail

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

Output 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

com.azure.core.http.rest.Response<Output> 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<Output> 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<Output> 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.

test

ResourceTestStatus 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

ResourceTestStatus 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

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

getById

Output getById(String id)

Gets details about the specified output.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<Output> getByIdWithResponse(String id,
                                                              com.azure.core.util.Context context)

Gets details about the specified output.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Deletes an output 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 output 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

Output.DefinitionStages.Blank define(String name)

Begins definition for a new Output resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Output definition.