com.microsoft.azure.management.network.ConnectivityCheck Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of azure-mgmt-network Show documentation
This package contains Microsoft Azure Network Management SDK.
There is a newer version: 1.41.4
/**
 * 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.model.HasNetworkInterfaces;
import com.microsoft.azure.management.network.model.HasProtocol;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent;
import com.microsoft.azure.management.resources.fluentcore.model.Executable;

import java.util.List;

/**
 * A client-side representation allowing user to verify the possibility of establishing a direct TCP connection
 * from a virtual machine to a given endpoint including another VM or an arbitrary remote server.
 */
@Fluent
@Beta(SinceVersion.V1_3_0)
public interface ConnectivityCheck extends
        Executable,
        HasParent {
    /**
     * @return list of hops between the source and the destination
     */
    List hops();

    /**
     * @return the connection status
     */
    ConnectionStatus connectionStatus();

    /**
     * @return average latency in milliseconds
     */
    int avgLatencyInMs();

    /**
     * @return minimum latency in milliseconds
     */
    int minLatencyInMs();

    /**
     * @return maximum latency in milliseconds
     */
    int maxLatencyInMs();

    /**
     * @return total number of probes sent
     */
    int probesSent();

    /**
     * @return number of failed probes
     */
    int probesFailed();

    /**
     * The entirety of connectivity check parameters definition.
     */
    interface Definition extends
            DefinitionStages.ToDestination,
            DefinitionStages.ToDestinationPort,
            DefinitionStages.FromSourceVirtualMachine,
            DefinitionStages.WithExecute {
    }

    /**
     * Grouping of connectivity check parameters definition stages.
     */
    interface DefinitionStages {
        /**
         * Sets the source property.
         */
        interface FromSourceVirtualMachine {
            /**
             * @param resourceId the ID of the virtual machine from which a connectivity check will be initiated
             * @return next definition stage
             */
            WithExecute fromSourceVirtualMachine(String resourceId);
            /**
             * @param vm virtual machine from which a connectivity check will be initiated
             * @return next definition stage
             */
            WithExecute fromSourceVirtualMachine(HasNetworkInterfaces vm);
        }

        /**
         * Sets the destination property.
         */
        interface ToDestination {
            /**
             * @param resourceId the ID of the resource to which a connection attempt will be made
             * @return next definition stage
             */
            ToDestinationPort toDestinationResourceId(String resourceId);

            /**
             * @param address the IP address or URI the resource to which a connection attempt will be made
             * @return next definition stage
             */
            ToDestinationPort toDestinationAddress(String address);
        }

        /**
         * Sets the destination port on which check connectivity will be performed.
         */
        interface ToDestinationPort {
            /**
             * @param port destination port
             * @return next definition stage
             */
            FromSourceVirtualMachine toDestinationPort(int port);
        }

        /**
         * Sets the source port from which a connectivity check will be performed.
         */
        interface FromSourcePort {
            /**
             * @param port source port
             * @return next definition stage
             */
            WithExecute fromSourcePort(int port);
        }

        /**
         * The stage of the definition which contains all the minimum required inputs for execution, but also allows
         * for any other optional settings to be specified.
         */
        interface WithExecute extends
                Executable,
                FromSourcePort,
                HasProtocol.DefinitionStages.WithProtocol {
        }
    }
}