Interface PipelineJobsClient
-
public interface PipelineJobsClient
An instance of this class provides access to all the operations defined in PipelineJobsClient.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
beginCancel(String resourceGroupName, String accountName, String pipelineJobName)
Cancels a pipeline job with the given name.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
beginCancel(String resourceGroupName, String accountName, String pipelineJobName, com.azure.core.util.Context context)
Cancels a pipeline job with the given name.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.PipelineJobInner
createOrUpdate(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobInner parameters)
Creates a new pipeline job or updates an existing one, with the given name.com.azure.core.http.rest.Response<PipelineJobInner>
createOrUpdateWithResponse(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobInner parameters, com.azure.core.util.Context context)
Creates a new pipeline job or updates an existing one, with the given name.void
delete(String resourceGroupName, String accountName, String pipelineJobName)
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.PipelineJobInner
get(String resourceGroupName, String accountName, String pipelineJobName)
Retrieves a specific pipeline job by name.com.azure.core.http.rest.Response<PipelineJobInner>
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<PipelineJobInner>
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<PipelineJobInner>
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.PipelineJobInner
update(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobUpdate parameters)
Updates an existing pipeline job with the given name.com.azure.core.http.rest.Response<PipelineJobInner>
updateWithResponse(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobUpdate parameters, com.azure.core.util.Context context)
Updates an existing pipeline job with the given name.
-
-
-
Method Detail
-
list
com.azure.core.http.rest.PagedIterable<PipelineJobInner> 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<PipelineJobInner> 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
PipelineJobInner 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<PipelineJobInner> 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.
-
createOrUpdate
PipelineJobInner createOrUpdate(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobInner parameters)
Creates a new pipeline job 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.pipelineJobName
- The pipeline job name.parameters
- The request parameters.- 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.
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<PipelineJobInner> createOrUpdateWithResponse(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobInner parameters, com.azure.core.util.Context context)
Creates a new pipeline job 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.pipelineJobName
- The pipeline job name.parameters
- The request parameters.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.
-
update
PipelineJobInner update(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobUpdate parameters)
Updates an existing pipeline job with the given name. Properties that can be updated include: description.- 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.parameters
- The request parameters.- 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.
-
updateWithResponse
com.azure.core.http.rest.Response<PipelineJobInner> updateWithResponse(String resourceGroupName, String accountName, String pipelineJobName, PipelineJobUpdate parameters, com.azure.core.util.Context context)
Updates an existing pipeline job with the given name. Properties that can be updated include: description.- 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.parameters
- The request parameters.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.
-
beginCancel
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginCancel(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.- 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.
-
beginCancel
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginCancel(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.- 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.
-
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.
-
-