Package com.microsoft.azure.management.appservice

Class RampUpRule

  • public class RampUpRule
extends Object
    Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

    • Constructor Detail

      • RampUpRule

        public RampUpRule()

    • Method Detail

      • actionHostName

        public String actionHostName()
        Get hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
        Returns:
        the actionHostName value

      • withActionHostName

        public RampUpRule withActionHostName​(String actionHostName)
        Set hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
        Parameters:
        actionHostName - the actionHostName value to set
        Returns:
        the RampUpRule object itself.

      • reroutePercentage

        public Double reroutePercentage()
        Get percentage of the traffic which will be redirected to <code>ActionHostName</code>.
        Returns:
        the reroutePercentage value

      • withReroutePercentage

        public RampUpRule withReroutePercentage​(Double reroutePercentage)
        Set percentage of the traffic which will be redirected to <code>ActionHostName</code>.
        Parameters:
        reroutePercentage - the reroutePercentage value to set
        Returns:
        the RampUpRule object itself.

      • changeStep

        public Double changeStep()
        Get in auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.
        Returns:
        the changeStep value

      • withChangeStep

        public RampUpRule withChangeStep​(Double changeStep)
        Set in auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.
        Parameters:
        changeStep - the changeStep value to set
        Returns:
        the RampUpRule object itself.

      • changeIntervalInMinutes

        public Integer changeIntervalInMinutes()
        Get specifies interval in minutes to reevaluate ReroutePercentage.
        Returns:
        the changeIntervalInMinutes value

      • withChangeIntervalInMinutes

        public RampUpRule withChangeIntervalInMinutes​(Integer changeIntervalInMinutes)
        Set specifies interval in minutes to reevaluate ReroutePercentage.
        Parameters:
        changeIntervalInMinutes - the changeIntervalInMinutes value to set
        Returns:
        the RampUpRule object itself.

      • minReroutePercentage

        public Double minReroutePercentage()
        Get specifies lower boundary above which ReroutePercentage will stay.
        Returns:
        the minReroutePercentage value

      • withMinReroutePercentage

        public RampUpRule withMinReroutePercentage​(Double minReroutePercentage)
        Set specifies lower boundary above which ReroutePercentage will stay.
        Parameters:
        minReroutePercentage - the minReroutePercentage value to set
        Returns:
        the RampUpRule object itself.

      • maxReroutePercentage

        public Double maxReroutePercentage()
        Get specifies upper boundary below which ReroutePercentage will stay.
        Returns:
        the maxReroutePercentage value

      • withMaxReroutePercentage

        public RampUpRule withMaxReroutePercentage​(Double maxReroutePercentage)
        Set specifies upper boundary below which ReroutePercentage will stay.
        Parameters:
        maxReroutePercentage - the maxReroutePercentage value to set
        Returns:
        the RampUpRule object itself.

      • changeDecisionCallbackUrl

        public String changeDecisionCallbackUrl()
        Get custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/.
        Returns:
        the changeDecisionCallbackUrl value

      • withChangeDecisionCallbackUrl

        public RampUpRule withChangeDecisionCallbackUrl​(String changeDecisionCallbackUrl)
        Set custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/.
        Parameters:
        changeDecisionCallbackUrl - the changeDecisionCallbackUrl value to set
        Returns:
        the RampUpRule object itself.

      • name

        public String name()
        Get name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
        Returns:
        the name value

      • withName

        public RampUpRule withName​(String name)
        Set name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
        Parameters:
        name - the name value to set
        Returns:
        the RampUpRule object itself.