Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.microsoft.azure.management.resources;

import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingInResourceGroupByTag;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing;
import com.microsoft.azure.management.resources.implementation.ResourceManager;
import com.microsoft.rest.ServiceCallback;
import com.microsoft.rest.ServiceFuture;
import rx.Completable;
import rx.Observable;

import java.util.List;

Entry point to generic resources management API.
/**
 * Entry point to generic resources management API.
 */
@Fluent
public interface GenericResources extends
        SupportsListing<GenericResource>,
        SupportsListingByResourceGroup<GenericResource>,
        SupportsListingInResourceGroupByTag<GenericResource>,
        SupportsGettingById<GenericResource>,
        SupportsCreating<GenericResource.DefinitionStages.Blank>,
        SupportsDeletingById,
        HasManager<ResourceManager> {
    
Deletes a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use deleteById(String, String) instead. 
Params:
id – the resource ID of the resource to delete/**
     * Deletes a resource from Azure, identifying it by its resource ID.
     *
     * For consistency across service versions, please use {@link #deleteById(String, String)} instead.
     *
     * @param id the resource ID of the resource to delete
     */
    void deleteById(String id);

    
Asynchronously delete a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use deleteByIdAsync(String, String) instead. 
Params:
id – the resource ID of the resource to delete
Returns:
a representation of the deferred computation of this call/**
     * Asynchronously delete a resource from Azure, identifying it by its resource ID.
     *
     * For consistency across service versions, please use {@link #deleteByIdAsync(String, String)} instead.
     *
     * @param id the resource ID of the resource to delete
     * @return a representation of the deferred computation of this call
     */
    Completable deleteByIdAsync(String id);

    
Gets the information about a resource from Azure based on the resource id. For consistency across service versions, please use getById(String, String) instead. 
Params:
id – the id of the resource.
Returns:
an immutable representation of the resource/**
     * Gets the information about a resource from Azure based on the resource id.
     *
     * For consistency across service versions, please use {@link #getById(String, String)} instead.
     *
     * @param id the id of the resource.
     * @return an immutable representation of the resource
     */
    GenericResource getById(String id);

    
Gets the information about a resource from Azure based on the resource id. For consistency across service versions, please use getByIdAsync(String, String) instead. 
Params:
id – the id of the resource.
Returns:
an immutable representation of the resource/**
     * Gets the information about a resource from Azure based on the resource id.
     *
     * For consistency across service versions, please use {@link #getByIdAsync(String, String)} instead.
     *
     * @param id the id of the resource.
     * @return an immutable representation of the resource
     */
    Observable<GenericResource> getByIdAsync(String id);

    
Deletes a resource from Azure, identifying it by its resource ID.
Params:
id – the resource ID of the resource to delete
apiVersion – the API version/**
     * Deletes a resource from Azure, identifying it by its resource ID.
     *
     * @param id the resource ID of the resource to delete
     * @param apiVersion the API version
     */
    void deleteById(String id, String apiVersion);

    
Asynchronously delete a resource from Azure, identifying it by its resource ID.
Params:
id – the resource ID of the resource to delete
apiVersion – the API version
Returns:
a representation of the deferred computation of this call/**
     * Asynchronously delete a resource from Azure, identifying it by its resource ID.
     *
     * @param id the resource ID of the resource to delete
     * @param apiVersion the API version
     * @return a representation of the deferred computation of this call
     */
    Completable deleteByIdAsync(String id, String apiVersion);

    
Gets the information about a resource from Azure based on the resource id.
Params:
id – the id of the resource.
apiVersion – the API version
Returns:
an immutable representation of the resource/**
     * Gets the information about a resource from Azure based on the resource id.
     *
     * @param id the id of the resource.
     * @param apiVersion the API version
     * @return an immutable representation of the resource
     */
    GenericResource getById(String id, String apiVersion);

    
Gets the information about a resource from Azure based on the resource id.
Params:
id – the id of the resource.
apiVersion – the API version
Returns:
an immutable representation of the resource/**
     * Gets the information about a resource from Azure based on the resource id.
     *
     * @param id the id of the resource.
     * @param apiVersion the API version
     * @return an immutable representation of the resource
     */
    Observable<GenericResource> getByIdAsync(String id, String apiVersion);

    
Checks if a resource exists in a resource group.
Params:
resourceGroupName – the resource group's name
resourceProviderNamespace – the resource provider's namespace
parentResourcePath – the parent's resource path
resourceType – the type of the resource
resourceName – the name of the resource
apiVersion – the API version
Returns:
true if the resource exists; false otherwise/**
     * Checks if a resource exists in a resource group.
     *
     * @param resourceGroupName the resource group's name
     * @param resourceProviderNamespace the resource provider's namespace
     * @param parentResourcePath the parent's resource path
     * @param resourceType the type of the resource
     * @param resourceName the name of the resource
     * @param apiVersion the API version
     * @return true if the resource exists; false otherwise
     */
    boolean checkExistence(
            String resourceGroupName,
            String resourceProviderNamespace,
            String parentResourcePath,
            String resourceType,
            String resourceName,
            String apiVersion);

    
Checks if a resource exists. For consistency across service versions, please use checkExistenceById(String, String) instead. 
Params:
id – the ID of the resource.
Returns:
true if the resource exists; false otherwise/**
     * Checks if a resource exists.
     *
     * For consistency across service versions, please use {@link #checkExistenceById(String, String)} instead.
     *
     * @param id the ID of the resource.
     * @return true if the resource exists; false otherwise
     */
    boolean checkExistenceById(String id);

    
Checks if a resource exists.
Params:
id – the ID of the resource.
apiVersion – the API version
Returns:
true if the resource exists; false otherwise/**
     * Checks if a resource exists.
     *
     * @param id the ID of the resource.
     * @param apiVersion the API version
     * @return true if the resource exists; false otherwise
     */
    boolean checkExistenceById(String id, String apiVersion);

    
Returns a resource belonging to a resource group.
Params:
resourceGroupName – The name of the resource group. The name is case insensitive.
resourceProviderNamespace – Resource identity.
parentResourcePath – Resource identity.
resourceType – Resource identity.
resourceName – Resource identity.
apiVersion – the API version
Returns:
the generic resource/**
     * Returns a resource belonging to a resource group.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param resourceProviderNamespace Resource identity.
     * @param parentResourcePath Resource identity.
     * @param resourceType Resource identity.
     * @param resourceName Resource identity.
     * @param apiVersion the API version
     * @return the generic resource
     */
    GenericResource get(
            String resourceGroupName,
            String resourceProviderNamespace,
            String parentResourcePath,
            String resourceType,
            String resourceName,
            String apiVersion);

    
Returns a resource belonging to a resource group.
Params:
resourceGroupName – the resource group name
providerNamespace – the provider namespace
resourceType – the resource type
resourceName – the name of the resource
Returns:
the generic resource/**
     * Returns a resource belonging to a resource group.
     * @param resourceGroupName the resource group name
     * @param providerNamespace the provider namespace
     * @param resourceType the resource type
     * @param resourceName the name of the resource
     * @return the generic resource
     */
    GenericResource get(
            String resourceGroupName,
            String providerNamespace,
            String resourceType,
            String resourceName);

    
Move resources from one resource group to another.
Params:
sourceResourceGroupName – Source resource group name
targetResourceGroup – target resource group, can be in a different subscription
resources – the list of IDs of the resources to move/**
     * Move resources from one resource group to another.
     *
     * @param sourceResourceGroupName Source resource group name
     * @param targetResourceGroup target resource group, can be in a different subscription
     * @param resources the list of IDs of the resources to move
     */
    void moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resources);

    
