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

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Beta.SinceVersion;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.network.implementation.NetworkManager;
import com.microsoft.azure.management.network.implementation.VirtualNetworkGatewayConnectionInner;
import com.microsoft.azure.management.network.model.UpdatableWithTags;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent;
import com.microsoft.azure.management.resources.fluentcore.arm.models.IndependentChildResource;
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 java.util.Collection;

Client-side representation of Virtual Network Gateway Connection object, associated with Virtual Network Gateway.
/**
 * Client-side representation of Virtual Network Gateway Connection object, associated with Virtual Network Gateway.
 */
@Fluent
@Beta(SinceVersion.V1_3_0)
public interface VirtualNetworkGatewayConnection extends
        IndependentChildResource<NetworkManager, VirtualNetworkGatewayConnectionInner>,
        Refreshable<VirtualNetworkGatewayConnection>,
        Updatable<VirtualNetworkGatewayConnection.Update>,
        UpdatableWithTags<VirtualNetworkGatewayConnection>,
        HasParent<VirtualNetworkGateway> {

    
Get the authorizationKey value.
Returns:
the authorizationKey value/**
     * Get the authorizationKey value.
     *
     * @return the authorizationKey value
     */
    String authorizationKey();

    
Returns:
the reference to virtual network gateway resource/**
     * @return the reference to virtual network gateway resource
     */
    String virtualNetworkGateway1Id();

    
Returns:
the reference to virtual network gateway resource./**
     * @return the reference to virtual network gateway resource.
     */
    String virtualNetworkGateway2Id();

    
Returns:
the reference to local network gateway resource/**
     * @return the reference to local network gateway resource
     */
    String localNetworkGateway2Id();

    
Get the gateway connection type.
Returns:
the connectionType value/**
     * Get the gateway connection type.
     *
     * @return the connectionType value
     */
    VirtualNetworkGatewayConnectionType connectionType();

    
Returns:
the routing weight/**
     * @return the routing weight
     */
    int routingWeight();

    
Returns:
the IPSec shared key/**
     * @return the IPSec shared key
     */
    String sharedKey();

    
Get the Virtual Network Gateway connection status.
Returns:
the connectionStatus value/**
     * Get the Virtual Network Gateway connection status.
     * @return the connectionStatus value
     */
    VirtualNetworkGatewayConnectionStatus connectionStatus();

    
Get the tunnelConnectionStatus value.
Returns:
collection of all tunnels' connection health status/**
     * Get the tunnelConnectionStatus value.
     *
     * @return collection of all tunnels' connection health status
     */
    Collection<TunnelConnectionHealth> tunnelConnectionStatus();

    
Returns:
the egress bytes transferred in this connection/**
     * @return the egress bytes transferred in this connection
     */
    long egressBytesTransferred();

    
Returns:
the egress bytes transferred in this connection./**
     * @return the egress bytes transferred in this connection.
     */
    long ingressBytesTransferred();

    
Returns:
the reference to peerings resource/**
     * @return the reference to peerings resource
     */
    String peerId();

    
Returns:
the enableBgp flag/**
     * @return the enableBgp flag
     */
    boolean isBgpEnabled();

    
Returns:
if policy-based traffic selectors enabled/**
     * @return if policy-based traffic selectors enabled
     */
    boolean usePolicyBasedTrafficSelectors();

    
Returns:
the IPSec Policies to be considered by this connection/**
     * @return the IPSec Policies to be considered by this connection
     */
    Collection<IpsecPolicy> ipsecPolicies();

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

    
The entirety of the virtual network gateway connection definition.
/**
     * The entirety of the virtual network gateway connection definition.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.WithConnectionType,
            DefinitionStages.WithLocalNetworkGateway,
            DefinitionStages.WithSecondVirtualNetworkGateway,
            DefinitionStages.WithSharedKey,
            DefinitionStages.WithAuthorization,
            DefinitionStages.WithCreate {
    }

    
Grouping of virtual network gateway connection definition stages.
/**
     * Grouping of virtual network gateway connection definition stages.
     */
    interface DefinitionStages {
        
The first stage of virtual network gateway connection definition.
/**
         * The first stage of virtual network gateway connection definition.
         */
        interface Blank extends WithConnectionType {
        }

        
Stage of definition allowing to specify connection type.
/**
         * Stage of definition allowing to specify connection type.
         */
        interface WithConnectionType {
            
Create Site-to-Site connection.
Returns:
next stage of definition, allowing to specify local network gateway/**
             * Create Site-to-Site connection.
             * @return next stage of definition, allowing to specify local network gateway
             */
            WithLocalNetworkGateway withSiteToSite();

            
Create VNet-to-VNet connection.
Returns:
the next stage of the definition, allowing to specify virtual network gateway to connect to./**
             * Create VNet-to-VNet connection.
             * @return the next stage of the definition, allowing to specify virtual network gateway to connect to.
             */
            WithSecondVirtualNetworkGateway withVNetToVNet();

            
Create Express Route connection.
Params:
circuitId – id of Express Route circuit used for connection
Returns:
next stage of definition/**
             * Create Express Route connection.
             * @param circuitId id of Express Route circuit used for connection
             * @return next stage of definition
             */
            WithCreate withExpressRoute(String circuitId);

            
Create Express Route connection.
Params:
circuit – Express Route circuit used for connection
Returns:
the next stage of the definition/**
             * Create Express Route connection.
             * @param circuit Express Route circuit used for connection
             * @return the next stage of the definition
             */
            WithCreate withExpressRoute(ExpressRouteCircuit circuit);
        }

        
Stage of definition allowing to specify local network gateway to connect to.
/**
         * Stage of definition allowing to specify local network gateway to connect to.
         */
        interface WithLocalNetworkGateway {
            
Params:
localNetworkGateway – local network gateway to connect to
Returns:
the next stage of the definition/**
             * @param localNetworkGateway local network gateway to connect to
             * @return the next stage of the definition
             */
            WithSharedKey withLocalNetworkGateway(LocalNetworkGateway localNetworkGateway);
        }

        
Stage of definition allowing to specify virtual network gateway to connect to.
/**
         * Stage of definition allowing to specify virtual network gateway to connect to.
         */
        interface WithSecondVirtualNetworkGateway {
            
Params:
virtualNetworkGateway2 – virtual network gateway to connect to
Returns:
the next stage of the definition/**
             * @param virtualNetworkGateway2 virtual network gateway to connect to
             * @return the next stage of the definition
             */
            WithSharedKey withSecondVirtualNetworkGateway(VirtualNetworkGateway virtualNetworkGateway2);
        }

        
Stage of definition allowing to specify shared key for the connection.
/**
         * Stage of definition allowing to specify shared key for the connection.
         */
        interface WithSharedKey {
            
Specify shared key.
Params:
sharedKey – shared key
Returns:
the next stage of the definition/**
             * Specify shared key.
             * @param sharedKey shared key
             * @return the next stage of the definition
             */
            WithCreate withSharedKey(String sharedKey);
        }

        
Stage of definition allowing to enable BGP for the connection.
/**
         * Stage of definition allowing to enable BGP for the connection.
         */
        interface WithBgp {
            
Enable BGP for the connection.
Returns:
the next stage of the definition/**
             * Enable BGP for the connection.
             * @return the next stage of the definition
             */
            WithCreate withBgp();
        }

        
Stage of definition allowing to add authorization for the connection.
/**
         * Stage of definition allowing to add authorization for the connection.
         */
        interface WithAuthorization {
            
Specify authorization key.
This is required in case of Express Route connection if Express Route circuit and virtual network gateway reside in different subscriptions.
Params:
authorizationKey – authorization key to use
Returns:
the next stage of the definition/**
             * Specify authorization key.
             * This is required in case of Express Route connection if Express Route circuit and virtual network gateway reside in different subscriptions.
             * @param authorizationKey authorization key to use
             * @return the next stage of the definition
             */
            WithCreate withAuthorization(String authorizationKey);
        }

        
The stage of a virtual network gateway connection definition with sufficient inputs to create a new connection in the cloud,
but exposing additional optional settings to specify.
/**
         * The stage of a virtual network gateway connection definition with sufficient inputs to create a new connection in the cloud,
         * but exposing additional optional settings to specify.
         */
        interface WithCreate extends
                Creatable<VirtualNetworkGatewayConnection>,
                Resource.DefinitionWithTags<WithCreate>,
                WithBgp,
                WithAuthorization {
        }
    }

    
Grouping of virtual network gateway connection update stages.
/**
     * Grouping of virtual network gateway connection update stages.
     */
    interface Update extends
            Appliable<VirtualNetworkGatewayConnection>,
            Resource.UpdateWithTags<Update>,
            UpdateStages.WithBgp,
            UpdateStages.WithSharedKey,
            UpdateStages.WithAuthorization {
    }

    
Grouping of virtual network gateway connection update stages.
/**
     * Grouping of virtual network gateway connection update stages.
     */
    interface UpdateStages {
        
Stage of virtual network gateway connection update allowing to enable or disable BGP for the connection.
/**
         * Stage of virtual network gateway connection update allowing to enable or disable BGP for the connection.
         */
        interface WithBgp {
            
Enable BGP for the connection.
Returns:
the next stage of the update/**
             * Enable BGP for the connection.
             * @return the next stage of the update
             */
            Update withBgp();

            
Disable BGP for the connection.
Returns:
the next stage of the update/**
             * Disable BGP for the connection.
             * @return the next stage of the update
             */
            Update withoutBgp();
        }

        
Stage of virtual network gateway connection update allowing to specify shared key for the connection.
/**
         * Stage of virtual network gateway connection update allowing to specify shared key for the connection.
         */
        interface WithSharedKey {
            
Specify shared key.
Params:
sharedKey – shared key
Returns:
the next stage of the update/**
             * Specify shared key.
             * @param sharedKey shared key
             * @return the next stage of the update
             */
            Update withSharedKey(String sharedKey);
        }

        
Stage of virtual network gateway connection update allowing to add authorization for the connection.
/**
         * Stage of virtual network gateway connection update allowing to add authorization for the connection.
         */
        interface WithAuthorization {
            
Specify authorization key.
This is required in case of Express Route connection if Express Route circuit and virtual network gateway reside in different subscriptions.
Params:
authorizationKey – authorization key to use
Returns:
the next stage of the update/**
             * Specify authorization key.
             * This is required in case of Express Route connection if Express Route circuit and virtual network gateway reside in different subscriptions.
             * @param authorizationKey authorization key to use
             * @return the next stage of the update
             */
            Update withAuthorization(String authorizationKey);
        }
    }
}