com.microsoft.azure.management.network.AzureReachabilityReport 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.implementation.AzureReachabilityReportInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent;
import com.microsoft.azure.management.resources.fluentcore.model.Executable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import org.joda.time.DateTime;

import java.util.List;

/**
 * An immutable client-side representation of Azure reachability report details.
 */
@Fluent
@Beta(SinceVersion.V1_10_0)
public interface AzureReachabilityReport extends Executable,
        HasInner,
        HasParent {
    /**
     * @return the aggregation level of Azure reachability report. Can be Country,
     * State or City.
     */
    String aggregationLevel();

    /**
     * @return the providerLocation property
     */
    AzureReachabilityReportLocation providerLocation();

    /**
     * @return list of Azure reachability report items.
     */
    List reachabilityReport();
    /**
     * @return parameters used to query available internet providers
     */
    AzureReachabilityReportParameters azureReachabilityReportParameters();

    /**
     * The entirety of Azure reachability report parameters definition.
     */
    interface Definition extends DefinitionStages.WithProviderLocation,
            DefinitionStages.WithStartTime,
            DefinitionStages.WithEndTime,
            DefinitionStages.WithExecute {
    }

    /**
     * Grouping of Azure reachability report definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of Azure reachability report parameters definition.
         */
        interface WithProviderLocation {
            /**
             * @param country the name of the country
             * @return the AzureReachabilityReport object itself
             */
            WithStartTime withProviderLocation(String country);
            /**
             * @param country the name of the country
             * @param state the name of the state
             * @return the AzureReachabilityReport object itself
             */
            WithStartTime withProviderLocation(String country, String state);
            /**
             * @param country the name of the country
             * @param state the name of the state
             * @param city the name of the city
             * @return the AzureReachabilityReport object itself
             */
            WithStartTime withProviderLocation(String country, String state, String city);
        }

        /**
         * Sets the start time for the Azure reachability report.
         */
        interface WithStartTime {
            /**
             * @param startTime the start time for the Azure reachability report
             * @return the next stage of the definition
             */
            WithEndTime withStartTime(DateTime startTime);
        }

        /**
         * Sets the end time for the Azure reachability report.
         */
        interface WithEndTime {
            /**
             * @param endTime the start time for the Azure reachability report
             * @return the next stage of the definition
             */
            WithExecute withEndTime(DateTime endTime);
        }

        /**
         * Sets Azure regions to scope the query to.
         * Note: if none or multiple Azure regions specified, only one provider should be set.
         * If none or multiple providers specified, only one Azure region should be set.
         */
        interface WithAzureLocations {
            WithExecute withAzureLocations(String... azureLocations);
        }

        /**
         * Sets the list of Internet service providers.
         * Note: if none or multiple Azure regions specified, only one provider should be set.
         * If none or multiple providers specified, only one Azure region should be set.
         */
        interface WithProviders {
            /**
             * @param providers the list of Internet service providers
             * @return the next stage of the definition
             */
            WithExecute withProviders(String... providers);
        }

        /**
         * 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,
                DefinitionStages.WithAzureLocations,
                DefinitionStages.WithProviders {
        }
    }
}