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.batch;

import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.batch.implementation.BatchAccountInner;
import com.microsoft.azure.management.batch.implementation.BatchManager;
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.storage.StorageAccount;

import java.util.List;
import java.util.Map;

An immutable client-side representation of an Azure Batch account.
/**
 * An immutable client-side representation of an Azure Batch account.
 */
@Fluent
public interface BatchAccount extends
        GroupableResource<BatchManager, BatchAccountInner>,
        Refreshable<BatchAccount>,
        Updatable<BatchAccount.Update> {

    
Returns:
the provisioned state of the resource/**
     * @return the provisioned state of the resource
     */
    ProvisioningState provisioningState();

    
Returns:
Batch account endpoint/**
     * @return Batch account endpoint
     */
    String accountEndpoint();

    
Returns:
the properties and status of any auto storage account associated with the Batch account/**
     * @return the properties and status of any auto storage account associated with the Batch account
     */
    AutoStorageProperties autoStorage();

    
Returns:
the core quota for this Batch account/**
     * @return the core quota for this Batch account
     */
    int coreQuota();

    
Returns:
the pool quota for this Batch account/**
     * @return the pool quota for this Batch account
     */
    int poolQuota();

    
Returns:
the active job and job schedule quota for this Batch account/**
     * @return the active job and job schedule quota for this Batch account
     */
    int activeJobAndJobScheduleQuota();

    
Returns:
the access keys for this Batch account/**
     * @return the access keys for this Batch account
     */
    BatchAccountKeys getKeys();

    
Regenerates the access keys for the Batch account.
Params:
keyType – the type if key to regenerate
Returns:
regenerated access keys for this Batch account/**
     * Regenerates the access keys for the Batch account.
     *
     * @param keyType the type if key to regenerate
     * @return regenerated access keys for this Batch account
     */
    BatchAccountKeys regenerateKeys(AccountKeyType keyType);

    
Synchronizes the storage account keys for this Batch account.
/**
     * Synchronizes the storage account keys for this Batch account.
     */
    void synchronizeAutoStorageKeys();

    
Returns:
applications in this Batch account, indexed by name/**
     * @return applications in this Batch account, indexed by name
     */
    Map<String, Application> applications();

    
Returns:
pools in this Batch account, indexed by name/**
     * @return pools in this Batch account, indexed by name
     */
    Map<String, Pool> pools();

    
Returns:
value indicating whether the core quota for the Batch Account is enforced per Virtual Machine family or not/**
     * @return value indicating whether the core quota for the Batch Account is enforced per Virtual Machine family or not
     */
    boolean dedicatedCoreQuotaPerVMFamilyEnforced();

    
Returns:
a list of the dedicated core quota per Virtual Machine
family for the Batch account/**
     * @return a list of the dedicated core quota per Virtual Machine
     * family for the Batch account
     */
    List<VirtualMachineFamilyCoreQuota> dedicatedCoreQuotaPerVMFamily();

    
Returns:
the dedicated core quota for the Batch account/**
     * @return the dedicated core quota for the Batch account
     */
    Integer dedicatedCoreQuota();

    
Returns:
the low-priority core quota for the Batch account/**
     * @return the low-priority core quota for the Batch account
     */
    Integer lowPriorityCoreQuota();

    
The entirety of a Batch account definition.
/**
     * The entirety of a Batch account definition.
     */
    interface Definition extends
        DefinitionStages.Blank,
        DefinitionStages.WithGroup,
        DefinitionStages.WithCreate,
        DefinitionStages.WithApplicationAndStorage,
        DefinitionStages.WithCreateAndApplication,
        DefinitionStages.WithApplication,
        DefinitionStages.WithStorage,
        DefinitionStages.WithPool {
    }

    
Grouping of all the Batch account definition stages.
/**
     * Grouping of all the Batch account definition stages.
     */
    interface DefinitionStages {
        
The first stage of a Batch account definition.
/**
         * The first stage of a Batch account definition.
         */
        interface Blank extends Resource.DefinitionWithRegion<WithGroup> {
        }

        
The stage of a Batch account definition allowing the resource group to be specified.
/**
         * The stage of a Batch account definition allowing the resource group to be specified.
         */
        interface WithGroup extends GroupableResource.DefinitionStages.WithGroup<WithCreateAndApplication> {
        }

        
The stage of a Batch account definition allowing adding an application and a storage account.
/**
         * The stage of a Batch account definition allowing adding an application and a storage account.
         */
        interface WithApplicationAndStorage extends WithStorage, WithApplication {
        }

        
The stage of a Batch account definition allowing the creation of a Batch application.
/**
         * The stage of a Batch account definition allowing the creation of a Batch application.
         */
        interface WithApplication {
            
The stage of a Batch account definition allowing to add a Batch application.
Params:
applicationId – the id of the application to create
Returns:
the next stage of the definition/**
             * The stage of a Batch account definition allowing to add a Batch application.
             *
             * @param applicationId the id of the application to create
             * @return the next stage of the definition
             */
            Application.DefinitionStages.Blank<WithApplicationAndStorage> defineNewApplication(String applicationId);
        }

        
The stage of a Batch account definition allowing to associate storage accounts with the Batch account.
/**
         * The stage of a Batch account definition allowing to associate storage accounts with the Batch account.
         */
        interface WithStorage {
            
Specifies an existing storage account to associate with the Batch account.
Params:
storageAccount – an existing storage account
Returns:
the next stage of the definition/**
             * Specifies an existing storage account to associate with the Batch account.
             *
             * @param storageAccount an existing storage account
             * @return the next stage of the definition
             */
            DefinitionStages.WithCreate withExistingStorageAccount(StorageAccount storageAccount);

            
Specifies a new storage account to associate with the Batch account.
Params:
storageAccountCreatable – a storage account to be created along with and used in the Batch account
Returns:
the next stage of the definition/**
             * Specifies a new storage account to associate with the Batch account.
             *
             * @param storageAccountCreatable a storage account to be created along with and used in the Batch account
             * @return the next stage of the definition
             */
            DefinitionStages.WithCreate withNewStorageAccount(Creatable<StorageAccount> storageAccountCreatable);

            
Specifies the name of a new storage account to be created and associated with this Batch account.
Params:
storageAccountName – the name of a new storage account
Returns:
the next stage of the definition/**
             * Specifies the name of a new storage account to be created and associated with this Batch account.
             *
             * @param storageAccountName the name of a new storage account
             * @return the next stage of the definition
             */
            DefinitionStages.WithCreate withNewStorageAccount(String storageAccountName);
        }

        
The stage of a Batch account definition allowing the adding of a Batch application or creating the Batch account.
/**
         * The stage of a Batch account definition allowing the adding of a Batch application or creating the Batch account.
         */
        interface WithCreateAndApplication extends
                WithCreate,
                DefinitionStages.WithApplicationAndStorage,
                DefinitionStages.WithPool {
        }

        
The stage of a Batch account definition allowing the creation of a Batch pool.
/**
         * The stage of a Batch account definition allowing the creation of a Batch pool.
         */
        interface WithPool {
            
The stage of a Batch account definition allowing to add a Batch pool.
Params:
poolId – the id of the pool to create
Returns:
the next stage of the definition/**
             * The stage of a Batch account definition allowing to add a Batch pool.
             *
             * @param poolId the id of the pool to create
             * @return the next stage of the definition
             */
            Pool.DefinitionStages.Blank<WithPool> defineNewPool(String poolId);
        }

        
A Batch account definition with sufficient inputs to create a new
Batch account in the cloud, but exposing additional optional inputs to specify.
/**
         * A Batch account definition with sufficient inputs to create a new
         * Batch account in the cloud, but exposing additional optional inputs to specify.
         */
        interface WithCreate extends
            Creatable<BatchAccount>,
            Resource.DefinitionWithTags<WithCreate> {
        }
    }

    
The template for a Batch account update operation, containing all the settings that can be modified.
/**
     * The template for a Batch account update operation, containing all the settings that can be modified.
     */
    interface Update extends
            Appliable<BatchAccount>,
            Resource.UpdateWithTags<Update>,
            UpdateStages.WithStorageAccount,
            UpdateStages.WithApplication,
            UpdateStages.WithPool {
    }

    
Grouping of all Batch account update stages.
/**
     * Grouping of all Batch account update stages.
     */
    interface UpdateStages {
        
The stage of a Batch account update allowing to specify a storage account.
/**
         * The stage of a Batch account update allowing to specify a storage account.
         */
        interface WithStorageAccount {
            
Specifies an existing storage account to associate with the Batch account.
Params:
storageAccount – an existing storage account
Returns:
the next stage of the update/**
             * Specifies an existing storage account to associate with the Batch account.
             *
             * @param storageAccount an existing storage account
             * @return the next stage of the update
             */
            Update withExistingStorageAccount(StorageAccount storageAccount);

            
Specifies a new storage account to create and associate with the Batch account.
Params:
storageAccountCreatable – the definition of the storage account
Returns:
the next stage of the update/**
             * Specifies a new storage account to create and associate with the Batch account.
             *
             * @param storageAccountCreatable the definition of the storage account
             * @return the next stage of the update
             */
            Update withNewStorageAccount(Creatable<StorageAccount> storageAccountCreatable);

            
Specifies a new storage account to create and associate with the Batch account.
Params:
storageAccountName – the name of a new storage account
Returns:
the next stage of the update/**
             * Specifies a new storage account to create and associate with the Batch account.
             *
             * @param storageAccountName the name of a new storage account
             * @return the next stage of the update
             */
            Update withNewStorageAccount(String storageAccountName);

            
Removes the associated storage account.
Returns:
the next stage of the update/**
             * Removes the associated storage account.
             *
             * @return the next stage of the update
             */
            Update withoutStorageAccount();
        }

        
The stage of a Batch account definition allowing the creation of a Batch application.
/**
         * The stage of a Batch account definition allowing the creation of a Batch application.
         */
        interface WithApplication {
            
Starts a definition of an application to be created in the Batch account.
Params:
applicationId – the reference name for the application
Returns:
the first stage of a Batch application definition/**
             * Starts a definition of an application to be created in the Batch account.
             *
             * @param applicationId the reference name for the application
             * @return the first stage of a Batch application definition
             */
            Application.UpdateDefinitionStages.Blank<Update> defineNewApplication(String applicationId);

            
Begins the description of an update of an existing Batch application in this Batch account.
Params:
applicationId – the reference name of the application to be updated
Returns:
the first stage of a Batch application update/**
             * Begins the description of an update of an existing Batch application in this Batch account.
             *
             * @param applicationId the reference name of the application to be updated
             * @return the first stage of a Batch application update
             */
            Application.Update updateApplication(String applicationId);

            
Removes the specified application from the Batch account.
Params:
applicationId – the reference name for the application to be removed
Returns:
the next stage of the update/**
             * Removes the specified application from the Batch account.
             *
             * @param applicationId the reference name for the application to be removed
             * @return the next stage of the update
             */
            Update withoutApplication(String applicationId);
        }

        
The stage of a Batch account definition allowing the creation of a Batch pool.
/**
         * The stage of a Batch account definition allowing the creation of a Batch pool.
         */
        interface WithPool {
            
Starts a definition of a pool to be created in the Batch account.
Params:
poolId – the reference name for the pool
Returns:
the first stage of a Batch pool definition/**
             * Starts a definition of a pool to be created in the Batch account.
             *
             * @param poolId the reference name for the pool
             * @return the first stage of a Batch pool definition
             */
            Pool.UpdateDefinitionStages.Blank<Update> defineNewPool(String poolId);

            
Begins the description of an update of an existing Batch pool in this Batch account.
Params:
poolId – the reference name of the pool to be updated
Returns:
the first stage of a Batch pool update/**
             * Begins the description of an update of an existing Batch pool in this Batch account.
             *
             * @param poolId the reference name of the pool to be updated
             * @return the first stage of a Batch pool update
             */
            Pool.Update updatePool(String poolId);

            
Removes the specified pool from the Batch account.
Params:
poolId – the reference name for the pool to be removed
Returns:
the next stage of the update/**
             * Removes the specified pool from the Batch account.
             *
             * @param poolId the reference name for the pool to be removed
             * @return the next stage of the update
             */
            Update withoutPool(String poolId);
        }
    }
}