Package com.azure.resourcemanager.videoanalyzer.fluent

Interface LivePipelinesClient

public interface LivePipelinesClient

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

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.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginActivate(String resourceGroupName, String accountName, String livePipelineName)	Activates a live pipeline with the given name.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginActivate(String resourceGroupName, String accountName, String livePipelineName, com.azure.core.util.Context context)	Activates a live pipeline with the given name.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDeactivate(String resourceGroupName, String accountName, String livePipelineName)	Deactivates a live pipeline with the given name.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDeactivate(String resourceGroupName, String accountName, String livePipelineName, com.azure.core.util.Context context)	Deactivates a live pipeline with the given name.
LivePipelineInner	createOrUpdate(String resourceGroupName, String accountName, String livePipelineName, LivePipelineInner parameters)	Creates a new live pipeline or updates an existing one, with the given name.
com.azure.core.http.rest.Response<LivePipelineInner>	createOrUpdateWithResponse(String resourceGroupName, String accountName, String livePipelineName, LivePipelineInner parameters, com.azure.core.util.Context context)	Creates a new live pipeline or updates an existing one, 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.
void	delete(String resourceGroupName, String accountName, String livePipelineName)	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.
LivePipelineInner	get(String resourceGroupName, String accountName, String livePipelineName)	Retrieves a specific live pipeline by name.
com.azure.core.http.rest.Response<LivePipelineInner>	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<LivePipelineInner>	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<LivePipelineInner>	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.
LivePipelineInner	update(String resourceGroupName, String accountName, String livePipelineName, LivePipelineUpdate parameters)	Updates an existing live pipeline with the given name.
com.azure.core.http.rest.Response<LivePipelineInner>	updateWithResponse(String resourceGroupName, String accountName, String livePipelineName, LivePipelineUpdate parameters, com.azure.core.util.Context context)	Updates an existing live pipeline with the given name.

Method Detail

list

com.azure.core.http.rest.PagedIterable<LivePipelineInner> 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<LivePipelineInner> 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

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

createOrUpdate

LivePipelineInner createOrUpdate(String resourceGroupName,
                                 String accountName,
                                 String livePipelineName,
                                 LivePipelineInner parameters)

Creates a new live pipeline or updates an existing one, 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.

parameters - The request parameters.

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.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<LivePipelineInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                String accountName,
                                                                                String livePipelineName,
                                                                                LivePipelineInner parameters,
                                                                                com.azure.core.util.Context context)

Creates a new live pipeline or updates an existing one, 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.

parameters - The request parameters.

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.

update

LivePipelineInner update(String resourceGroupName,
                         String accountName,
                         String livePipelineName,
                         LivePipelineUpdate parameters)

Updates an existing live pipeline with the given name. Properties that can be updated include: description, bitrateKbps, and parameter definitions. Only the description can be updated while the live pipeline is active.

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.

parameters - The request parameters.

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.

updateWithResponse

com.azure.core.http.rest.Response<LivePipelineInner> updateWithResponse(String resourceGroupName,
                                                                        String accountName,
                                                                        String livePipelineName,
                                                                        LivePipelineUpdate parameters,
                                                                        com.azure.core.util.Context context)

Updates an existing live pipeline with the given name. Properties that can be updated include: description, bitrateKbps, and parameter definitions. Only the description can be updated while the live pipeline is active.

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.

parameters - The request parameters.

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.

beginActivate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginActivate(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.

Returns:

the SyncPoller for polling of long-running 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.

beginActivate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginActivate(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.

Returns:

the SyncPoller for polling of long-running 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.

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.

beginDeactivate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDeactivate(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.

Returns:

the SyncPoller for polling of long-running 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.

beginDeactivate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDeactivate(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.

Returns:

the SyncPoller for polling of long-running 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.