com.azure.resourcemanager.network.models.Topology 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.TopologyInner;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent;
import com.azure.resourcemanager.resources.fluentcore.model.Executable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import java.time.OffsetDateTime;
import java.util.Map;

/** An immutable client-side representation of an Azure Topology info object, associated with network watcher. */
@Fluent
public interface Topology extends Executable, HasInnerModel, HasParent {
    /** @return GUID representing the id */
    String id();

    /** @return parameters used to query this topology */
    TopologyParameters topologyParameters();

    /** @return the datetime when the topology was initially created for the resource group. */
    OffsetDateTime createdTime();

    /** @return the datetime when the topology was last modified */
    OffsetDateTime lastModifiedTime();

    /** @return The resources in this topology */
    Map resources();

    /** The entirety of topology parameters definition. */
    interface Definition
        extends DefinitionStages.WithTargetResourceGroup,
            DefinitionStages.WithExecute,
            DefinitionStages.WithExecuteAndSubnet {
    }

    /** Grouping of topology definition stages. */
    interface DefinitionStages {
        /** The first stage of topology parameters definition. */
        interface WithTargetResourceGroup {
            /**
             * Set the targetResourceId value.
             *
             * @param resourceGroupName the name of the target resource group to perform getTopology on
             * @return the Topology object itself.
             */
            DefinitionStages.WithExecute withTargetResourceGroup(String resourceGroupName);
        }

        /** Sets the target virtual network. */
        interface WithTargetNetwork {
            /**
             * Set the target virtual network.
             *
             * @param networkId the target network id value to set
             * @return the Topology object itself.
             */
            DefinitionStages.WithExecuteAndSubnet withTargetNetwork(String networkId);
        }

        /** Sets the target subnet. */
        interface WithTargetSubnet {
            /**
             * Set the subnetName value.
             *
             * @param subnetName the destinationIPAddress value to set
             * @return the Topology object itself.
             */
            DefinitionStages.WithExecute withTargetSubnet(String subnetName);
        }

        /**
         * 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.WithTargetNetwork {
        }

        /**
         * 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 WithExecuteAndSubnet extends Executable, DefinitionStages.WithTargetSubnet {
        }
    }
}