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

package com.azure.resourcemanager.webpubsub.models;

import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.webpubsub.fluent.models.WebPubSubHubInner;

/** An immutable client-side representation of WebPubSubHub. */
public interface WebPubSubHub {
    /**
     * 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 systemData property: Metadata pertaining to creation and last modification of the resource.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the properties property: Properties of a hub.
     *
     * @return the properties value.
     */
    WebPubSubHubProperties properties();

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

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

    /** The entirety of the WebPubSubHub definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithParentResource,
            DefinitionStages.WithProperties,
            DefinitionStages.WithCreate {
    }
    /** The WebPubSubHub definition stages. */
    interface DefinitionStages {
        /** The first stage of the WebPubSubHub definition. */
        interface Blank extends WithParentResource {
        }
        /** The stage of the WebPubSubHub definition allowing to specify parent resource. */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, resourceName.
             *
             * @param resourceGroupName The name of the resource group that contains the resource. You can obtain this
             *     value from the Azure Resource Manager API or the portal.
             * @param resourceName The name of the resource.
             * @return the next definition stage.
             */
            WithProperties withExistingWebPubSub(String resourceGroupName, String resourceName);
        }
        /** The stage of the WebPubSubHub definition allowing to specify properties. */
        interface WithProperties {
            /**
             * Specifies the properties property: Properties of a hub..
             *
             * @param properties Properties of a hub.
             * @return the next definition stage.
             */
            WithCreate withProperties(WebPubSubHubProperties properties);
        }
        /**
         * The stage of the WebPubSubHub 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 {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            WebPubSubHub create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            WebPubSubHub create(Context context);
        }
    }
    /**
     * Begins update for the WebPubSubHub resource.
     *
     * @return the stage of resource update.
     */
    WebPubSubHub.Update update();

    /** The template for WebPubSubHub update. */
    interface Update extends UpdateStages.WithProperties {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        WebPubSubHub apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        WebPubSubHub apply(Context context);
    }
    /** The WebPubSubHub update stages. */
    interface UpdateStages {
        /** The stage of the WebPubSubHub update allowing to specify properties. */
        interface WithProperties {
            /**
             * Specifies the properties property: Properties of a hub..
             *
             * @param properties Properties of a hub.
             * @return the next definition stage.
             */
            Update withProperties(WebPubSubHubProperties properties);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    WebPubSubHub refresh();

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