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

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.batchai.implementation.BatchAIManager;
import com.microsoft.azure.management.batchai.implementation.FileServerInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasId;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasName;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Indexable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import org.joda.time.DateTime;

Entry point for Batch AI file server management API in Azure.
/**
 * Entry point for Batch AI file server management API in Azure.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_6_0)
public interface BatchAIFileServer extends
        HasInner<FileServerInner>,
        Indexable,
        HasId,
        HasName,
        HasManager<BatchAIManager>,
        Refreshable<BatchAIFileServer> {

    
Returns:
the size of the virtual machine of the File Server.
For information about available VM sizes for File Server from the
Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux)./**
     * @return the size of the virtual machine of the File Server.
     * For information about available VM sizes for File Server from the
     * Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux).
     */
    String vmSize();

    
Returns:
SSH settings for the File Server/**
     * @return SSH settings for the File Server
     */
    SshConfiguration sshConfiguration();

    
Returns:
settings for the data disk which would be created for the File Server/**
     * @return settings for the data disk which would be created for the File Server
     */
    DataDisks dataDisks();

    
Returns:
the identifier of the subnet/**
     * @return the identifier of the subnet
     */
    ResourceId subnet();

    
Returns:
details of the File Server/**
     * @return details of the File Server
     */
    MountSettings mountSettings();

    
Returns:
time when the status was changed/**
     * @return time when the status was changed
     */
    DateTime provisioningStateTransitionTime();

    
Returns:
time when the FileServer was created/**
     * @return time when the FileServer was created
     */
    DateTime creationTime();

    
Returns:
the provisioning state of the File Server/**
     * @return the provisioning state of the File Server
     */
    FileServerProvisioningState provisioningState();

    
Returns:
workspace this fileserver belongs to/**
     * @return workspace this fileserver belongs to
     */
    BatchAIWorkspace workspace();

    
The entirety of a Batch AI file server definition.
/**
     * The entirety of a Batch AI file server definition.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.WithVMSize,
            DefinitionStages.WithUserName,
            DefinitionStages.WithUserCredentials,
            DefinitionStages.WithCreate {
    }

    
Grouping of Batch AI file server definition stages.
/**
     * Grouping of Batch AI file server definition stages.
     */
    interface DefinitionStages {
        
The first stage of a Batch AI file server definition.
/**
         * The first stage of a Batch AI file server definition.
         */
        interface Blank extends WithDataDisks {
        }

        
This stage of a Batch AI file server definition allows to specify data disks parameters.
/**
         * This stage of a Batch AI file server definition allows to specify data disks parameters.
         */
        interface WithDataDisks {
            
Specifies settings for the data disks which would be created for the file server.
Params:
diskSizeInGB – initial disk size in GB for blank data disks
diskCount – number of data disks to be attached to the VM. RAID level 0 will be applied in the case of multiple disks.
storageAccountType – type of storage account to be used on the disk
Returns:
the next stage of the definition/**
             * Specifies settings for the data disks which would be created for the file server.
             * @param diskSizeInGB initial disk size in GB for blank data disks
             * @param diskCount number of data disks to be attached to the VM. RAID level 0 will be applied in the case of multiple disks.
             * @param storageAccountType type of storage account to be used on the disk
             * @return the next stage of the definition
             */
            WithVMSize withDataDisks(int diskSizeInGB, int diskCount, StorageAccountType storageAccountType);

            
Specifies settings for the data disks which would be created for the file server.
Params:
diskSizeInGB – initial disk size in GB for blank data disks.
diskCount – number of data disks to be attached to the VM. RAID level 0 will be applied in the case of multiple disks.
storageAccountType – type of storage account to be used on the disk
cachingType – caching type
Returns:
the next stage of the definition/**
             * Specifies settings for the data disks which would be created for the file server.
             * @param diskSizeInGB initial disk size in GB for blank data disks.
             * @param diskCount number of data disks to be attached to the VM. RAID level 0 will be applied in the case of multiple disks.
             * @param storageAccountType type of storage account to be used on the disk
             * @param cachingType caching type
             * @return the next stage of the definition
             */
            WithVMSize withDataDisks(int diskSizeInGB, int diskCount, StorageAccountType storageAccountType, CachingType cachingType);
        }

        
This stage of a Batch AI file server definition allows to specify virtual machine size.
/**
         * This stage of a Batch AI file server definition allows to specify virtual machine size.
         */
        interface WithVMSize {
            
Specifies size of the virtual machine of the File Server.
Params:
vmSize – virtual machine size
Returns:
next stage of the definition/**
             * Specifies size of the virtual machine of the File Server.
             * @param vmSize virtual machine size
             * @return next stage of the definition
             */
            WithUserName withVMSize(String vmSize);
        }

        
This stage of a Batch AI file server definition allows to specify administrator account name.
/**
         * This stage of a Batch AI file server definition allows to specify administrator account name.
         */
        interface WithUserName {
            
Specifies admin user name.
Params:
userName – the name of the administrator account
Returns:
the next stage of the definition/**
             * Specifies admin user name.
             * @param userName the name of the administrator account
             * @return the next stage of the definition
             */
            WithUserCredentials withUserName(String userName);
        }

        
This stage of a Batch AI file server definition allows to specify user credentials.
/**
         * This stage of a Batch AI file server definition allows to specify user credentials.
         */
        interface WithUserCredentials {
            
Specifies admin user password.
Params:
password – admin user Password (linux only)
Returns:
the next stage of the definition/**
             * Specifies admin user password.
             * @param password admin user Password (linux only)
             * @return the next stage of the definition
             */
            WithCreate withPassword(String password);

            
Specifies public key for authentication.
Params:
sshPublicKey – SSH public keys used to authenticate with linux based VMs
Returns:
the next stage of the definition/**
             * Specifies public key for authentication.
             * @param sshPublicKey SSH public keys used to authenticate with linux based VMs
             * @return the next stage of the definition
             */
            WithCreate withSshPublicKey(String sshPublicKey);
        }

        
Defines subnet for the file server.
/**
         * Defines subnet for the file server.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithSubnet {
            
Specifies subnet id.
Params:
subnetId – identifier of the subnet
Returns:
the next stage of the definition/**
             * Specifies subnet id.
             * @param subnetId identifier of the subnet
             * @return the next stage of the definition
             */
            WithCreate withSubnet(String subnetId);

            
Specifies network id and subnet name within this network.
Params:
networkId – identifier of the network
subnetName – subnet name
Returns:
the next stage of the definition/**
             * Specifies network id and subnet name within this network.
             * @param networkId identifier of the network
             * @param subnetName subnet name
             * @return the next stage of the definition
             */
            WithCreate withSubnet(String networkId, String subnetName);
        }


        
The stage of the definition which contains all the minimum required inputs for the resource to be created
but also allows for any other optional settings to be specified.
/**
         * The stage of the definition which contains all the minimum required inputs for the resource to be created
         * but also allows for any other optional settings to be specified.
         */
        interface WithCreate extends
                Creatable<BatchAIFileServer>,
                DefinitionStages.WithUserCredentials,
                DefinitionStages.WithSubnet {
        }
    }
}