Move resources from one resource group to another asynchronously.
Params:
sourceResourceGroupName – Source resource group name
targetResourceGroup – target resource group, can be in a different subscription
resources – the list of IDs of the resources to move
Returns:
a representation of the deferred computation of this call/**
     * Move resources from one resource group to another asynchronously.
     *
     * @param sourceResourceGroupName Source resource group name
     * @param targetResourceGroup target resource group, can be in a different subscription
     * @param resources the list of IDs of the resources to move
     *
     * @return a representation of the deferred computation of this call
     */
    Completable moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resources);

    
Move resources from one resource group to another asynchronously.
Params:
sourceResourceGroupName – Source resource group name
targetResourceGroup – target resource group, can be in a different subscription
resources – the list of IDs of the resources to move
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Move resources from one resource group to another asynchronously.
     *
     * @param sourceResourceGroupName Source resource group name
     * @param targetResourceGroup target resource group, can be in a different subscription
     * @param resources the list of IDs of the resources to move
     * @param callback the callback to call on success or failure
     *
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resources, ServiceCallback<Void> callback);

    
Delete resource and all of its child resources.
Params:
resourceGroupName – The name of the resource group. The name is case insensitive.
resourceProviderNamespace – Resource identity.
parentResourcePath – Resource identity.
resourceType – Resource identity.
resourceName – Resource identity.
apiVersion – the API version/**
     * Delete resource and all of its child resources.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param resourceProviderNamespace Resource identity.
     * @param parentResourcePath Resource identity.
     * @param resourceType Resource identity.
     * @param resourceName Resource identity.
     * @param apiVersion the API version
     */
    void delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion);


    
