https://github.com/Azure/azure-sdk-for-java: This package contains Microsoft Azure Network Management SDK. A new set of management libraries are now Generally Available. For documentation on how to use the new libraries, please see https://aka.ms/azsdk/java/mgmt
  • Microsoft 
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.

/**
 * 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.Fluent;
import com.microsoft.azure.management.network.implementation.RouteInner;
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 route of a route table.

/**
 * An immutable client-side representation of a route of a route table.
 */
@Fluent()
public interface Route extends
    HasInner<RouteInner>,
    ChildResource<RouteTable> {

    
Returns:the destination address prefix, expressed using the CIDR notation, to which the route applies
/**
     * @return the destination address prefix, expressed using the CIDR notation, to which the route applies
     */
    String destinationAddressPrefix();

    
Returns:the type of the next hop
/**
     * @return the type of the next hop
     */
    RouteNextHopType nextHopType();

    
Returns:the IP address of the next hop
/**
     * @return the IP address of the next hop
     */
    String nextHopIPAddress();

    // Grouping of route definition stages

    
Grouping of route definition stages.

/**
     * Grouping of route definition stages.
     */
    interface DefinitionStages {
        
The first stage of a route definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The first stage of a route definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithDestinationAddressPrefix<ParentT> {
        }

        
The final stage of a route definition.

 At this stage, any remaining optional settings can be specified, or the route definition can be attached to the parent route table definition using InDefinition.attach(). 
Type parameters:
/** The final stage of a route definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the route definition
         * can be attached to the parent route table definition using {@link WithAttach#attach()}.
         * @param <ParentT> the return type of {@link WithAttach#attach()}
         */
        interface WithAttach<ParentT> extends
            Attachable.InDefinition<ParentT> {
        }

        
The stage of a route definition allowing to specify the destination address prefix.

Type parameters:
/**
         * The stage of a route definition allowing to specify the destination address prefix.
         * @param <ParentT> the return type of {@link WithAttach#attach()}
         */
        interface WithDestinationAddressPrefix<ParentT> {
            
Specifies the destination address prefix to apply the route to.

Params:
  • cidr – an address prefix expressed in the CIDR notation
Returns:the next stage of the definition
/**
             * Specifies the destination address prefix to apply the route to.
             * @param cidr an address prefix expressed in the CIDR notation
             * @return the next stage of the definition
             */
            WithNextHopType<ParentT> withDestinationAddressPrefix(String cidr);
        }

        
The stage of a route definition allowing to specify the next hop type.

Type parameters:
/**
         * The stage of a route definition allowing to specify the next hop type.
         * @param <ParentT> the return type of {@link WithAttach#attach()}
         */
        interface WithNextHopType<ParentT> {
            
Specifies the next hop type.

 To use a virtual appliance, use withNextHopToVirtualAppliance(String) instead and specify its IP address. 
Params:
  • nextHopType – a hop type
Returns:the next stage of the definition
/**
             * Specifies the next hop type.
             * <p>
             * To use a virtual appliance, use {@link #withNextHopToVirtualAppliance(String)} instead and specify its IP address.
             * @param nextHopType a hop type
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withNextHop(RouteNextHopType nextHopType);

            
Specifies the IP address of the virtual appliance for the next hop to go to.

Params:
  • ipAddress – an IP address of an existing virtual appliance (virtual machine)
Returns:the next stage of the definition
/**
             * Specifies the IP address of the virtual appliance for the next hop to go to.
             * @param ipAddress an IP address of an existing virtual appliance (virtual machine)
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withNextHopToVirtualAppliance(String ipAddress);
        }
    }

    
The entirety of a route definition.

Type parameters:
/** The entirety of a route definition.
     * @param <ParentT> the return type of the final {@link DefinitionStages.WithAttach#attach()}
     */
    interface Definition<ParentT> extends
        DefinitionStages.Blank<ParentT>,
        DefinitionStages.WithAttach<ParentT>,
        DefinitionStages.WithNextHopType<ParentT>,
        DefinitionStages.WithDestinationAddressPrefix<ParentT> {
    }

    
Grouping of route update stages.

/**
     * Grouping of route update stages.
     */
    interface UpdateStages {
        
The stage of a route update allowing to modify the destination address prefix.

/**
         * The stage of a route update allowing to modify the destination address prefix.
         */
        interface WithDestinationAddressPrefix {
            
Specifies the destination address prefix to apply the route to.

Params:
  • cidr – an address prefix expressed in the CIDR notation
Returns:the next stage of the update
/**
             * Specifies the destination address prefix to apply the route to.
             * @param cidr an address prefix expressed in the CIDR notation
             * @return the next stage of the update
             */
            Update withDestinationAddressPrefix(String cidr);
        }

        
The stage of a route update allowing to specify the next hop type.

/**
         * The stage of a route update allowing to specify the next hop type.
         */
        interface WithNextHopType {
            
Specifies the next hop type.

 To use a virtual appliance, use withNextHopToVirtualAppliance(String) instead and specify its IP address. 
Params:
  • nextHopType – a hop type
Returns:the next stage of the update
/**
             * Specifies the next hop type.
             * <p>
             * To use a virtual appliance, use {@link #withNextHopToVirtualAppliance(String)} instead and specify its IP address.
             * @param nextHopType a hop type
             * @return the next stage of the update
             */
            Update withNextHop(RouteNextHopType nextHopType);

            
Specifies the IP address of the virtual appliance for the next hop to go to.

Params:
  • ipAddress – an IP address of an existing virtual appliance (virtual machine)
Returns:the next stage of the update
/**
             * Specifies the IP address of the virtual appliance for the next hop to go to.
             * @param ipAddress an IP address of an existing virtual appliance (virtual machine)
             * @return the next stage of the update
             */
            Update withNextHopToVirtualAppliance(String ipAddress);
        }
    }

    
The entirety of a route update as part of a route table update.

/**
     * The entirety of a route update as part of a route table update.
     */
    interface Update extends
        Settable<RouteTable.Update>,
        UpdateStages.WithDestinationAddressPrefix,
        UpdateStages.WithNextHopType {
    }

    
Grouping of route definition stages applicable as part of a route table update.

/**
     * Grouping of route definition stages applicable as part of a route table update.
     */
    interface UpdateDefinitionStages {
        
The first stage of a route definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The first stage of a route definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithDestinationAddressPrefix<ParentT> {
        }

        
The final stage of a route definition.

 At this stage, any remaining optional settings can be specified, or the route definition can be attached to the parent route table definition using InUpdate.attach(). 
Type parameters:
/** The final stage of a route definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the route definition
         * can be attached to the parent route table definition using {@link WithAttach#attach()}.
         * @param <ParentT> the return type of {@link WithAttach#attach()}
         */
        interface WithAttach<ParentT> extends
            Attachable.InUpdate<ParentT> {
        }

        
The stage of a route definition allowing to specify the destination address prefix.

Type parameters:
/**
         * The stage of a route definition allowing to specify the destination address prefix.
         * @param <ParentT> the return type of {@link WithAttach#attach()}
         */
        interface WithDestinationAddressPrefix<ParentT> {
            
Specifies the destination address prefix to apply the route to.

Params:
  • cidr – an address prefix expressed in the CIDR notation
Returns:the next stage of the definition
/**
             * Specifies the destination address prefix to apply the route to.
             * @param cidr an address prefix expressed in the CIDR notation
             * @return the next stage of the definition
             */
            WithNextHopType<ParentT> withDestinationAddressPrefix(String cidr);
        }

        
The stage of a route definition allowing to specify the next hop type.

Type parameters:
/**
         * The stage of a route definition allowing to specify the next hop type.
         * @param <ParentT> the return type of {@link WithAttach#attach()}
         */
        interface WithNextHopType<ParentT> {
            
Specifies the next hop type.

 To use a virtual appliance, use withNextHopToVirtualAppliance(String) instead and specify its IP address. 
Params:
  • nextHopType – a hop type
Returns:the next stage of the definition
/**
             * Specifies the next hop type.
             * <p>
             * To use a virtual appliance, use {@link #withNextHopToVirtualAppliance(String)} instead and specify its IP address.
             * @param nextHopType a hop type
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withNextHop(RouteNextHopType nextHopType);

            
Specifies the IP address of the virtual appliance for the next hop to go to.

Params:
  • ipAddress – an IP address of an existing virtual appliance (virtual machine)
Returns:the next stage of the definition
/**
             * Specifies the IP address of the virtual appliance for the next hop to go to.
             * @param ipAddress an IP address of an existing virtual appliance (virtual machine)
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withNextHopToVirtualAppliance(String ipAddress);
        }
    }

    
The entirety of a route definition as part of a route table update.

Type parameters:
/** The entirety of a route definition as part of a route table update.
     * @param <ParentT> the return type of the final {@link UpdateDefinitionStages.WithAttach#attach()}
     */
    interface UpdateDefinition<ParentT> extends
       UpdateDefinitionStages.Blank<ParentT>,
       UpdateDefinitionStages.WithAttach<ParentT>,
       UpdateDefinitionStages.WithNextHopType<ParentT>,
       UpdateDefinitionStages.WithDestinationAddressPrefix<ParentT> {
    }
}