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

package com.azure.resourcemanager.networkcloud.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 Volumes. */
public interface Volumes {
    /**
     * List volumes in the subscription.
     *
     * <p>Get a list of volumes in the provided subscription.
     *
     * @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 list of volumes in the provided subscription as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Volume> list();

    /**
     * List volumes in the subscription.
     *
     * <p>Get a list of volumes in the provided subscription.
     *
     * @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 list of volumes in the provided subscription as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Volume> list(Context context);

    /**
     * List volumes in the resource group.
     *
     * <p>Get a list of volumes in the provided resource group.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @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 list of volumes in the provided resource group as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Volume> listByResourceGroup(String resourceGroupName);

    /**
     * List volumes in the resource group.
     *
     * <p>Get a list of volumes in the provided resource group.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @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 list of volumes in the provided resource group as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Volume> listByResourceGroup(String resourceGroupName, Context context);

    /**
     * Retrieve the volume.
     *
     * <p>Get properties of the provided volume.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param volumeName The name of the volume.
     * @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 properties of the provided volume along with {@link Response}.
     */
    Response<Volume> getByResourceGroupWithResponse(String resourceGroupName, String volumeName, Context context);

    /**
     * Retrieve the volume.
     *
     * <p>Get properties of the provided volume.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param volumeName The name of the volume.
     * @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 properties of the provided volume.
     */
    Volume getByResourceGroup(String resourceGroupName, String volumeName);

    /**
     * Delete the volume.
     *
     * <p>Delete the provided volume.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param volumeName The name of the volume.
     * @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 deleteByResourceGroup(String resourceGroupName, String volumeName);

    /**
     * Delete the volume.
     *
     * <p>Delete the provided volume.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param volumeName The name of the volume.
     * @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.
     */
    void delete(String resourceGroupName, String volumeName, Context context);

    /**
     * Retrieve the volume.
     *
     * <p>Get properties of the provided volume.
     *
     * @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 properties of the provided volume along with {@link Response}.
     */
    Volume getById(String id);

    /**
     * Retrieve the volume.
     *
     * <p>Get properties of the provided volume.
     *
     * @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 properties of the provided volume along with {@link Response}.
     */
    Response<Volume> getByIdWithResponse(String id, Context context);

    /**
     * Delete the volume.
     *
     * <p>Delete the provided volume.
     *
     * @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);

    /**
     * Delete the volume.
     *
     * <p>Delete the provided volume.
     *
     * @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.
     */
    void deleteByIdWithResponse(String id, Context context);

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