// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.avs.models;

import com.azure.core.util.Context;
import com.azure.resourcemanager.avs.fluent.models.WorkloadNetworkPortMirroringInner;

/** An immutable client-side representation of WorkloadNetworkPortMirroring. */
public interface WorkloadNetworkPortMirroring {
    /**
     * Gets the id property: Fully qualified resource Id for the resource.
     *
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: The name of the resource.
     *
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: The type of the resource.
     *
     * @return the type value.
     */
    String type();

    /**
     * Gets the displayName property: Display name of the port mirroring profile.
     *
     * @return the displayName value.
     */
    String displayName();

    /**
     * Gets the direction property: Direction of port mirroring profile.
     *
     * @return the direction value.
     */
    PortMirroringDirectionEnum direction();

    /**
     * Gets the source property: Source VM Group.
     *
     * @return the source value.
     */
    String source();

    /**
     * Gets the destination property: Destination VM Group.
     *
     * @return the destination value.
     */
    String destination();

    /**
     * Gets the status property: Port Mirroring Status.
     *
     * @return the status value.
     */
    PortMirroringStatusEnum status();

    /**
     * Gets the provisioningState property: The provisioning state.
     *
     * @return the provisioningState value.
     */
    WorkloadNetworkPortMirroringProvisioningState provisioningState();

    /**
     * Gets the revision property: NSX revision number.
     *
     * @return the revision value.
     */
    Long revision();

    /**
     * Gets the name of the resource group.
     *
     * @return the name of the resource group.
     */
    String resourceGroupName();

    /**
     * Gets the inner com.azure.resourcemanager.avs.fluent.models.WorkloadNetworkPortMirroringInner object.
     *
     * @return the inner object.
     */
    WorkloadNetworkPortMirroringInner innerModel();

    /** The entirety of the WorkloadNetworkPortMirroring definition. */
    interface Definition
        extends DefinitionStages.Blank, DefinitionStages.WithParentResource, DefinitionStages.WithCreate {
    }

    /** The WorkloadNetworkPortMirroring definition stages. */
    interface DefinitionStages {
        /** The first stage of the WorkloadNetworkPortMirroring definition. */
        interface Blank extends WithParentResource {
        }

        /** The stage of the WorkloadNetworkPortMirroring definition allowing to specify parent resource. */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, privateCloudName.
             *
             * @param resourceGroupName The name of the resource group. The name is case insensitive.
             * @param privateCloudName Name of the private cloud.
             * @return the next definition stage.
             */
            WithCreate withExistingPrivateCloud(String resourceGroupName, String privateCloudName);
        }

        /**
         * The stage of the WorkloadNetworkPortMirroring definition which contains all the minimum required properties
         * for the resource to be created, but also allows for any other optional properties to be specified.
         */
        interface WithCreate
            extends DefinitionStages.WithDisplayName,
                DefinitionStages.WithDirection,
                DefinitionStages.WithSource,
                DefinitionStages.WithDestination,
                DefinitionStages.WithRevision {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            WorkloadNetworkPortMirroring create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            WorkloadNetworkPortMirroring create(Context context);
        }

        /** The stage of the WorkloadNetworkPortMirroring definition allowing to specify displayName. */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: Display name of the port mirroring profile..
             *
             * @param displayName Display name of the port mirroring profile.
             * @return the next definition stage.
             */
            WithCreate withDisplayName(String displayName);
        }

        /** The stage of the WorkloadNetworkPortMirroring definition allowing to specify direction. */
        interface WithDirection {
            /**
             * Specifies the direction property: Direction of port mirroring profile..
             *
             * @param direction Direction of port mirroring profile.
             * @return the next definition stage.
             */
            WithCreate withDirection(PortMirroringDirectionEnum direction);
        }

        /** The stage of the WorkloadNetworkPortMirroring definition allowing to specify source. */
        interface WithSource {
            /**
             * Specifies the source property: Source VM Group..
             *
             * @param source Source VM Group.
             * @return the next definition stage.
             */
            WithCreate withSource(String source);
        }

        /** The stage of the WorkloadNetworkPortMirroring definition allowing to specify destination. */
        interface WithDestination {
            /**
             * Specifies the destination property: Destination VM Group..
             *
             * @param destination Destination VM Group.
             * @return the next definition stage.
             */
            WithCreate withDestination(String destination);
        }

        /** The stage of the WorkloadNetworkPortMirroring definition allowing to specify revision. */
        interface WithRevision {
            /**
             * Specifies the revision property: NSX revision number..
             *
             * @param revision NSX revision number.
             * @return the next definition stage.
             */
            WithCreate withRevision(Long revision);
        }
    }

    /**
     * Begins update for the WorkloadNetworkPortMirroring resource.
     *
     * @return the stage of resource update.
     */
    WorkloadNetworkPortMirroring.Update update();

    /** The template for WorkloadNetworkPortMirroring update. */
    interface Update
        extends UpdateStages.WithDisplayName,
            UpdateStages.WithDirection,
            UpdateStages.WithSource,
            UpdateStages.WithDestination,
            UpdateStages.WithRevision {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        WorkloadNetworkPortMirroring apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        WorkloadNetworkPortMirroring apply(Context context);
    }

    /** The WorkloadNetworkPortMirroring update stages. */
    interface UpdateStages {
        /** The stage of the WorkloadNetworkPortMirroring update allowing to specify displayName. */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: Display name of the port mirroring profile..
             *
             * @param displayName Display name of the port mirroring profile.
             * @return the next definition stage.
             */
            Update withDisplayName(String displayName);
        }

        /** The stage of the WorkloadNetworkPortMirroring update allowing to specify direction. */
        interface WithDirection {
            /**
             * Specifies the direction property: Direction of port mirroring profile..
             *
             * @param direction Direction of port mirroring profile.
             * @return the next definition stage.
             */
            Update withDirection(PortMirroringDirectionEnum direction);
        }

        /** The stage of the WorkloadNetworkPortMirroring update allowing to specify source. */
        interface WithSource {
            /**
             * Specifies the source property: Source VM Group..
             *
             * @param source Source VM Group.
             * @return the next definition stage.
             */
            Update withSource(String source);
        }

        /** The stage of the WorkloadNetworkPortMirroring update allowing to specify destination. */
        interface WithDestination {
            /**
             * Specifies the destination property: Destination VM Group..
             *
             * @param destination Destination VM Group.
             * @return the next definition stage.
             */
            Update withDestination(String destination);
        }

        /** The stage of the WorkloadNetworkPortMirroring update allowing to specify revision. */
        interface WithRevision {
            /**
             * Specifies the revision property: NSX revision number..
             *
             * @param revision NSX revision number.
             * @return the next definition stage.
             */
            Update withRevision(Long revision);
        }
    }

    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    WorkloadNetworkPortMirroring refresh();

    /**
     * Refreshes the resource to sync with Azure.
     *
     * @param context The context to associate with this operation.
     * @return the refreshed resource.
     */
    WorkloadNetworkPortMirroring refresh(Context context);
}
