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

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ExternalChildResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import com.microsoft.azure.management.sql.implementation.VirtualNetworkRuleInner;
import rx.Completable;

An immutable client-side representation of an Azure SQL Server Virtual Network Rule.
/**
 * An immutable client-side representation of an Azure SQL Server Virtual Network Rule.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_8_0)
public interface SqlVirtualNetworkRule
    extends
    ExternalChildResource<SqlVirtualNetworkRule, SqlServer>,
    HasInner<VirtualNetworkRuleInner>,
    HasResourceGroup,
    Refreshable<SqlVirtualNetworkRule>,
    Updatable<SqlVirtualNetworkRule.Update> {

    
Returns:
name of the SQL Server to which this Virtual Network Rule belongs/**
     * @return name of the SQL Server to which this Virtual Network Rule belongs
     */
    String sqlServerName();

    
Returns:
the subnet ID of the Azure SQL Server Virtual Network Rule./**
     * @return the subnet ID of the Azure SQL Server Virtual Network Rule.
     */
    String subnetId();

    
Returns:
the Azure SQL Server Virtual Network Rule state; possible values include: 'Initializing',
'InProgress', 'Ready', 'Deleting', 'Unknown'/**
     * @return the Azure SQL Server Virtual Network Rule state; possible values include: 'Initializing',
     * 'InProgress', 'Ready', 'Deleting', 'Unknown'
     */
    String state();

    
Returns:
the parent SQL server ID/**
     * @return the parent SQL server ID
     */
    String parentId();

    
Deletes the virtual network rule.
/**
     * Deletes the virtual network rule.
     */
    @Method
    void delete();

    
Deletes the virtual network rule asynchronously.
Returns:
a representation of the deferred computation of this call/**
     * Deletes the virtual network rule asynchronously.
     *
     * @return a representation of the deferred computation of this call
     */
    @Method
    Completable deleteAsync();


    /**************************************************************
     * Fluent interfaces to provision a SQL Virtual Network Rule
     **************************************************************/

    
Container interface for all the definitions that need to be implemented.
Type parameters:
<ParentT> – the stage of the parent definition to return to after attaching this definition/**
     * Container interface for all the definitions that need to be implemented.
     *
     * @param <ParentT> the stage of the parent definition to return to after attaching this definition
     */
    @Beta(Beta.SinceVersion.V1_8_0)
    interface SqlVirtualNetworkRuleDefinition<ParentT> extends
        SqlVirtualNetworkRule.DefinitionStages.Blank<ParentT>,
        SqlVirtualNetworkRule.DefinitionStages.WithSubnet<ParentT>,
        SqlVirtualNetworkRule.DefinitionStages.WithServiceEndpoint<ParentT>,
        SqlVirtualNetworkRule.DefinitionStages.WithAttach<ParentT> {
    }

    
Grouping of all the SQL Virtual Network Rule definition stages.
/**
     * Grouping of all the SQL Virtual Network Rule definition stages.
     */
    @Beta(Beta.SinceVersion.V1_8_0)
    interface DefinitionStages {
        
The first stage of the SQL Server Virtual Network Rule definition.
Type parameters:
<ParentT> – the stage of the parent definition to return to after attaching this definition/**
         * The first stage of the SQL Server Virtual Network Rule definition.
         *
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface Blank<ParentT> extends
            SqlVirtualNetworkRule.DefinitionStages.WithSubnet<ParentT> {
        }

        
The SQL Virtual Network Rule definition to set the virtual network ID and the subnet name.
/**
         * The SQL Virtual Network Rule definition to set the virtual network ID and the subnet name.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithSubnet<ParentT> {
            
Sets the virtual network ID and the subnet name for the SQL server Virtual Network Rule.
Params:
networkId – the virtual network ID to be used
subnetName – the name of the subnet within the virtual network to be used
Returns:
The next stage of the definition./**
             * Sets the virtual network ID and the subnet name for the SQL server Virtual Network Rule.
             *
             * @param networkId the virtual network ID to be used
             * @param subnetName the name of the subnet within the virtual network to be used
             * @return The next stage of the definition.
             */
            SqlVirtualNetworkRule.DefinitionStages.WithServiceEndpoint<ParentT> withSubnet(String networkId, String subnetName);
        }

        
