com.azure.resourcemanager.deviceupdate.models.Instance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-deviceupdate Show documentation
This package contains Microsoft Azure SDK for DeviceUpdate Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Microsoft Device Update resource provider. Package tag package-2023-07-01.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.deviceupdate.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.deviceupdate.fluent.models.InstanceInner;
import java.util.List;
import java.util.Map;

/**
 * An immutable client-side representation of Instance.
 */
public interface Instance {
    /**
     * 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 tags();

    /**
     * Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     * 
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the provisioningState property: Provisioning state.
     * 
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the accountName property: Parent Device Update Account name which Instance belongs to.
     * 
     * @return the accountName value.
     */
    String accountName();

    /**
     * Gets the iotHubs property: List of IoT Hubs associated with the account.
     * 
     * @return the iotHubs value.
     */
    List iotHubs();

    /**
     * Gets the enableDiagnostics property: Enables or Disables the diagnostic logs collection.
     * 
     * @return the enableDiagnostics value.
     */
    Boolean enableDiagnostics();

    /**
     * Gets the diagnosticStorageProperties property: Customer-initiated diagnostic log collection storage properties.
     * 
     * @return the diagnosticStorageProperties value.
     */
    DiagnosticStorageProperties diagnosticStorageProperties();

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

    /**
     * The entirety of the Instance definition.
     */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithLocation,
        DefinitionStages.WithParentResource, DefinitionStages.WithCreate {
    }

    /**
     * The Instance definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of the Instance definition.
         */
        interface Blank extends WithLocation {
        }

        /**
         * The stage of the Instance 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.
             */
            WithParentResource withRegion(Region location);

            /**
             * Specifies the region for the resource.
             * 
             * @param location The geo-location where the resource lives.
             * @return the next definition stage.
             */
            WithParentResource withRegion(String location);
        }

        /**
         * The stage of the Instance definition allowing to specify parent resource.
         */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, accountName.
             * 
             * @param resourceGroupName The resource group name.
             * @param accountName Account name.
             * @return the next definition stage.
             */
            WithCreate withExistingAccount(String resourceGroupName, String accountName);
        }

        /**
         * The stage of the Instance 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.WithIotHubs,
            DefinitionStages.WithEnableDiagnostics, DefinitionStages.WithDiagnosticStorageProperties {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            Instance create();

            /**
             * Executes the create request.
             * 
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            Instance create(Context context);
        }

        /**
         * The stage of the Instance 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 tags);
        }

        /**
         * The stage of the Instance definition allowing to specify iotHubs.
         */
        interface WithIotHubs {
            /**
             * Specifies the iotHubs property: List of IoT Hubs associated with the account..
             * 
             * @param iotHubs List of IoT Hubs associated with the account.
             * @return the next definition stage.
             */
            WithCreate withIotHubs(List iotHubs);
        }

        /**
         * The stage of the Instance definition allowing to specify enableDiagnostics.
         */
        interface WithEnableDiagnostics {
            /**
             * Specifies the enableDiagnostics property: Enables or Disables the diagnostic logs collection.
             * 
             * @param enableDiagnostics Enables or Disables the diagnostic logs collection.
             * @return the next definition stage.
             */
            WithCreate withEnableDiagnostics(Boolean enableDiagnostics);
        }

        /**
         * The stage of the Instance definition allowing to specify diagnosticStorageProperties.
         */
        interface WithDiagnosticStorageProperties {
            /**
             * Specifies the diagnosticStorageProperties property: Customer-initiated diagnostic log collection storage
             * properties.
             * 
             * @param diagnosticStorageProperties Customer-initiated diagnostic log collection storage properties.
             * @return the next definition stage.
             */
            WithCreate withDiagnosticStorageProperties(DiagnosticStorageProperties diagnosticStorageProperties);
        }
    }

    /**
     * Begins update for the Instance resource.
     * 
     * @return the stage of resource update.
     */
    Instance.Update update();

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

        /**
         * Executes the update request.
         * 
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        Instance apply(Context context);
    }

    /**
     * The Instance update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the Instance update allowing to specify tags.
         */
        interface WithTags {
            /**
             * Specifies the tags property: List of key value pairs that describe the resource. This will overwrite the
             * existing tags..
             * 
             * @param tags List of key value pairs that describe the resource. This will overwrite the existing tags.
             * @return the next definition stage.
             */
            Update withTags(Map tags);
        }
    }

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @return the refreshed resource.
     */
    Instance refresh();

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