com.azure.resourcemanager.botservice.models.Channels Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-botservice Show documentation
Show all versions of azure-resourcemanager-botservice Show documentation
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.
// 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.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import com.azure.resourcemanager.botservice.fluent.models.BotChannelInner;
/** Resource collection API of Channels. */
public interface Channels {
/**
* Creates a Channel registration for a Bot Service.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Channel resource.
* @param parameters The parameters to provide for the created bot.
* @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.
* @return bot channel resource definition.
*/
BotChannel create(
String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters);
/**
* Creates a Channel registration for a Bot Service.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Channel resource.
* @param parameters The parameters to provide for the created bot.
* @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.
* @return bot channel resource definition along with {@link Response}.
*/
Response createWithResponse(
String resourceGroupName,
String resourceName,
ChannelName channelName,
BotChannelInner parameters,
Context context);
/**
* Updates a Channel registration for a Bot Service.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Channel resource.
* @param parameters The parameters to provide for the created bot.
* @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.
* @return bot channel resource definition.
*/
BotChannel update(
String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters);
/**
* Updates a Channel registration for a Bot Service.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Channel resource.
* @param parameters The parameters to provide for the created bot.
* @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.
* @return bot channel resource definition along with {@link Response}.
*/
Response updateWithResponse(
String resourceGroupName,
String resourceName,
ChannelName channelName,
BotChannelInner parameters,
Context context);
/**
* Deletes a Channel registration from a Bot Service.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Bot resource.
* @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 delete(String resourceGroupName, String resourceName, String channelName);
/**
* Deletes a Channel registration from a Bot Service.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Bot resource.
* @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.
* @return the {@link Response}.
*/
Response deleteWithResponse(
String resourceGroupName, String resourceName, String channelName, Context context);
/**
* Returns a BotService Channel registration specified by the parameters.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Bot resource.
* @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.
* @return bot channel resource definition.
*/
BotChannel get(String resourceGroupName, String resourceName, String channelName);
/**
* Returns a BotService Channel registration specified by the parameters.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Bot resource.
* @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.
* @return bot channel resource definition along with {@link Response}.
*/
Response getWithResponse(
String resourceGroupName, String resourceName, String channelName, Context context);
/**
* Lists a Channel registration for a Bot Service including secrets.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Channel resource.
* @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.
* @return the ARM channel of list channel with keys operation response.
*/
ListChannelWithKeysResponse listWithKeys(String resourceGroupName, String resourceName, ChannelName channelName);
/**
* Lists a Channel registration for a Bot Service including secrets.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @param channelName The name of the Channel resource.
* @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.
* @return the ARM channel of list channel with keys operation response along with {@link Response}.
*/
Response listWithKeysWithResponse(
String resourceGroupName, String resourceName, ChannelName channelName, Context context);
/**
* Returns all the Channel registrations of a particular BotService resource.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @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.
* @return the list of bot service channel operation response.
*/
PagedIterable listByResourceGroup(String resourceGroupName, String resourceName);
/**
* Returns all the Channel registrations of a particular BotService resource.
*
* @param resourceGroupName The name of the Bot resource group in the user subscription.
* @param resourceName The name of the Bot resource.
* @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.
* @return the list of bot service channel operation response.
*/
PagedIterable listByResourceGroup(String resourceGroupName, String resourceName, Context context);
}