// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.videoanalyzer.models;

import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;

/** Resource collection API of PipelineTopologies. */
public interface PipelineTopologies {
    /**
     * Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON
     * representation.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param accountName The Azure Video Analyzer account name.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a collection of PipelineTopology items as paginated response with {@link PagedIterable}.
     */
    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.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param accountName The Azure Video Analyzer account name.
     * @param filter Restricts the set of items returned.
     * @param 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.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a collection of PipelineTopology items as paginated response with {@link PagedIterable}.
     */
    PagedIterable<PipelineTopology> list(
        String resourceGroupName, String accountName, String filter, Integer top, 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.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param accountName The Azure Video Analyzer account name.
     * @param pipelineTopologyName Pipeline topology unique identifier.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return pipeline topology describes the processing steps to be applied when processing content for a particular
     *     outcome.
     */
    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.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param accountName The Azure Video Analyzer account name.
     * @param pipelineTopologyName Pipeline topology unique identifier.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return pipeline topology describes the processing steps to be applied when processing content for a particular
     *     outcome along with {@link Response}.
     */
    Response<PipelineTopology> getWithResponse(
        String resourceGroupName, String accountName, String pipelineTopologyName, 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.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param accountName The Azure Video Analyzer account name.
     * @param pipelineTopologyName Pipeline topology unique identifier.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    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.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param accountName The Azure Video Analyzer account name.
     * @param pipelineTopologyName Pipeline topology unique identifier.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link Response}.
     */
    Response<Void> deleteWithResponse(
        String resourceGroupName, String accountName, String pipelineTopologyName, 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.
     *
     * @param id the resource ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return pipeline topology describes the processing steps to be applied when processing content for a particular
     *     outcome along with {@link Response}.
     */
    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.
     *
     * @param id the resource ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return pipeline topology describes the processing steps to be applied when processing content for a particular
     *     outcome along with {@link Response}.
     */
    Response<PipelineTopology> getByIdWithResponse(String id, 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.
     *
     * @param id the resource ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    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.
     *
     * @param id the resource ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link Response}.
     */
    Response<Void> deleteByIdWithResponse(String id, Context context);

    /**
     * Begins definition for a new PipelineTopology resource.
     *
     * @param name resource name.
     * @return the first stage of the new PipelineTopology definition.
     */
    PipelineTopology.DefinitionStages.Blank define(String name);
}
