Package com.azure.resourcemanager.videoanalyzer.models

Interface PipelineJobs

public interface PipelineJobs

Resource collection API of PipelineJobs.

Method Summary

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

Method Detail

list

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

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

Retrieves a list of all 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 PipelineJob 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

PipelineJob get(String resourceGroupName,
                String accountName,
                String pipelineJobName)

Retrieves a specific pipeline job by name. If a pipeline job 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.

pipelineJobName - The pipeline job name.

Returns:

pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content.

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

Retrieves a specific pipeline job by name. If a pipeline job 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.

pipelineJobName - The pipeline job name.

context - The context to associate with this operation.

Returns:

pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content 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 pipelineJobName)

Deletes a pipeline job with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineJobName - The pipeline job name.

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

Deletes a pipeline job with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineJobName - The pipeline job name.

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.

cancel

void cancel(String resourceGroupName,
            String accountName,
            String pipelineJobName)

Cancels a pipeline job with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineJobName - The pipeline job name.

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.

cancel

void cancel(String resourceGroupName,
            String accountName,
            String pipelineJobName,
            com.azure.core.util.Context context)

Cancels a pipeline job with the given name.

Parameters:

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

accountName - The Azure Video Analyzer account name.

pipelineJobName - The pipeline job name.

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

PipelineJob getById(String id)

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

Parameters:

id - the resource ID.

Returns:

pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content 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<PipelineJob> getByIdWithResponse(String id,
                                                                   com.azure.core.util.Context context)

Retrieves a specific pipeline job by name. If a pipeline job 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:

pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content 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 job 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 pipeline job 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

PipelineJob.DefinitionStages.Blank define(String name)

Begins definition for a new PipelineJob resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PipelineJob definition.