Package com.azure.resourcemanager.videoanalyzer.models

Interface LivePipelines

public interface LivePipelines

Resource collection API of LivePipelines.

Method Summary

Modifier and Type	Method	Description
void	activate(String resourceGroupName, String accountName, String livePipelineName)	Activates a live pipeline with the given name.
void	activate(String resourceGroupName, String accountName, String livePipelineName, com.azure.core.util.Context context)	Activates a live pipeline with the given name.
void	deactivate(String resourceGroupName, String accountName, String livePipelineName)	Deactivates a live pipeline with the given name.
void	deactivate(String resourceGroupName, String accountName, String livePipelineName, com.azure.core.util.Context context)	Deactivates a live pipeline with the given name.
LivePipeline.DefinitionStages.Blank	define(String name)	Begins definition for a new LivePipeline resource.
void	delete(String resourceGroupName, String accountName, String livePipelineName)	Deletes a live pipeline with the given name.
void	deleteById(String id)	Deletes a live pipeline with the given name.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a live pipeline with the given name.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String accountName, String livePipelineName, com.azure.core.util.Context context)	Deletes a live pipeline with the given name.
LivePipeline	get(String resourceGroupName, String accountName, String livePipelineName)	Retrieves a specific live pipeline by name.
LivePipeline	getById(String id)	Retrieves a specific live pipeline by name.
com.azure.core.http.rest.Response<LivePipeline>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Retrieves a specific live pipeline by name.
com.azure.core.http.rest.Response<LivePipeline>	getWithResponse(String resourceGroupName, String accountName, String livePipelineName, com.azure.core.util.Context context)	Retrieves a specific live pipeline by name.
com.azure.core.http.rest.PagedIterable<LivePipeline>	list(String resourceGroupName, String accountName)	Retrieves a list of live pipelines that have been created, along with their JSON representations.
com.azure.core.http.rest.PagedIterable<LivePipeline>	list(String resourceGroupName, String accountName, String filter, Integer top, com.azure.core.util.Context context)	Retrieves a list of live pipelines that have been created, along with their JSON representations.

Method Detail

list

com.azure.core.http.rest.PagedIterable<LivePipeline> list(String resourceGroupName,
                                                          String accountName)

Retrieves a list of live pipelines that have been created, along with their JSON representations.

Parameters:

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

accountName - The Azure Video Analyzer account name.

Returns:

a collection of LivePipeline items as paginated response with PagedIterable.

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.

list

com.azure.core.http.rest.PagedIterable<LivePipeline> list(String resourceGroupName,
                                                          String accountName,
                                                          String filter,
                                                          Integer top,
                                                          com.azure.core.util.Context context)

Retrieves a list of live pipelines that have been created, along with their JSON representations.

Parameters:

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

accountName - The Azure Video Analyzer account name.

filter - Restricts the set of items returned.

top - Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

context - The context to associate with this operation.

Returns:

a collection of LivePipeline items as paginated response with PagedIterable.

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

LivePipeline get(String resourceGroupName,
                 String accountName,
                 String livePipelineName)

Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

Returns:

live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera.

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<LivePipeline> getWithResponse(String resourceGroupName,
                                                                String accountName,
                                                                String livePipelineName,
                                                                com.azure.core.util.Context context)

Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

context - The context to associate with this operation.

Returns:

live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera along with 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.

delete

void delete(String resourceGroupName,
            String accountName,
            String livePipelineName)

Deletes a live pipeline with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

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

Deletes a live pipeline with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

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.

activate

void activate(String resourceGroupName,
              String accountName,
              String livePipelineName)

Activates a live pipeline with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

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.

activate

void activate(String resourceGroupName,
              String accountName,
              String livePipelineName,
              com.azure.core.util.Context context)

Activates a live pipeline with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

context - The context to associate with this operation.

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.

deactivate

void deactivate(String resourceGroupName,
                String accountName,
                String livePipelineName)

Deactivates a live pipeline with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

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.

deactivate

void deactivate(String resourceGroupName,
                String accountName,
                String livePipelineName,
                com.azure.core.util.Context context)

Deactivates a live pipeline with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

livePipelineName - Live pipeline unique identifier.

context - The context to associate with this operation.

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

LivePipeline getById(String id)

Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance.

Parameters:

id - the resource ID.

Returns:

live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera along with 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.

getByIdWithResponse

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

Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera along with 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.

deleteById

void deleteById(String id)

Deletes a live pipeline with the given name.

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 a live pipeline with the given name.

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

LivePipeline.DefinitionStages.Blank define(String name)

Begins definition for a new LivePipeline resource.

Parameters:

name - resource name.

Returns:

the first stage of the new LivePipeline definition.