All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.azure.resourcemanager.botservice.models.Bot Maven / Gradle / Ivy

Go to download

This package contains Microsoft Azure SDK for BotService Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Azure Bot Service is a platform for creating smart conversational agents. Package tag package-2021-03-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.botservice.models;

import com.azure.core.management.Region;
import com.azure.core.util.Context;
import com.azure.resourcemanager.botservice.fluent.models.BotInner;
import java.util.List;
import java.util.Map;

/**
 * An immutable client-side representation of Bot.
 */
public interface Bot {
    /**
     * 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 properties property: The set of properties specific to bot resource.
     * 
     * @return the properties value.
     */
    BotProperties properties();

    /**
     * Gets the sku property: Gets or sets the SKU of the resource.
     * 
     * @return the sku value.
     */
    Sku sku();

    /**
     * Gets the kind property: Required. Gets or sets the Kind of the resource.
     * 
     * @return the kind value.
     */
    Kind kind();

    /**
     * Gets the etag property: Entity Tag.
     * 
     * @return the etag value.
     */
    String etag();

    /**
     * Gets the zones property: Entity zones.
     * 
     * @return the zones value.
     */
    List zones();

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

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

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

        /**
         * The stage of the Bot 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 Bot definition allowing to specify parent resource.
         */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             * 
             * @param resourceGroupName The name of the Bot resource group in the user subscription.
             * @return the next definition stage.
             */
            WithCreate withExistingResourceGroup(String resourceGroupName);
        }

        /**
         * The stage of the Bot 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.WithProperties,
            DefinitionStages.WithSku, DefinitionStages.WithKind, DefinitionStages.WithEtag {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            Bot create();

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

        /**
         * The stage of the Bot 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 Bot definition allowing to specify properties.
         */
        interface WithProperties {
            /**
             * Specifies the properties property: The set of properties specific to bot resource.
             * 
             * @param properties The set of properties specific to bot resource.
             * @return the next definition stage.
             */
            WithCreate withProperties(BotProperties properties);
        }

        /**
         * The stage of the Bot definition allowing to specify sku.
         */
        interface WithSku {
            /**
             * Specifies the sku property: Gets or sets the SKU of the resource..
             * 
             * @param sku Gets or sets the SKU of the resource.
             * @return the next definition stage.
             */
            WithCreate withSku(Sku sku);
        }

        /**
         * The stage of the Bot definition allowing to specify kind.
         */
        interface WithKind {
            /**
             * Specifies the kind property: Required. Gets or sets the Kind of the resource..
             * 
             * @param kind Required. Gets or sets the Kind of the resource.
             * @return the next definition stage.
             */
            WithCreate withKind(Kind kind);
        }

        /**
         * The stage of the Bot definition allowing to specify etag.
         */
        interface WithEtag {
            /**
             * Specifies the etag property: Entity Tag..
             * 
             * @param etag Entity Tag.
             * @return the next definition stage.
             */
            WithCreate withEtag(String etag);
        }
    }

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

    /**
     * The template for Bot update.
     */
    interface Update extends UpdateStages.WithTags, UpdateStages.WithProperties, UpdateStages.WithSku,
        UpdateStages.WithKind, UpdateStages.WithEtag {
        /**
         * Executes the update request.
         * 
         * @return the updated resource.
         */
        Bot apply();

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

    /**
     * The Bot update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the Bot 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 Bot update allowing to specify properties.
         */
        interface WithProperties {
            /**
             * Specifies the properties property: The set of properties specific to bot resource.
             * 
             * @param properties The set of properties specific to bot resource.
             * @return the next definition stage.
             */
            Update withProperties(BotProperties properties);
        }

        /**
         * The stage of the Bot update allowing to specify sku.
         */
        interface WithSku {
            /**
             * Specifies the sku property: Gets or sets the SKU of the resource..
             * 
             * @param sku Gets or sets the SKU of the resource.
             * @return the next definition stage.
             */
            Update withSku(Sku sku);
        }

        /**
         * The stage of the Bot update allowing to specify kind.
         */
        interface WithKind {
            /**
             * Specifies the kind property: Required. Gets or sets the Kind of the resource..
             * 
             * @param kind Required. Gets or sets the Kind of the resource.
             * @return the next definition stage.
             */
            Update withKind(Kind kind);
        }

        /**
         * The stage of the Bot update allowing to specify etag.
         */
        interface WithEtag {
            /**
             * Specifies the etag property: Entity Tag..
             * 
             * @param etag Entity Tag.
             * @return the next definition stage.
             */
            Update withEtag(String etag);
        }
    }

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy