Package com.azure.resourcemanager.videoanalyzer.models

Interface PipelineTopologies

public interface PipelineTopologies

Resource collection API of PipelineTopologies.

Method Summary

Modifier and Type	Method	Description
PipelineTopology.DefinitionStages.Blank	define(String name)	Begins definition for a new PipelineTopology resource.
void	delete(String resourceGroupName, String accountName, String pipelineTopologyName)	Deletes a pipeline topology with the given name.
void	deleteById(String id)	Deletes a pipeline topology with the given name.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	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.
PipelineTopology	get(String resourceGroupName, String accountName, String pipelineTopologyName)	Retrieves a specific pipeline topology by name.
PipelineTopology	getById(String id)	Retrieves a specific pipeline topology by name.
com.azure.core.http.rest.Response<PipelineTopology>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Retrieves a specific pipeline topology by name.
com.azure.core.http.rest.Response<PipelineTopology>	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<PipelineTopology>	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<PipelineTopology>	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.

Method Detail

list

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

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

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.

getById

PipelineTopology getById(String id)

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:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<PipelineTopology> getByIdWithResponse(String id,
                                                                        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:

id - the resource ID.

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.

deleteById

void deleteById(String id)

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:

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 pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.

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

PipelineTopology.DefinitionStages.Blank define(String name)

Begins definition for a new PipelineTopology resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PipelineTopology definition.