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

package com.azure.resourcemanager.security.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.security.fluent.models.SecurityConnectorInner;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;

/** An immutable client-side representation of SecurityConnector. */
public interface SecurityConnector {
    /**
     * 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 systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the hierarchyIdentifier property: The multi cloud resource identifier (account id in case of AWS connector,
     * project number in case of GCP connector).
     *
     * @return the hierarchyIdentifier value.
     */
    String hierarchyIdentifier();

    /**
     * Gets the hierarchyIdentifierTrialEndDate property: The date on which the trial period will end, if applicable.
     * Trial period exists for 30 days after upgrading to payed offerings.
     *
     * @return the hierarchyIdentifierTrialEndDate value.
     */
    OffsetDateTime hierarchyIdentifierTrialEndDate();

    /**
     * Gets the environmentName property: The multi cloud resource's cloud name.
     *
     * @return the environmentName value.
     */
    CloudName environmentName();

    /**
     * Gets the offerings property: A collection of offerings for the security connector.
     *
     * @return the offerings value.
     */
    List<CloudOffering> offerings();

    /**
     * Gets the environmentData property: The security connector environment data.
     *
     * @return the environmentData value.
     */
    EnvironmentData environmentData();

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

    /** The entirety of the SecurityConnector definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithCreate {
    }
    /** The SecurityConnector definition stages. */
    interface DefinitionStages {
        /** The first stage of the SecurityConnector definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the SecurityConnector 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 SecurityConnector definition allowing to specify parent resource. */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             *
             * @param resourceGroupName The name of the resource group within the user's subscription. The name is case
             *     insensitive.
             * @return the next definition stage.
             */
            WithCreate withExistingResourceGroup(String resourceGroupName);
        }
        /**
         * The stage of the SecurityConnector 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.WithHierarchyIdentifier,
                DefinitionStages.WithEnvironmentName,
                DefinitionStages.WithOfferings,
                DefinitionStages.WithEnvironmentData {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            SecurityConnector create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            SecurityConnector create(Context context);
        }
        /** The stage of the SecurityConnector 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 SecurityConnector definition allowing to specify hierarchyIdentifier. */
        interface WithHierarchyIdentifier {
            /**
             * Specifies the hierarchyIdentifier property: The multi cloud resource identifier (account id in case of
             * AWS connector, project number in case of GCP connector)..
             *
             * @param hierarchyIdentifier The multi cloud resource identifier (account id in case of AWS connector,
             *     project number in case of GCP connector).
             * @return the next definition stage.
             */
            WithCreate withHierarchyIdentifier(String hierarchyIdentifier);
        }
        /** The stage of the SecurityConnector definition allowing to specify environmentName. */
        interface WithEnvironmentName {
            /**
             * Specifies the environmentName property: The multi cloud resource's cloud name..
             *
             * @param environmentName The multi cloud resource's cloud name.
             * @return the next definition stage.
             */
            WithCreate withEnvironmentName(CloudName environmentName);
        }
        /** The stage of the SecurityConnector definition allowing to specify offerings. */
        interface WithOfferings {
            /**
             * Specifies the offerings property: A collection of offerings for the security connector..
             *
             * @param offerings A collection of offerings for the security connector.
             * @return the next definition stage.
             */
            WithCreate withOfferings(List<CloudOffering> offerings);
        }
        /** The stage of the SecurityConnector definition allowing to specify environmentData. */
        interface WithEnvironmentData {
            /**
             * Specifies the environmentData property: The security connector environment data..
             *
             * @param environmentData The security connector environment data.
             * @return the next definition stage.
             */
            WithCreate withEnvironmentData(EnvironmentData environmentData);
        }
    }
    /**
     * Begins update for the SecurityConnector resource.
     *
     * @return the stage of resource update.
     */
    SecurityConnector.Update update();

    /** The template for SecurityConnector update. */
    interface Update
        extends UpdateStages.WithTags,
            UpdateStages.WithHierarchyIdentifier,
            UpdateStages.WithEnvironmentName,
            UpdateStages.WithOfferings,
            UpdateStages.WithEnvironmentData {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        SecurityConnector apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        SecurityConnector apply(Context context);
    }
    /** The SecurityConnector update stages. */
    interface UpdateStages {
        /** The stage of the SecurityConnector update allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Resource tags..
             *
             * @param tags Resource tags.
             * @return the next definition stage.
             */
            Update withTags(Map<String, String> tags);
        }
        /** The stage of the SecurityConnector update allowing to specify hierarchyIdentifier. */
        interface WithHierarchyIdentifier {
            /**
             * Specifies the hierarchyIdentifier property: The multi cloud resource identifier (account id in case of
             * AWS connector, project number in case of GCP connector)..
             *
             * @param hierarchyIdentifier The multi cloud resource identifier (account id in case of AWS connector,
             *     project number in case of GCP connector).
             * @return the next definition stage.
             */
            Update withHierarchyIdentifier(String hierarchyIdentifier);
        }
        /** The stage of the SecurityConnector update allowing to specify environmentName. */
        interface WithEnvironmentName {
            /**
             * Specifies the environmentName property: The multi cloud resource's cloud name..
             *
             * @param environmentName The multi cloud resource's cloud name.
             * @return the next definition stage.
             */
            Update withEnvironmentName(CloudName environmentName);
        }
        /** The stage of the SecurityConnector update allowing to specify offerings. */
        interface WithOfferings {
            /**
             * Specifies the offerings property: A collection of offerings for the security connector..
             *
             * @param offerings A collection of offerings for the security connector.
             * @return the next definition stage.
             */
            Update withOfferings(List<CloudOffering> offerings);
        }
        /** The stage of the SecurityConnector update allowing to specify environmentData. */
        interface WithEnvironmentData {
            /**
             * Specifies the environmentData property: The security connector environment data..
             *
             * @param environmentData The security connector environment data.
             * @return the next definition stage.
             */
            Update withEnvironmentData(EnvironmentData environmentData);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    SecurityConnector refresh();

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