The SQL Virtual Network Rule definition to set ignore flag for the missing subnet's SQL service endpoint entry.
/**
         * The SQL Virtual Network Rule definition to set ignore flag for the missing subnet's SQL service endpoint entry.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithServiceEndpoint<ParentT> extends SqlVirtualNetworkRule.DefinitionStages.WithAttach<ParentT> {
            
Sets the flag to ignore the missing subnet's SQL service endpoint entry.

Virtual Machines in the subnet will not be able to connect to the SQL server until Microsoft.Sql
 service endpoint is added to the subnet
Returns:
The next stage of the definition./**
             * Sets the flag to ignore the missing subnet's SQL service endpoint entry.
             * <p>
             * Virtual Machines in the subnet will not be able to connect to the SQL server until Microsoft.Sql
             *  service endpoint is added to the subnet
             *
             * @return The next stage of the definition.
             */
            SqlVirtualNetworkRule.DefinitionStages.WithAttach<ParentT> ignoreMissingSqlServiceEndpoint();
        }

        
The final stage of the SQL Virtual Network Rule definition.

At this stage, any remaining optional settings can be specified, or the SQL Virtual Network Rule definition
can be attached to the parent SQL Server definition.
Type parameters:
<ParentT> – the stage of the parent definition to return to after attaching this definition/** The final stage of the SQL Virtual Network Rule definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the SQL Virtual Network Rule definition
         * can be attached to the parent SQL Server definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithAttach<ParentT> extends
            Attachable.InDefinition<ParentT> {
        }
    }

    
The template for a SQL Virtual Network Rule update operation, containing all the settings that can be modified.
/**
     * The template for a SQL Virtual Network Rule update operation, containing all the settings that can be modified.
     */
    @Beta(Beta.SinceVersion.V1_8_0)
    interface Update extends
        SqlVirtualNetworkRule.UpdateStages.WithSubnet,
        SqlVirtualNetworkRule.UpdateStages.WithServiceEndpoint,
        Appliable<SqlVirtualNetworkRule> {
    }

    
Grouping of all the SQL Virtual Network Rule update stages.
/**
     * Grouping of all the SQL Virtual Network Rule update stages.
     */
    @Beta(Beta.SinceVersion.V1_8_0)
    interface UpdateStages {
        
The SQL Virtual Network Rule definition to set the virtual network ID and the subnet name.
/**
         * The SQL Virtual Network Rule definition to set the virtual network ID and the subnet name.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithSubnet {
            
Sets the virtual network ID and the subnet name for the SQL server Virtual Network Rule.
Params:
networkId – the virtual network ID to be used
subnetName – the name of the subnet within the virtual network to be used
Returns:
The next stage of the definition./**
             * Sets the virtual network ID and the subnet name for the SQL server Virtual Network Rule.
             *
             * @param networkId the virtual network ID to be used
             * @param subnetName the name of the subnet within the virtual network to be used
             * @return The next stage of the definition.
             */
            SqlVirtualNetworkRule.Update withSubnet(String networkId, String subnetName);
        }

        
The SQL Virtual Network Rule definition to set ignore flag for the missing subnet's SQL service endpoint entry.
/**
         * The SQL Virtual Network Rule definition to set ignore flag for the missing subnet's SQL service endpoint entry.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithServiceEndpoint {
            
Sets the flag to ignore the missing subnet's SQL service endpoint entry.

Virtual Machines in the subnet will not be able to connect to the SQL server until Microsoft.Sql
 service endpoint is added to the subnet
Returns:
The next stage of the definition./**
             * Sets the flag to ignore the missing subnet's SQL service endpoint entry.
             * <p>
             * Virtual Machines in the subnet will not be able to connect to the SQL server until Microsoft.Sql
             *  service endpoint is added to the subnet
             *
             * @return The next stage of the definition.
             */
            SqlVirtualNetworkRule.Update ignoreMissingSqlServiceEndpoint();
        }
    }
}