com.azure.resourcemanager.botservice.fluent.BotConnectionsClient 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.fluent;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
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.ConnectionSettingInner;
import com.azure.resourcemanager.botservice.fluent.models.ServiceProviderResponseListInner;
/** An instance of this class provides access to all the operations defined in BotConnectionsClient. */
public interface BotConnectionsClient {
/**
* Lists the available Service Providers for creating Connection Settings.
*
* @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 providers response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ServiceProviderResponseListInner listServiceProviders();
/**
* Lists the available Service Providers for creating Connection Settings.
*
* @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 providers response along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response listServiceProvidersWithResponse(Context context);
/**
* Get a Connection Setting 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 connectionName The name of the Bot Service Connection Setting 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 a Connection Setting registration for a Bot Service.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConnectionSettingInner listWithSecrets(String resourceGroupName, String resourceName, String connectionName);
/**
* Get a Connection Setting 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 connectionName The name of the Bot Service Connection Setting 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 a Connection Setting registration for a Bot Service along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response listWithSecretsWithResponse(
String resourceGroupName, String resourceName, String connectionName, Context context);
/**
* Register a new Auth Connection 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 connectionName The name of the Bot Service Connection Setting resource.
* @param parameters The parameters to provide for creating the Connection Setting.
* @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.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConnectionSettingInner create(
String resourceGroupName, String resourceName, String connectionName, ConnectionSettingInner parameters);
/**
* Register a new Auth Connection 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 connectionName The name of the Bot Service Connection Setting resource.
* @param parameters The parameters to provide for creating the Connection Setting.
* @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}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response createWithResponse(
String resourceGroupName,
String resourceName,
String connectionName,
ConnectionSettingInner parameters,
Context context);
/**
* Updates a Connection Setting 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 connectionName The name of the Bot Service Connection Setting resource.
* @param parameters The parameters to provide for updating the Connection Setting.
* @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.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConnectionSettingInner update(
String resourceGroupName, String resourceName, String connectionName, ConnectionSettingInner parameters);
/**
* Updates a Connection Setting 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 connectionName The name of the Bot Service Connection Setting resource.
* @param parameters The parameters to provide for updating the Connection Setting.
* @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}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response updateWithResponse(
String resourceGroupName,
String resourceName,
String connectionName,
ConnectionSettingInner parameters,
Context context);
/**
* Get a Connection Setting 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 connectionName The name of the Bot Service Connection Setting 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 a Connection Setting registration for a Bot Service.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConnectionSettingInner get(String resourceGroupName, String resourceName, String connectionName);
/**
* Get a Connection Setting 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 connectionName The name of the Bot Service Connection Setting 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 a Connection Setting registration for a Bot Service along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getWithResponse(
String resourceGroupName, String resourceName, String connectionName, Context context);
/**
* Deletes a Connection Setting 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 connectionName The name of the Bot Service Connection Setting 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.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void delete(String resourceGroupName, String resourceName, String connectionName);
/**
* Deletes a Connection Setting 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 connectionName The name of the Bot Service Connection Setting 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}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response deleteWithResponse(
String resourceGroupName, String resourceName, String connectionName, Context context);
/**
* Returns all the Connection Settings registered to 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 connection settings response.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByBotService(String resourceGroupName, String resourceName);
/**
* Returns all the Connection Settings registered to 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 connection settings response.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByBotService(
String resourceGroupName, String resourceName, Context context);
}