Delete resource and all of its child resources asynchronously.
Params:
resourceGroupName – The name of the resource group. The name is case insensitive.
resourceProviderNamespace – Resource identity.
parentResourcePath – Resource identity.
resourceType – Resource identity.
resourceName – Resource identity.
apiVersion – the API version
Returns:
a representation of the deferred computation of this call/**
     * Delete resource and all of its child resources asynchronously.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param resourceProviderNamespace Resource identity.
     * @param parentResourcePath Resource identity.
     * @param resourceType Resource identity.
     * @param resourceName Resource identity.
     * @param apiVersion the API version
     * @return a representation of the deferred computation of this call
     */
    Completable deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion);


    
Delete resource and all of its child resources asynchronously.
Params:
resourceGroupName – The name of the resource group. The name is case insensitive.
resourceProviderNamespace – Resource identity.
parentResourcePath – Resource identity.
resourceType – Resource identity.
resourceName – Resource identity.
apiVersion – the String value
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Delete resource and all of its child resources asynchronously.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param resourceProviderNamespace Resource identity.
     * @param parentResourcePath Resource identity.
     * @param resourceType Resource identity.
     * @param resourceName Resource identity.
     * @param apiVersion the String value
     * @param callback the callback to call on success or failure
     *
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, ServiceCallback<Void> callback);

    
Force delete resource and all of its child resources.
This is only available to limited resource types.
Params:
resourceGroupName – The name of the resource group. The name is case insensitive.
resourceProviderNamespace – Resource identity.
parentResourcePath – Resource identity.
resourceType – Resource identity.
resourceName – Resource identity.
apiVersion – the API version
forceDeletion – the force delete parameter/**
     * Force delete resource and all of its child resources.
     * This is only available to limited resource types.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param resourceProviderNamespace Resource identity.
     * @param parentResourcePath Resource identity.
     * @param resourceType Resource identity.
     * @param resourceName Resource identity.
     * @param apiVersion the API version
     * @param forceDeletion the force delete parameter
     */
    void delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, boolean forceDeletion);


    
Force delete resource and all of its child resources asynchronously.
This is only available to limited resource types.
Params:
resourceGroupName – The name of the resource group. The name is case insensitive.
resourceProviderNamespace – Resource identity.
parentResourcePath – Resource identity.
resourceType – Resource identity.
resourceName – Resource identity.
apiVersion – the API version
forceDeletion – the force delete parameter
Returns:
a representation of the deferred computation of this call/**
     * Force delete resource and all of its child resources asynchronously.
     * This is only available to limited resource types.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param resourceProviderNamespace Resource identity.
     * @param parentResourcePath Resource identity.
     * @param resourceType Resource identity.
     * @param resourceName Resource identity.
     * @param apiVersion the API version
     * @param forceDeletion the force delete parameter
     * @return a representation of the deferred computation of this call
     */
    Completable deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, boolean forceDeletion);


    
Force delete resource and all of its child resources asynchronously.
This is only available to limited resource types.
Params:
resourceGroupName – The name of the resource group. The name is case insensitive.
resourceProviderNamespace – Resource identity.
parentResourcePath – Resource identity.
resourceType – Resource identity.
resourceName – Resource identity.
apiVersion – the API version
forceDeletion – the force delete parameter
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Force delete resource and all of its child resources asynchronously.
     * This is only available to limited resource types.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param resourceProviderNamespace Resource identity.
     * @param parentResourcePath Resource identity.
     * @param resourceType Resource identity.
     * @param resourceName Resource identity.
     * @param apiVersion the API version
     * @param forceDeletion the force delete parameter
     * @param callback the callback to call on success or failure
     *
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, boolean forceDeletion, ServiceCallback<Void> callback);
}