// 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.util.Context;
import com.azure.resourcemanager.security.fluent.models.SecurityAssessmentMetadataProperties;
import com.azure.resourcemanager.security.fluent.models.SecurityAssessmentResponseInner;
import java.util.Map;

/** An immutable client-side representation of SecurityAssessmentResponse. */
public interface SecurityAssessmentResponse {
    /**
     * 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 status property: The result of the assessment.
     *
     * @return the status value.
     */
    AssessmentStatusResponse status();

    /**
     * Gets the resourceDetails property: Details of the resource that was assessed.
     *
     * @return the resourceDetails value.
     */
    ResourceDetails resourceDetails();

    /**
     * Gets the displayName property: User friendly display name of the assessment.
     *
     * @return the displayName value.
     */
    String displayName();

    /**
     * Gets the additionalData property: Additional data regarding the assessment.
     *
     * @return the additionalData value.
     */
    Map<String, String> additionalData();

    /**
     * Gets the links property: Links relevant to the assessment.
     *
     * @return the links value.
     */
    AssessmentLinks links();

    /**
     * Gets the metadata property: Describes properties of an assessment metadata.
     *
     * @return the metadata value.
     */
    SecurityAssessmentMetadataProperties metadata();

    /**
     * Gets the partnersData property: Data regarding 3rd party partner integration.
     *
     * @return the partnersData value.
     */
    SecurityAssessmentPartnerData partnersData();

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

    /** The entirety of the SecurityAssessmentResponse definition. */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithScope, DefinitionStages.WithCreate {
    }
    /** The SecurityAssessmentResponse definition stages. */
    interface DefinitionStages {
        /** The first stage of the SecurityAssessmentResponse definition. */
        interface Blank extends WithScope {
        }
        /** The stage of the SecurityAssessmentResponse definition allowing to specify parent resource. */
        interface WithScope {
            /**
             * Specifies resourceId.
             *
             * @param resourceId The identifier of the resource.
             * @return the next definition stage.
             */
            WithCreate withExistingResourceId(String resourceId);
        }
        /**
         * The stage of the SecurityAssessmentResponse 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.WithStatus,
                DefinitionStages.WithResourceDetails,
                DefinitionStages.WithAdditionalData,
                DefinitionStages.WithMetadata,
                DefinitionStages.WithPartnersData {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            SecurityAssessmentResponse create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            SecurityAssessmentResponse create(Context context);
        }
        /** The stage of the SecurityAssessmentResponse definition allowing to specify status. */
        interface WithStatus {
            /**
             * Specifies the status property: The result of the assessment.
             *
             * @param status The result of the assessment.
             * @return the next definition stage.
             */
            WithCreate withStatus(AssessmentStatus status);
        }
        /** The stage of the SecurityAssessmentResponse definition allowing to specify resourceDetails. */
        interface WithResourceDetails {
            /**
             * Specifies the resourceDetails property: Details of the resource that was assessed.
             *
             * @param resourceDetails Details of the resource that was assessed.
             * @return the next definition stage.
             */
            WithCreate withResourceDetails(ResourceDetails resourceDetails);
        }
        /** The stage of the SecurityAssessmentResponse definition allowing to specify additionalData. */
        interface WithAdditionalData {
            /**
             * Specifies the additionalData property: Additional data regarding the assessment.
             *
             * @param additionalData Additional data regarding the assessment.
             * @return the next definition stage.
             */
            WithCreate withAdditionalData(Map<String, String> additionalData);
        }
        /** The stage of the SecurityAssessmentResponse definition allowing to specify metadata. */
        interface WithMetadata {
            /**
             * Specifies the metadata property: Describes properties of an assessment metadata..
             *
             * @param metadata Describes properties of an assessment metadata.
             * @return the next definition stage.
             */
            WithCreate withMetadata(SecurityAssessmentMetadataProperties metadata);
        }
        /** The stage of the SecurityAssessmentResponse definition allowing to specify partnersData. */
        interface WithPartnersData {
            /**
             * Specifies the partnersData property: Data regarding 3rd party partner integration.
             *
             * @param partnersData Data regarding 3rd party partner integration.
             * @return the next definition stage.
             */
            WithCreate withPartnersData(SecurityAssessmentPartnerData partnersData);
        }
    }
    /**
     * Begins update for the SecurityAssessmentResponse resource.
     *
     * @return the stage of resource update.
     */
    SecurityAssessmentResponse.Update update();

    /** The template for SecurityAssessmentResponse update. */
    interface Update
        extends UpdateStages.WithStatus,
            UpdateStages.WithResourceDetails,
            UpdateStages.WithAdditionalData,
            UpdateStages.WithMetadata,
            UpdateStages.WithPartnersData {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        SecurityAssessmentResponse apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        SecurityAssessmentResponse apply(Context context);
    }
    /** The SecurityAssessmentResponse update stages. */
    interface UpdateStages {
        /** The stage of the SecurityAssessmentResponse update allowing to specify status. */
        interface WithStatus {
            /**
             * Specifies the status property: The result of the assessment.
             *
             * @param status The result of the assessment.
             * @return the next definition stage.
             */
            Update withStatus(AssessmentStatus status);
        }
        /** The stage of the SecurityAssessmentResponse update allowing to specify resourceDetails. */
        interface WithResourceDetails {
            /**
             * Specifies the resourceDetails property: Details of the resource that was assessed.
             *
             * @param resourceDetails Details of the resource that was assessed.
             * @return the next definition stage.
             */
            Update withResourceDetails(ResourceDetails resourceDetails);
        }
        /** The stage of the SecurityAssessmentResponse update allowing to specify additionalData. */
        interface WithAdditionalData {
            /**
             * Specifies the additionalData property: Additional data regarding the assessment.
             *
             * @param additionalData Additional data regarding the assessment.
             * @return the next definition stage.
             */
            Update withAdditionalData(Map<String, String> additionalData);
        }
        /** The stage of the SecurityAssessmentResponse update allowing to specify metadata. */
        interface WithMetadata {
            /**
             * Specifies the metadata property: Describes properties of an assessment metadata..
             *
             * @param metadata Describes properties of an assessment metadata.
             * @return the next definition stage.
             */
            Update withMetadata(SecurityAssessmentMetadataProperties metadata);
        }
        /** The stage of the SecurityAssessmentResponse update allowing to specify partnersData. */
        interface WithPartnersData {
            /**
             * Specifies the partnersData property: Data regarding 3rd party partner integration.
             *
             * @param partnersData Data regarding 3rd party partner integration.
             * @return the next definition stage.
             */
            Update withPartnersData(SecurityAssessmentPartnerData partnersData);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    SecurityAssessmentResponse refresh();

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