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

Go to download
/**
 * 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 java.util.Set;

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.network.implementation.BackendAddressPoolInner;
import com.microsoft.azure.management.network.model.HasBackendNics;
import com.microsoft.azure.management.network.model.HasLoadBalancingRules;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ChildResource;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.Settable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;

/**
 * An immutable client-side representation of a load balancer backend address pool.
 */
@Fluent()
@Beta
public interface LoadBalancerBackend extends
    HasInner,
    ChildResource,
    HasLoadBalancingRules,
    HasBackendNics {

    /**
     * @return a list of the resource IDs of the virtual machines associated with this backend
     */
    Set getVirtualMachineIds();

    /**
     * Grouping of load balancer backend definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of a load balancer backend definition.
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface Blank extends WithAttach {
        }

        /** The final stage of a load balancer backend definition.
         * 
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent load balancer definition using {@link WithAttach#attach()}.
         * @param  the return type of {@link WithAttach#attach()}
         */
        interface WithAttach extends
            Attachable.InDefinition {
        }
    }

    /** The entirety of a load balancer backend definition.
     * @param  the return type of the final {@link DefinitionStages.WithAttach#attach()}
     */
    interface Definition extends
        DefinitionStages.Blank,
        DefinitionStages.WithAttach {
    }

    /**
     * Grouping of load balancer backend update stages.
     */
    interface UpdateStages {
    }

    /**
     * The entirety of a load balancer backend update as part of a load balancer update.
     */
    interface Update extends
        Settable {
    }

    /**
     * Grouping of load balancer backend definition stages applicable as part of a load balancer update.
     */
    interface UpdateDefinitionStages {
        /**
         * The first stage of a load balancer backend definition.
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface Blank extends WithAttach {
        }

        /** The final stage of a load balancer backend definition.
         * 
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent load balancer definition using {@link WithAttach#attach()}.
         * @param  the return type of {@link WithAttach#attach()}
         */
        interface WithAttach extends
            Attachable.InUpdate {
        }
    }

    /** The entirety of a load balancer backend definition as part of a load balancer update.
     * @param  the return type of the final {@link UpdateDefinitionStages.WithAttach#attach()}
     */
    interface UpdateDefinition extends
        UpdateDefinitionStages.Blank,
        UpdateDefinitionStages.WithAttach {
    }
}