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.models.GroupableResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import com.microsoft.azure.management.resources.implementation.GenericResourceInner;
import com.microsoft.azure.management.resources.implementation.ResourceManager;

An immutable client-side representation of an Azure generic resource.
/**
 * An immutable client-side representation of an Azure generic resource.
 */
@Fluent
public interface GenericResource extends
        GroupableResource<ResourceManager, GenericResourceInner>,
        Refreshable<GenericResource>,
        Updatable<GenericResource.Update> {
    
Returns:
the namespace of the resource provider/**
     * @return the namespace of the resource provider
     */
    String resourceProviderNamespace();

    
Returns:
the id of the parent resource if this is a child resource/**
     * @return the id of the parent resource if this is a child resource
     */
    String parentResourcePath();

    
Returns:
the type of the resource/**
     * @return the type of the resource
     */
    String resourceType();

    
Returns:
the api version of the resource/**
     * @return the api version of the resource
     */
    String apiVersion();

    
Returns:
the plan of the resource/**
     * @return the plan of the resource
     */
    Plan plan();

    
Returns:
other properties of the resource/**
     * @return other properties of the resource
     */
    Object properties();

    
The entirety of the generic resource definition.
/**
     * The entirety of the generic resource definition.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.WithGroup,
            DefinitionStages.WithResourceType,
            DefinitionStages.WithProviderNamespace,
            DefinitionStages.WithParentResource,
            DefinitionStages.WithPlan,
            DefinitionStages.WithApiVersion,
            DefinitionStages.WithCreate {
    }

    
Grouping of generic resource definition stages.
/**
     * Grouping of generic resource definition stages.
     */
    interface DefinitionStages {
        
A generic resource definition allowing region to be specified.
/**
         * A generic resource definition allowing region to be specified.
         */
        interface Blank extends GroupableResource.DefinitionWithRegion<WithGroup> {
        }

        
A generic resource definition allowing resource group to be specified.
/**
         * A generic resource definition allowing resource group to be specified.
         */
        interface WithGroup extends GroupableResource.DefinitionStages.WithGroup<WithResourceType> {
        }

        
A generic resource definition allowing resource type to be specified.
/**
         * A generic resource definition allowing resource type to be specified.
         */
        interface WithResourceType {
            
Specifies the resource's type.
Params:
resourceType – the type of the resources
Returns:
the next stage of generic resource definition/**
             * Specifies the resource's type.
             *
             * @param resourceType the type of the resources
             * @return the next stage of generic resource definition
             */
            WithProviderNamespace withResourceType(String resourceType);
        }

        
A generic resource definition allowing provider namespace to be specified.
/**
         * A generic resource definition allowing provider namespace to be specified.
         */
        interface WithProviderNamespace {
            
Specifies the resource provider's namespace.
Params:
resourceProviderNamespace – the namespace of the resource provider
Returns:
the next stage of the definition/**
             * Specifies the resource provider's namespace.
             *
             * @param resourceProviderNamespace the namespace of the resource provider
             * @return the next stage of the definition
             */
            WithPlan withProviderNamespace(String resourceProviderNamespace);
        }

        
A generic resource definition allowing plan to be specified.
/**
         * A generic resource definition allowing plan to be specified.
         */
        interface WithPlan {
            
Specifies the plan of the resource. The plan can only be set for 3rd party resources.
Params:
name – the name of the plan
publisher – the publisher of the plan
product – the name of the product
promotionCode – the promotion code, if any
Returns:
the next stage of the definition/**
             * Specifies the plan of the resource. The plan can only be set for 3rd party resources.
             *
             * @param name the name of the plan
             * @param publisher the publisher of the plan
             * @param product the name of the product
             * @param promotionCode the promotion code, if any
             * @return the next stage of the definition
             */
            WithCreate withPlan(String name, String publisher, String product, String promotionCode);

            
Specifies the plan of the resource.
Returns:
the next stage of the definition/**
             * Specifies the plan of the resource.
             *
             * @return the next stage of the definition
             */
            WithCreate withoutPlan();
        }

        
A generic resource definition allowing api version to be specified.
/**
         * A generic resource definition allowing api version to be specified.
         */
        interface WithApiVersion {
            
Specifies the api version.
Params:
apiVersion – the API version of the resource
Returns:
the next stage of the definition/**
             * Specifies the api version.
             *
             * @param apiVersion the API version of the resource
             * @return the next stage of the definition
             */
            WithCreate withApiVersion(String apiVersion);
        }

        
A generic resource definition allowing parent resource to be specified.
/**
         * A generic resource definition allowing parent resource to be specified.
         */
        interface WithParentResource {
            
Specifies the parent resource.
Params:
parentResourceId – the parent resource id
Returns:
the next stage of the definition/**
             * Specifies the parent resource.
             *
             * @param parentResourceId the parent resource id
             * @return the next stage of the definition
             */
            WithCreate withParentResourceId(String parentResourceId);

            
Specifies the parent resource relative path.
Params:
parentResourcePath – the relative path of parent resource
Returns:
the next stage of the definition/**
             * Specifies the parent resource relative path.
             *
             * @param parentResourcePath the relative path of parent resource
             * @return the next stage of the definition
             */
            WithCreate withParentResourcePath(String parentResourcePath);
        }

        
A deployment definition with sufficient inputs to create a new
resource in the cloud, but exposing additional optional inputs to
specify.
/**
         * A deployment definition with sufficient inputs to create a new
         * resource in the cloud, but exposing additional optional inputs to
         * specify.
         */
        interface WithCreate extends
                WithParentResource,
                WithApiVersion,
                Creatable<GenericResource>,
                Resource.DefinitionWithTags<WithCreate> {
            
Specifies other properties.
Params:
properties – the properties object
Returns:
the next stage of generic resource definition/**
             * Specifies other properties.
             *
             * @param properties the properties object
             * @return the next stage of generic resource definition
             */
            WithCreate withProperties(Object properties);
        }
    }

    
Grouping of generic resource update stages.
/**
     * Grouping of generic resource update stages.
     */
    interface UpdateStages {
        
A generic resource update allowing to change the resource properties.
/**
         * A generic resource update allowing to change the resource properties.
         */
        interface WithProperties {
            
Specifies other properties of the resource.
Params:
properties – the properties object
Returns:
the next stage of generic resource update/**
             * Specifies other properties of the resource.
             *
             * @param properties the properties object
             * @return the next stage of generic resource update
             */
            Update withProperties(Object properties);
        }

        
A generic resource update allowing to change the parent resource.
/**
         * A generic resource update allowing to change the parent resource.
         */
        interface WithParentResource {
            
Specifies the parent resource.
Params:
parentResourceId – the parent resource id
Returns:
the next stage of the generic resource update/**
             * Specifies the parent resource.
             *
             * @param parentResourceId the parent resource id
             * @return the next stage of the generic resource update
             */
            Update withParentResourceId(String parentResourceId);

            
Specifies the parent resource relative path.
Params:
parentResourcePath – the relative path of parent resource
Returns:
the next stage of the generic resource update/**
             * Specifies the parent resource relative path.
             *
             * @param parentResourcePath the relative path of parent resource
             * @return the next stage of the generic resource update
             */
            Update withParentResourcePath(String parentResourcePath);
        }

        
A generic resource update allowing to change the resource plan.
/**
         * A generic resource update allowing to change the resource plan.
         */
        interface WithPlan {
            
Specifies the plan of the resource.
Params:
name –          the name of the plan
publisher –     the publisher of the plan
product –       the name of the product
promotionCode – the promotion code, if any
Returns:
the next stage of the generic resource update/**
             * Specifies the plan of the resource.
             *
             * @param name          the name of the plan
             * @param publisher     the publisher of the plan
             * @param product       the name of the product
             * @param promotionCode the promotion code, if any
             * @return the next stage of the generic resource update
             */
            Update withPlan(String name, String publisher, String product, String promotionCode);

            
Specifies the plan of the resource.
Returns:
the next stage of the generic resource update/**
             * Specifies the plan of the resource.
             *
             * @return the next stage of the generic resource update
             */
            Update withoutPlan();
        }

        
The template for a generic resource update operation for specifying the resource provider API version.
/**
         * The template for a generic resource update operation for specifying the resource provider API version.
         */
        interface WithApiVersion {
            
Specifies the API version of the resource provider.
Params:
apiVersion – the API version
Returns:
the next stage of the generic resource update/**
             * Specifies the API version of the resource provider.
             *
             * @param apiVersion the API version
             * @return the next stage of the generic resource update
             */
            Update withApiVersion(String apiVersion);
        }
    }

    
The template for a generic resource update operation, containing all the settings that can be modified.
/**
     * The template for a generic resource update operation, containing all the settings that can be modified.
     */
    interface Update extends
            Appliable<GenericResource>,
            UpdateStages.WithApiVersion,
            UpdateStages.WithPlan,
            UpdateStages.WithParentResource,
            UpdateStages.WithProperties,
            Resource.UpdateWithTags<Update> {
    }
}