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.apigeneration.Method;
import com.microsoft.azure.management.network.implementation.NetworkManager;
import com.microsoft.azure.management.network.implementation.NetworkWatcherInner;
import com.microsoft.azure.management.network.model.UpdatableWithTags;
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 rx.Observable;

Entry point for Network Watcher API in Azure.
/**
 * Entry point for Network Watcher API in Azure.
 */
@Fluent
@Beta(SinceVersion.V1_2_0)
public interface NetworkWatcher extends
        GroupableResource<NetworkManager, NetworkWatcherInner>,
        Refreshable<NetworkWatcher>,
        Updatable<NetworkWatcher.Update>,
        UpdatableWithTags<NetworkWatcher> {

    
Returns:
entry point to manage packet captures associated with network watcher/**
     * @return entry point to manage packet captures associated with network watcher
     */
    PacketCaptures packetCaptures();

    
Returns:
entry point to manage connection monitors associated with network watcher/**
     * @return entry point to manage connection monitors associated with network watcher
     */
    @Beta(SinceVersion.V1_10_0)
    @Method
    ConnectionMonitors connectionMonitors();

    
First step specifying parameters to get topology of a resource group.
Returns:
current network topology by resource group/**
     * First step specifying parameters to get topology of a resource group.
     * @return current network topology by resource group
     */
    @Method
    Topology.DefinitionStages.WithTargetResourceGroup topology();

    
Gets the configured and effective security group rules on the specified VM.
Params:
vmId – ID of the target VM
Returns:
the configured and effective security group rules on the specified VM/**
     * Gets the configured and effective security group rules on the specified VM.
     * @param vmId ID of the target VM
     * @return the configured and effective security group rules on the specified VM
     */
    SecurityGroupView getSecurityGroupView(String vmId);

    
Gets the configured and effective security group rules on the specified VM asynchronously.
Params:
vmId – ID of the target VM
Returns:
the configured and effective security group rules on the specified VM/**
     * Gets the configured and effective security group rules on the specified VM asynchronously.
     * @param vmId ID of the target VM
     * @return the configured and effective security group rules on the specified VM
     */
    Observable<SecurityGroupView> getSecurityGroupViewAsync(String vmId);

    
Gets the information on the configuration of flow log.
Params:
nsgId – the name of the target resource group to get flow log status for
Returns:
information on the configuration of flow log/**
     * Gets the information on the configuration of flow log.
     * @param nsgId the name of the target resource group to get flow log status for
     * @return information on the configuration of flow log
     */
    FlowLogSettings getFlowLogSettings(String nsgId);

    
Gets the information on the configuration of flow log asynchronously.
Params:
nsgId – the name of the target resource group to get flow log status for
Returns:
information on the configuration of flow log/**
     * Gets the information on the configuration of flow log asynchronously.
     * @param nsgId the name of the target resource group to get flow log status for
     * @return information on the configuration of flow log
     */
    Observable<FlowLogSettings> getFlowLogSettingsAsync(String nsgId);

    
First step specifying the parameters to get next hop for the VM.
Returns:
a stage to specify parameters for next hop/**
     * First step specifying the parameters to get next hop for the VM.
     * @return a stage to specify parameters for next hop
     */
    @Method
    NextHop.DefinitionStages.WithTargetResource nextHop();

    
Verify IP flow from the specified VM to a location given the currently configured NSG rules.
Returns:
a stage to specify parameters for ip flow verification/**
     * Verify IP flow from the specified VM to a location given the currently configured NSG rules.
     * @return a stage to specify parameters for ip flow verification
     */
    @Method
    VerificationIPFlow.DefinitionStages.WithTargetResource verifyIPFlow();

    
Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint
including another virtual machine or an arbitrary remote server.
Returns:
a stage to specify parameters for connectivity check/**
     * Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint
     * including another virtual machine or an arbitrary remote server.
     * @return a stage to specify parameters for connectivity check
     */
    @Method
    ConnectivityCheck.DefinitionStages.ToDestination checkConnectivity();

    
Initiate troubleshooting on a specified resource (virtual network gateway or virtual network gateway connection).
Returns:
troubleshooting result information/**
     * Initiate troubleshooting on a specified resource (virtual network gateway or virtual network gateway connection).
     * @return troubleshooting result information
     */
    @Beta(SinceVersion.V1_4_0)
    @Method
    Troubleshooting.DefinitionStages.WithTargetResource troubleshoot();

    
Lists all available internet service providers for a specified Azure region.
Returns:
a stage to specify parameters for internet providers list/**
     * Lists all available internet service providers for a specified Azure region.
     * @return a stage to specify parameters for internet providers list
     */
    @Beta(SinceVersion.V1_10_0)
    @Method
    AvailableProviders.DefinitionStages.WithExecute availableProviders();

    
Gets the relative latency score for internet service providers from a specified location to Azure regions.
Returns:
a stage to specify parameters for internet providers list/**
     * Gets the relative latency score for internet service providers from a specified location to Azure regions.
     * @return a stage to specify parameters for internet providers list
     */
    @Beta(SinceVersion.V1_10_0)
    @Method
    AzureReachabilityReport.DefinitionStages.WithProviderLocation azureReachabilityReport();

    
Container interface for all the definitions.
/**
     * Container interface for all the definitions.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.WithGroup,
            DefinitionStages.WithCreate {
    }

    
Grouping of network watcher definition stages.
/**
     * Grouping of network watcher definition stages.
     */
    interface DefinitionStages {
        
The first stage of a network watcher definition.
/**
         * The first stage of a network watcher definition.
         */
        interface Blank extends GroupableResource.DefinitionWithRegion<WithGroup> {
        }

        
The stage of the network watcher definition allowing to specify the resource group.
/**
         * The stage of the network watcher definition allowing to specify the resource group.
         */
        interface WithGroup extends GroupableResource.DefinitionStages.WithGroup<DefinitionStages.WithCreate> {
        }

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

    
The template for update operation, containing all the settings that can be modified.
/**
     * The template for update operation, containing all the settings that can be modified.
     */
    interface Update extends
            Appliable<NetworkWatcher>,
            Resource.UpdateWithTags<Update> {
    }
}