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

package com.azure.resourcemanager.timeseriesinsights.models;

import com.azure.core.management.Region;
import com.azure.core.util.Context;
import com.azure.resourcemanager.timeseriesinsights.fluent.models.ReferenceDataSetResourceInner;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;

/** An immutable client-side representation of ReferenceDataSetResource. */
public interface ReferenceDataSetResource {
    /**
     * 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 provisioningState property: Provisioning state of the resource.
     *
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the creationTime property: The time the resource was created.
     *
     * @return the creationTime value.
     */
    OffsetDateTime creationTime();

    /**
     * Gets the keyProperties property: The list of key properties for the reference data set.
     *
     * @return the keyProperties value.
     */
    List<ReferenceDataSetKeyProperty> keyProperties();

    /**
     * Gets the dataStringComparisonBehavior property: The reference data set key comparison behavior can be set using
     * this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed
     * while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set,
     * case insensitive comparison will be used.
     *
     * @return the dataStringComparisonBehavior value.
     */
    DataStringComparisonBehavior dataStringComparisonBehavior();

    /**
     * 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.timeseriesinsights.fluent.models.ReferenceDataSetResourceInner object.
     *
     * @return the inner object.
     */
    ReferenceDataSetResourceInner innerModel();

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

            /**
             * Specifies the region for the resource.
             *
             * @param location The location of the resource.
             * @return the next definition stage.
             */
            WithParentResource withRegion(String location);
        }
        /** The stage of the ReferenceDataSetResource definition allowing to specify parent resource. */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, environmentName.
             *
             * @param resourceGroupName Name of an Azure Resource group.
             * @param environmentName The name of the Time Series Insights environment associated with the specified
             *     resource group.
             * @return the next definition stage.
             */
            WithKeyProperties withExistingEnvironment(String resourceGroupName, String environmentName);
        }
        /** The stage of the ReferenceDataSetResource definition allowing to specify keyProperties. */
        interface WithKeyProperties {
            /**
             * Specifies the keyProperties property: The list of key properties for the reference data set..
             *
             * @param keyProperties The list of key properties for the reference data set.
             * @return the next definition stage.
             */
            WithCreate withKeyProperties(List<ReferenceDataSetKeyProperty> keyProperties);
        }
        /**
         * The stage of the ReferenceDataSetResource 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.WithDataStringComparisonBehavior {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            ReferenceDataSetResource create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            ReferenceDataSetResource create(Context context);
        }
        /** The stage of the ReferenceDataSetResource definition allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Key-value pairs of additional properties for the resource..
             *
             * @param tags Key-value pairs of additional properties for the resource.
             * @return the next definition stage.
             */
            WithCreate withTags(Map<String, String> tags);
        }
        /** The stage of the ReferenceDataSetResource definition allowing to specify dataStringComparisonBehavior. */
        interface WithDataStringComparisonBehavior {
            /**
             * Specifies the dataStringComparisonBehavior property: The reference data set key comparison behavior can
             * be set using this property. By default, the value is 'Ordinal' - which means case sensitive key
             * comparison will be performed while joining reference data with events or while adding new reference data.
             * When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used..
             *
             * @param dataStringComparisonBehavior The reference data set key comparison behavior can be set using this
             *     property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be
             *     performed while joining reference data with events or while adding new reference data. When
             *     'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
             * @return the next definition stage.
             */
            WithCreate withDataStringComparisonBehavior(DataStringComparisonBehavior dataStringComparisonBehavior);
        }
    }
    /**
     * Begins update for the ReferenceDataSetResource resource.
     *
     * @return the stage of resource update.
     */
    ReferenceDataSetResource.Update update();

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

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        ReferenceDataSetResource apply(Context context);
    }
    /** The ReferenceDataSetResource update stages. */
    interface UpdateStages {
        /** The stage of the ReferenceDataSetResource update allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Key-value pairs of additional properties for the reference data set..
             *
             * @param tags Key-value pairs of additional properties for the reference data set.
             * @return the next definition stage.
             */
            Update withTags(Map<String, String> tags);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    ReferenceDataSetResource refresh();

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