com.azure.resourcemanager.mongocluster.models.FirewallRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-mongocluster Show documentation
This package contains Microsoft Azure SDK for Mongo Cluster Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. The Microsoft Azure management API provides create, read, update, and delete functionality for Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) TypeSpec Code Generator.

package com.azure.resourcemanager.mongocluster.models;

import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.mongocluster.fluent.models.FirewallRuleInner;

/**
 * An immutable client-side representation of FirewallRule.
 */
public interface FirewallRule {
    /**
     * 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 properties property: The resource-specific properties for this resource.
     * 
     * @return the properties value.
     */
    FirewallRuleProperties properties();

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

    /**
     * Gets the name of the resource group.
     * 
     * @return the name of the resource group.
     */
    String resourceGroupName();

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

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

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

        /**
         * The stage of the FirewallRule definition allowing to specify parent resource.
         */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, mongoClusterName.
             * 
             * @param resourceGroupName The name of the resource group. The name is case insensitive.
             * @param mongoClusterName The name of the mongo cluster.
             * @return the next definition stage.
             */
            WithCreate withExistingMongoCluster(String resourceGroupName, String mongoClusterName);
        }

        /**
         * The stage of the FirewallRule 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.WithProperties {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            FirewallRule create();

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

        /**
         * The stage of the FirewallRule definition allowing to specify properties.
         */
        interface WithProperties {
            /**
             * Specifies the properties property: The resource-specific properties for this resource..
             * 
             * @param properties The resource-specific properties for this resource.
             * @return the next definition stage.
             */
            WithCreate withProperties(FirewallRuleProperties properties);
        }
    }

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

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

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

    /**
     * The FirewallRule update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the FirewallRule update allowing to specify properties.
         */
        interface WithProperties {
            /**
             * Specifies the properties property: The resource-specific properties for this resource..
             * 
             * @param properties The resource-specific properties for this resource.
             * @return the next definition stage.
             */
            Update withProperties(FirewallRuleProperties properties);
        }
    }

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

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