com.azure.resourcemanager.network.models.ConnectivityCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-network Show documentation

This package contains Microsoft Azure Network Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt

There is a newer version: 2.44.0

Show newest version

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.resourcemanager.network.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent;
import com.azure.resourcemanager.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
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 {
        }
    }
}