com.azure.resourcemanager.network.models.LoadBalancerInboundNatRule 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.network.fluent.models.InboundNatRuleInner;
import com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource;
import com.azure.resourcemanager.resources.fluentcore.model.Attachable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Settable;

/** An immutable client-side representation of an inbound NAT rule. */
@Fluent()
public interface LoadBalancerInboundNatRule
    extends HasFrontend,
        HasBackendPort,
        HasProtocol,
        HasFloatingIP,
        HasFrontendPort,
        HasInnerModel,
        ChildResource {

    /** @return the name of the IP configuration within the network interface associated with this NAT rule */
    String backendNicIpConfigurationName();

    /** @return the resource ID of the network interface assigned as the backend of this inbound NAT rule */
    String backendNetworkInterfaceId();

    /** @return the number of minutes before an idle connection is closed */
    int idleTimeoutInMinutes();

    /** Grouping of inbound NAT rule definition stages. */
    interface DefinitionStages {
        /**
         * The first stage of the inbound NAT rule definition.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface Blank extends WithProtocol {
        }

        /**
         * The final stage of the inbound NAT rule definition.
         *
         * At this stage, any remaining optional settings can be specified, or the inbound NAT rule definition can be
         * attached to the parent load balancer definition.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithAttach
            extends Attachable.InDefinition,
                DefinitionStages.WithBackendPort,
                DefinitionStages.WithFloatingIP,
                DefinitionStages.WithIdleTimeout {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the transport protocol.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithProtocol
            extends HasProtocol.DefinitionStages.WithProtocol, TransportProtocol> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify a frontend for the rule to apply to.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithFrontend extends HasFrontend.DefinitionStages.WithFrontend> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the backend port.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithBackendPort
            extends HasBackendPort.DefinitionStages.WithBackendPort> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify whether floating IP should be enabled.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithFloatingIP extends HasFloatingIP.DefinitionStages.WithFloatingIP> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the frontend port.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithFrontendPort
            extends HasFrontendPort.DefinitionStages.WithFrontendPort> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the idle connection timeout for this inbound
         * NAT rule.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithIdleTimeout {
            /**
             * Specifies the idle connection timeout in minutes.
             *
             * @param minutes a number of minutes
             * @return the next stage of the definition
             */
            WithAttach withIdleTimeoutInMinutes(int minutes);
        }
    }

    /**
     * The entirety of an inbound NAT rule definition.
     *
     * @param  the stage of the parent definition to return to after attaching this definition
     */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithProtocol,
            DefinitionStages.WithFrontend,
            DefinitionStages.WithFrontendPort,
            DefinitionStages.WithAttach {
    }

    /** Grouping of inbound NAT rule update stages. */
    interface UpdateStages {
        /** The stage of an inbound NAT rule update allowing to specify the backend port. */
        interface WithBackendPort extends HasBackendPort.UpdateStages.WithBackendPort {
        }

        /** The stage of an inbound NAT rule update allowing to specify a frontend for the rule to apply to. */
        interface WithFrontend extends HasFrontend.UpdateStages.WithFrontend {
        }

        /**
         * The stage of an inbound NAT rule update allowing to specify the transport protocol for the rule to apply to.
         */
        interface WithProtocol extends HasProtocol.UpdateStages.WithProtocol {
        }

        /** The stage of an inbound NAT rule update allowing to specify whether floating IP should be enabled. */
        interface WithFloatingIP extends HasFloatingIP.UpdateStages.WithFloatingIP {
        }

        /** The stage of an inbound NAT rule update allowing to specify the frontend port. */
        interface WithFrontendPort extends HasFrontendPort.UpdateStages.WithFrontendPort {
        }

        /**
         * The stage of an inbound NAT rule update allowing to specify the idle connection timeout for this inbound NAT
         * rule.
         */
        interface WithIdleTimeout {
            /**
             * Specifies the idle connection timeout in minutes.
             *
             * @param minutes a number of minutes
             * @return the next stage of the update
             */
            Update withIdleTimeoutInMinutes(int minutes);
        }
    }

    /** The entirety of an inbound NAT rule update as part of a load balancer update. */
    interface Update
        extends Settable,
            UpdateStages.WithBackendPort,
            UpdateStages.WithFloatingIP,
            UpdateStages.WithFrontend,
            UpdateStages.WithFrontendPort,
            UpdateStages.WithIdleTimeout,
            UpdateStages.WithProtocol {
    }

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

        /**
         * The final stage of the inbound NAT rule definition.
         *
         * At this stage, any remaining optional settings can be specified, or the inbound NAT rule definition can be
         * attached to the parent load balancer definition.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithAttach
            extends Attachable.InUpdate,
                UpdateDefinitionStages.WithBackendPort,
                UpdateDefinitionStages.WithFloatingIP,
                UpdateDefinitionStages.WithIdleTimeout {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the transport protocol.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithProtocol
            extends HasProtocol.UpdateDefinitionStages.WithProtocol, TransportProtocol> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify a frontend for the rule to apply to.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithFrontend
            extends HasFrontend.UpdateDefinitionStages.WithFrontend> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the backend port.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithBackendPort
            extends HasBackendPort.UpdateDefinitionStages.WithBackendPort> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify whether floating IP should be enabled.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithFloatingIP
            extends HasFloatingIP.UpdateDefinitionStages.WithFloatingIP> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the frontend port.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithFrontendPort
            extends HasFrontendPort.UpdateDefinitionStages.WithFrontendPort> {
        }

        /**
         * The stage of an inbound NAT rule definition allowing to specify the idle connection timeout for this inbound
         * NAT rule.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithIdleTimeout {
            /**
             * Specifies the idle connection timeout in minutes.
             *
             * @param minutes a number of minutes
             * @return the next stage of the definition
             */
            WithAttach withIdleTimeoutInMinutes(int minutes);
        }
    }

    /**
     * The entirety of an inbound NAT rule definition.
     *
     * @param  the stage of the parent definition to return to after attaching this definition
     */
    interface UpdateDefinition
        extends UpdateDefinitionStages.Blank,
            UpdateDefinitionStages.WithProtocol,
            UpdateDefinitionStages.WithFrontend,
            UpdateDefinitionStages.WithFrontendPort,
            UpdateDefinitionStages.WithAttach {
    }
}