Package com.azure.resourcemanager.videoanalyzer.fluent

Interface PipelineTopologiesClient

public interface PipelineTopologiesClient

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

Method Summary

Modifier and Type	Method	Description
PipelineTopologyInner	createOrUpdate(String resourceGroupName, String accountName, String pipelineTopologyName, PipelineTopologyInner parameters)	Creates a new pipeline topology or updates an existing one, with the given name.
com.azure.core.http.rest.Response<PipelineTopologyInner>	createOrUpdateWithResponse(String resourceGroupName, String accountName, String pipelineTopologyName, PipelineTopologyInner parameters, com.azure.core.util.Context context)	Creates a new pipeline topology or updates an existing one, with the given name.
void	delete(String resourceGroupName, String accountName, String pipelineTopologyName)	Deletes a pipeline topology with the given name.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String accountName, String pipelineTopologyName, com.azure.core.util.Context context)	Deletes a pipeline topology with the given name.
PipelineTopologyInner	get(String resourceGroupName, String accountName, String pipelineTopologyName)	Retrieves a specific pipeline topology by name.
com.azure.core.http.rest.Response<PipelineTopologyInner>	getWithResponse(String resourceGroupName, String accountName, String pipelineTopologyName, com.azure.core.util.Context context)	Retrieves a specific pipeline topology by name.
com.azure.core.http.rest.PagedIterable<PipelineTopologyInner>	list(String resourceGroupName, String accountName)	Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.
com.azure.core.http.rest.PagedIterable<PipelineTopologyInner>	list(String resourceGroupName, String accountName, String filter, Integer top, com.azure.core.util.Context context)	Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.
PipelineTopologyInner	update(String resourceGroupName, String accountName, String pipelineTopologyName, PipelineTopologyUpdate parameters)	Updates an existing pipeline topology with the given name.
com.azure.core.http.rest.Response<PipelineTopologyInner>	updateWithResponse(String resourceGroupName, String accountName, String pipelineTopologyName, PipelineTopologyUpdate parameters, com.azure.core.util.Context context)	Updates an existing pipeline topology with the given name.

Method Detail

list

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

Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.

Parameters:

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

accountName - The Azure Video Analyzer account name.

Returns:

a collection of PipelineTopology 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<PipelineTopologyInner> list(String resourceGroupName,
                                                                   String accountName,
                                                                   String filter,
                                                                   Integer top,
                                                                   com.azure.core.util.Context context)

Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.

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 PipelineTopology 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

PipelineTopologyInner get(String resourceGroupName,
                          String accountName,
                          String pipelineTopologyName)

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

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineTopologyName - Pipeline topology unique identifier.

Returns:

pipeline topology describes the processing steps to be applied when processing content for a particular outcome.

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

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

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineTopologyName - Pipeline topology unique identifier.

context - The context to associate with this operation.

Returns:

pipeline topology describes the processing steps to be applied when processing content for a particular outcome 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

PipelineTopologyInner createOrUpdate(String resourceGroupName,
                                     String accountName,
                                     String pipelineTopologyName,
                                     PipelineTopologyInner parameters)

Creates a new pipeline topology or updates an existing one, with the given name. A pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineTopologyName - Pipeline topology unique identifier.

parameters - The request parameters.

Returns:

pipeline topology describes the processing steps to be applied when processing content for a particular outcome.

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<PipelineTopologyInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                    String accountName,
                                                                                    String pipelineTopologyName,
                                                                                    PipelineTopologyInner parameters,
                                                                                    com.azure.core.util.Context context)

Creates a new pipeline topology or updates an existing one, with the given name. A pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineTopologyName - Pipeline topology unique identifier.

parameters - The request parameters.

context - The context to associate with this operation.

Returns:

pipeline topology describes the processing steps to be applied when processing content for a particular outcome 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 pipelineTopologyName)

Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.

Parameters:

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

accountName - The Azure Video Analyzer account name.

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

Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineTopologyName - Pipeline topology 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

PipelineTopologyInner update(String resourceGroupName,
                             String accountName,
                             String pipelineTopologyName,
                             PipelineTopologyUpdate parameters)

Updates an existing pipeline topology with the given name. If the associated live pipelines or pipeline jobs are in active or processing state, respectively, then only the description can be updated. Else, the properties that can be updated include: description, parameter declarations, sources, processors, and sinks.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineTopologyName - Pipeline topology unique identifier.

parameters - The request parameters.

Returns:

pipeline topology describes the processing steps to be applied when processing content for a particular outcome.

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<PipelineTopologyInner> updateWithResponse(String resourceGroupName,
                                                                            String accountName,
                                                                            String pipelineTopologyName,
                                                                            PipelineTopologyUpdate parameters,
                                                                            com.azure.core.util.Context context)

Updates an existing pipeline topology with the given name. If the associated live pipelines or pipeline jobs are in active or processing state, respectively, then only the description can be updated. Else, the properties that can be updated include: description, parameter declarations, sources, processors, and sinks.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineTopologyName - Pipeline topology unique identifier.

parameters - The request parameters.

context - The context to associate with this operation.

Returns:

pipeline topology describes the processing steps to be applied when processing content for a particular outcome 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.