com.azure.resourcemanager.hybridcompute.models.Gateway Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-hybridcompute Show documentation
This package contains Microsoft Azure SDK for HybridCompute Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. The Hybrid Compute Management Client. Package tag package-preview-2024-07.
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.hybridcompute.models;

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

/**
 * An immutable client-side representation of Gateway.
 */
public interface Gateway {
    /**
     * 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: The provisioning state, which only appears in the response.
     * 
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the gatewayId property: A unique, immutable, identifier for the Gateway.
     * 
     * @return the gatewayId value.
     */
    String gatewayId();

    /**
     * Gets the gatewayType property: The type of the Gateway resource.
     * 
     * @return the gatewayType value.
     */
    GatewayType gatewayType();

    /**
     * Gets the gatewayEndpoint property: The endpoint fqdn for the Gateway.
     * 
     * @return the gatewayEndpoint value.
     */
    String gatewayEndpoint();

    /**
     * Gets the allowedFeatures property: Specifies the list of features that are enabled for this Gateway.
     * 
     * @return the allowedFeatures value.
     */
    List allowedFeatures();

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

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

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

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

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

        /**
         * The stage of the Gateway 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 Gateway definition allowing to specify gatewayType.
         */
        interface WithGatewayType {
            /**
             * Specifies the gatewayType property: The type of the Gateway resource..
             * 
             * @param gatewayType The type of the Gateway resource.
             * @return the next definition stage.
             */
            WithCreate withGatewayType(GatewayType gatewayType);
        }

        /**
         * The stage of the Gateway definition allowing to specify allowedFeatures.
         */
        interface WithAllowedFeatures {
            /**
             * Specifies the allowedFeatures property: Specifies the list of features that are enabled for this
             * Gateway..
             * 
             * @param allowedFeatures Specifies the list of features that are enabled for this Gateway.
             * @return the next definition stage.
             */
            WithCreate withAllowedFeatures(List allowedFeatures);
        }
    }

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

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

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

    /**
     * The Gateway update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the Gateway 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 tags);
        }

        /**
         * The stage of the Gateway update allowing to specify allowedFeatures.
         */
        interface WithAllowedFeatures {
            /**
             * Specifies the allowedFeatures property: Specifies the list of features that are enabled for this
             * Gateway..
             * 
             * @param allowedFeatures Specifies the list of features that are enabled for this Gateway.
             * @return the next definition stage.
             */
            Update withAllowedFeatures(List allowedFeatures);
        }
    }

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

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