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

package com.azure.resourcemanager.digitaltwins.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.digitaltwins.fluent.models.DigitalTwinsDescriptionInner;
import com.azure.resourcemanager.digitaltwins.fluent.models.PrivateEndpointConnectionInner;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;

/** An immutable client-side representation of DigitalTwinsDescription. */
public interface DigitalTwinsDescription {
    /**
     * 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 location property: The geo-location where the resource lives.
     *
     * @return the location value.
     */
    String location();

    /**
     * Gets the tags property: Resource tags.
     *
     * @return the tags value.
     */
    Map<String, String> tags();

    /**
     * Gets the identity property: The managed identity for the DigitalTwinsInstance.
     *
     * @return the identity value.
     */
    DigitalTwinsIdentity identity();

    /**
     * Gets the systemData property: Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the createdTime property: Time when DigitalTwinsInstance was created.
     *
     * @return the createdTime value.
     */
    OffsetDateTime createdTime();

    /**
     * Gets the lastUpdatedTime property: Time when DigitalTwinsInstance was updated.
     *
     * @return the lastUpdatedTime value.
     */
    OffsetDateTime lastUpdatedTime();

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

    /**
     * Gets the hostname property: Api endpoint to work with DigitalTwinsInstance.
     *
     * @return the hostname value.
     */
    String hostname();

    /**
     * Gets the privateEndpointConnections property: The private endpoint connections.
     *
     * @return the privateEndpointConnections value.
     */
    List<PrivateEndpointConnection> privateEndpointConnections();

    /**
     * Gets the publicNetworkAccess property: Public network access for the DigitalTwinsInstance.
     *
     * @return the publicNetworkAccess value.
     */
    PublicNetworkAccess publicNetworkAccess();

    /**
     * Gets the region of the resource.
     *
     * @return the region of the resource.
     */
    Region region();

    /**
     * Gets the name of the resource region.
     *
     * @return the name of the resource region.
     */
    String regionName();

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

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

    /** The entirety of the DigitalTwinsDescription definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithCreate {
    }
    /** The DigitalTwinsDescription definition stages. */
    interface DefinitionStages {
        /** The first stage of the DigitalTwinsDescription definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the DigitalTwinsDescription definition allowing to specify location. */
        interface WithLocation {
            /**
             * Specifies the region for the resource.
             *
             * @param location The geo-location where the resource lives.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(Region location);

            /**
             * Specifies the region for the resource.
             *
             * @param location The geo-location where the resource lives.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(String location);
        }
        /** The stage of the DigitalTwinsDescription definition allowing to specify parent resource. */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             *
             * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
             * @return the next definition stage.
             */
            WithCreate withExistingResourceGroup(String resourceGroupName);
        }
        /**
         * The stage of the DigitalTwinsDescription 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.WithTags,
                DefinitionStages.WithIdentity,
                DefinitionStages.WithPrivateEndpointConnections,
                DefinitionStages.WithPublicNetworkAccess {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            DigitalTwinsDescription create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            DigitalTwinsDescription create(Context context);
        }
        /** The stage of the DigitalTwinsDescription definition allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Resource tags..
             *
             * @param tags Resource tags.
             * @return the next definition stage.
             */
            WithCreate withTags(Map<String, String> tags);
        }
        /** The stage of the DigitalTwinsDescription definition allowing to specify identity. */
        interface WithIdentity {
            /**
             * Specifies the identity property: The managed identity for the DigitalTwinsInstance..
             *
             * @param identity The managed identity for the DigitalTwinsInstance.
             * @return the next definition stage.
             */
            WithCreate withIdentity(DigitalTwinsIdentity identity);
        }
        /** The stage of the DigitalTwinsDescription definition allowing to specify privateEndpointConnections. */
        interface WithPrivateEndpointConnections {
            /**
             * Specifies the privateEndpointConnections property: The private endpoint connections..
             *
             * @param privateEndpointConnections The private endpoint connections.
             * @return the next definition stage.
             */
            WithCreate withPrivateEndpointConnections(List<PrivateEndpointConnectionInner> privateEndpointConnections);
        }
        /** The stage of the DigitalTwinsDescription definition allowing to specify publicNetworkAccess. */
        interface WithPublicNetworkAccess {
            /**
             * Specifies the publicNetworkAccess property: Public network access for the DigitalTwinsInstance..
             *
             * @param publicNetworkAccess Public network access for the DigitalTwinsInstance.
             * @return the next definition stage.
             */
            WithCreate withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess);
        }
    }
    /**
     * Begins update for the DigitalTwinsDescription resource.
     *
     * @return the stage of resource update.
     */
    DigitalTwinsDescription.Update update();

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

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        DigitalTwinsDescription apply(Context context);
    }
    /** The DigitalTwinsDescription update stages. */
    interface UpdateStages {
        /** The stage of the DigitalTwinsDescription update allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Instance patch properties.
             *
             * @param tags Instance patch properties.
             * @return the next definition stage.
             */
            Update withTags(Map<String, String> tags);
        }
        /** The stage of the DigitalTwinsDescription update allowing to specify identity. */
        interface WithIdentity {
            /**
             * Specifies the identity property: The managed identity for the DigitalTwinsInstance..
             *
             * @param identity The managed identity for the DigitalTwinsInstance.
             * @return the next definition stage.
             */
            Update withIdentity(DigitalTwinsIdentity identity);
        }
        /** The stage of the DigitalTwinsDescription update allowing to specify properties. */
        interface WithProperties {
            /**
             * Specifies the properties property: Properties for the DigitalTwinsInstance..
             *
             * @param properties Properties for the DigitalTwinsInstance.
             * @return the next definition stage.
             */
            Update withProperties(DigitalTwinsPatchProperties properties);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    DigitalTwinsDescription refresh();

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