// 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.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.security.fluent.models.CustomAssessmentAutomationInner;

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

    /**
     * Gets the compressedQuery property: GZip encoded KQL query representing the assessment automation results
     * required.
     *
     * @return the compressedQuery value.
     */
    String compressedQuery();

    /**
     * Gets the supportedCloud property: Relevant cloud for the custom assessment automation.
     *
     * @return the supportedCloud value.
     */
    SupportedCloudEnum supportedCloud();

    /**
     * Gets the severity property: The severity to relate to the assessments generated by this assessment automation.
     *
     * @return the severity value.
     */
    SeverityEnum severity();

    /**
     * Gets the displayName property: The display name of the assessments generated by this assessment automation.
     *
     * @return the displayName value.
     */
    String displayName();

    /**
     * Gets the description property: The description to relate to the assessments generated by this assessment
     * automation.
     *
     * @return the description value.
     */
    String description();

    /**
     * Gets the remediationDescription property: The remediation description to relate to the assessments generated by
     * this assessment automation.
     *
     * @return the remediationDescription value.
     */
    String remediationDescription();

    /**
     * Gets the assessmentKey property: The assessment metadata key used when an assessment is generated for this
     * assessment automation.
     *
     * @return the assessmentKey value.
     */
    String assessmentKey();

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

    /** The entirety of the CustomAssessmentAutomation definition. */
    interface Definition
        extends DefinitionStages.Blank, DefinitionStages.WithResourceGroup, DefinitionStages.WithCreate {
    }
    /** The CustomAssessmentAutomation definition stages. */
    interface DefinitionStages {
        /** The first stage of the CustomAssessmentAutomation definition. */
        interface Blank extends WithResourceGroup {
        }
        /** The stage of the CustomAssessmentAutomation 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 CustomAssessmentAutomation 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.WithCompressedQuery,
                DefinitionStages.WithSupportedCloud,
                DefinitionStages.WithSeverity,
                DefinitionStages.WithDisplayName,
                DefinitionStages.WithDescription,
                DefinitionStages.WithRemediationDescription {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            CustomAssessmentAutomation create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            CustomAssessmentAutomation create(Context context);
        }
        /** The stage of the CustomAssessmentAutomation definition allowing to specify compressedQuery. */
        interface WithCompressedQuery {
            /**
             * Specifies the compressedQuery property: Base 64 encoded KQL query representing the assessment automation
             * results required..
             *
             * @param compressedQuery Base 64 encoded KQL query representing the assessment automation results required.
             * @return the next definition stage.
             */
            WithCreate withCompressedQuery(String compressedQuery);
        }
        /** The stage of the CustomAssessmentAutomation definition allowing to specify supportedCloud. */
        interface WithSupportedCloud {
            /**
             * Specifies the supportedCloud property: Relevant cloud for the custom assessment automation..
             *
             * @param supportedCloud Relevant cloud for the custom assessment automation.
             * @return the next definition stage.
             */
            WithCreate withSupportedCloud(SupportedCloudEnum supportedCloud);
        }
        /** The stage of the CustomAssessmentAutomation definition allowing to specify severity. */
        interface WithSeverity {
            /**
             * Specifies the severity property: The severity to relate to the assessments generated by this assessment
             * automation..
             *
             * @param severity The severity to relate to the assessments generated by this assessment automation.
             * @return the next definition stage.
             */
            WithCreate withSeverity(SeverityEnum severity);
        }
        /** The stage of the CustomAssessmentAutomation definition allowing to specify displayName. */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: The display name of the assessments generated by this assessment
             * automation..
             *
             * @param displayName The display name of the assessments generated by this assessment automation.
             * @return the next definition stage.
             */
            WithCreate withDisplayName(String displayName);
        }
        /** The stage of the CustomAssessmentAutomation definition allowing to specify description. */
        interface WithDescription {
            /**
             * Specifies the description property: The description to relate to the assessments generated by this
             * assessment automation..
             *
             * @param description The description to relate to the assessments generated by this assessment automation.
             * @return the next definition stage.
             */
            WithCreate withDescription(String description);
        }
        /** The stage of the CustomAssessmentAutomation definition allowing to specify remediationDescription. */
        interface WithRemediationDescription {
            /**
             * Specifies the remediationDescription property: The remediation description to relate to the assessments
             * generated by this assessment automation..
             *
             * @param remediationDescription The remediation description to relate to the assessments generated by this
             *     assessment automation.
             * @return the next definition stage.
             */
            WithCreate withRemediationDescription(String remediationDescription);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    CustomAssessmentAutomation refresh();

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