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

package com.azure.resourcemanager.hybridcontainerservice.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.hybridcontainerservice.fluent.models.ProvisionedClustersResponseInner;
import java.util.Map;

/** An immutable client-side representation of ProvisionedClustersResponse. */
public interface ProvisionedClustersResponse {
    /**
     * 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: Identity for the Provisioned cluster.
     *
     * @return the identity value.
     */
    ProvisionedClusterIdentity identity();

    /**
     * Gets the properties property: The properties property.
     *
     * @return the properties value.
     */
    ProvisionedClustersResponseProperties properties();

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

    /**
     * Gets the extendedLocation property: The extendedLocation property.
     *
     * @return the extendedLocation value.
     */
    ProvisionedClustersResponseExtendedLocation extendedLocation();

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

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

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            ProvisionedClustersResponse create(Context context);
        }
        /** The stage of the ProvisionedClustersResponse 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 ProvisionedClustersResponse definition allowing to specify identity. */
        interface WithIdentity {
            /**
             * Specifies the identity property: Identity for the Provisioned cluster..
             *
             * @param identity Identity for the Provisioned cluster.
             * @return the next definition stage.
             */
            WithCreate withIdentity(ProvisionedClusterIdentity identity);
        }
        /** The stage of the ProvisionedClustersResponse definition allowing to specify properties. */
        interface WithProperties {
            /**
             * Specifies the properties property: All properties of the provisioned cluster.
             *
             * @param properties All properties of the provisioned cluster.
             * @return the next definition stage.
             */
            WithCreate withProperties(ProvisionedClustersAllProperties properties);
        }
        /** The stage of the ProvisionedClustersResponse definition allowing to specify extendedLocation. */
        interface WithExtendedLocation {
            /**
             * Specifies the extendedLocation property: The extendedLocation property..
             *
             * @param extendedLocation The extendedLocation property.
             * @return the next definition stage.
             */
            WithCreate withExtendedLocation(ProvisionedClustersExtendedLocation extendedLocation);
        }
    }
    /**
     * Begins update for the ProvisionedClustersResponse resource.
     *
     * @return the stage of resource update.
     */
    ProvisionedClustersResponse.Update update();

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

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        ProvisionedClustersResponse apply(Context context);
    }
    /** The ProvisionedClustersResponse update stages. */
    interface UpdateStages {
        /** The stage of the ProvisionedClustersResponse 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);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    ProvisionedClustersResponse refresh();

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

    /**
     * Upgrades the node image version of the cluster control plane and all agent pools to the latest.
     *
     * <p>Upgrading the node image version of a cluster applies the newest OS and runtime updates to the nodes.
     *
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void upgradeNodeImageVersionForEntireCluster();

    /**
     * Upgrades the node image version of the cluster control plane and all agent pools to the latest.
     *
     * <p>Upgrading the node image version of a cluster applies the newest OS and runtime updates to the nodes.
     *
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void upgradeNodeImageVersionForEntireCluster(Context context);
}
