Package com.azure.resourcemanager.botservice.models

Class BotProperties

java.lang.Object
com.azure.resourcemanager.botservice.models.BotProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<BotProperties>
public final class BotProperties extends Object implements com.azure.json.JsonSerializable<BotProperties>
The parameters to provide for the Bot.

  • Constructor Details

    • BotProperties

      public BotProperties()
      Creates an instance of BotProperties class.

  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: The Name of the bot.
      Returns:
      the displayName value.

    • withDisplayName

      public BotProperties withDisplayName(String displayName)
      Set the displayName property: The Name of the bot.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the BotProperties object itself.

    • description

      public String description()
      Get the description property: The description of the bot.
      Returns:
      the description value.

    • withDescription

      public BotProperties withDescription(String description)
      Set the description property: The description of the bot.
      Parameters:
      description - the description value to set.
      Returns:
      the BotProperties object itself.

    • iconUrl

      public String iconUrl()
      Get the iconUrl property: The Icon Url of the bot.
      Returns:
      the iconUrl value.

    • withIconUrl

      public BotProperties withIconUrl(String iconUrl)
      Set the iconUrl property: The Icon Url of the bot.
      Parameters:
      iconUrl - the iconUrl value to set.
      Returns:
      the BotProperties object itself.

    • endpoint

      public String endpoint()
      Get the endpoint property: The bot's endpoint.
      Returns:
      the endpoint value.

    • withEndpoint

      public BotProperties withEndpoint(String endpoint)
      Set the endpoint property: The bot's endpoint.
      Parameters:
      endpoint - the endpoint value to set.
      Returns:
      the BotProperties object itself.

    • endpointVersion

      public String endpointVersion()
      Get the endpointVersion property: The bot's endpoint version.
      Returns:
      the endpointVersion value.

    • allSettings

      public Map<String,String> allSettings()
      Get the allSettings property: Contains resource all settings defined as key/value pairs.
      Returns:
      the allSettings value.

    • withAllSettings

      public BotProperties withAllSettings(Map<String,String> allSettings)
      Set the allSettings property: Contains resource all settings defined as key/value pairs.
      Parameters:
      allSettings - the allSettings value to set.
      Returns:
      the BotProperties object itself.

    • parameters

      public Map<String,String> parameters()
      Get the parameters property: Contains resource parameters defined as key/value pairs.
      Returns:
      the parameters value.

    • withParameters

      public BotProperties withParameters(Map<String,String> parameters)
      Set the parameters property: Contains resource parameters defined as key/value pairs.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the BotProperties object itself.

    • manifestUrl

      public String manifestUrl()
      Get the manifestUrl property: The bot's manifest url.
      Returns:
      the manifestUrl value.

    • withManifestUrl

      public BotProperties withManifestUrl(String manifestUrl)
      Set the manifestUrl property: The bot's manifest url.
      Parameters:
      manifestUrl - the manifestUrl value to set.
      Returns:
      the BotProperties object itself.

    • msaAppType

      public MsaAppType msaAppType()
      Get the msaAppType property: Microsoft App Type for the bot.
      Returns:
      the msaAppType value.

    • withMsaAppType

      public BotProperties withMsaAppType(MsaAppType msaAppType)
      Set the msaAppType property: Microsoft App Type for the bot.
      Parameters:
      msaAppType - the msaAppType value to set.
      Returns:
      the BotProperties object itself.

    • msaAppId

      public String msaAppId()
      Get the msaAppId property: Microsoft App Id for the bot.
      Returns:
      the msaAppId value.

    • withMsaAppId

      public BotProperties withMsaAppId(String msaAppId)
      Set the msaAppId property: Microsoft App Id for the bot.
      Parameters:
      msaAppId - the msaAppId value to set.
      Returns:
      the BotProperties object itself.

    • msaAppTenantId

      public String msaAppTenantId()
      Get the msaAppTenantId property: Microsoft App Tenant Id for the bot.
      Returns:
      the msaAppTenantId value.

    • withMsaAppTenantId

      public BotProperties withMsaAppTenantId(String msaAppTenantId)
      Set the msaAppTenantId property: Microsoft App Tenant Id for the bot.
      Parameters:
      msaAppTenantId - the msaAppTenantId value to set.
      Returns:
      the BotProperties object itself.

    • msaAppMsiResourceId

      public String msaAppMsiResourceId()
      Get the msaAppMsiResourceId property: Microsoft App Managed Identity Resource Id for the bot.
      Returns:
      the msaAppMsiResourceId value.

    • withMsaAppMsiResourceId

      public BotProperties withMsaAppMsiResourceId(String msaAppMsiResourceId)
      Set the msaAppMsiResourceId property: Microsoft App Managed Identity Resource Id for the bot.
      Parameters:
      msaAppMsiResourceId - the msaAppMsiResourceId value to set.
      Returns:
      the BotProperties object itself.

    • configuredChannels

      public List<String> configuredChannels()
      Get the configuredChannels property: Collection of channels for which the bot is configured.
      Returns:
      the configuredChannels value.

    • enabledChannels

      public List<String> enabledChannels()
      Get the enabledChannels property: Collection of channels for which the bot is enabled.
      Returns:
      the enabledChannels value.

    • developerAppInsightKey

      public String developerAppInsightKey()
      Get the developerAppInsightKey property: The Application Insights key.
      Returns:
      the developerAppInsightKey value.

    • withDeveloperAppInsightKey

      public BotProperties withDeveloperAppInsightKey(String developerAppInsightKey)
      Set the developerAppInsightKey property: The Application Insights key.
      Parameters:
      developerAppInsightKey - the developerAppInsightKey value to set.
      Returns:
      the BotProperties object itself.

    • developerAppInsightsApiKey

      public String developerAppInsightsApiKey()
      Get the developerAppInsightsApiKey property: The Application Insights Api Key.
      Returns:
      the developerAppInsightsApiKey value.

    • withDeveloperAppInsightsApiKey

      public BotProperties withDeveloperAppInsightsApiKey(String developerAppInsightsApiKey)
      Set the developerAppInsightsApiKey property: The Application Insights Api Key.
      Parameters:
      developerAppInsightsApiKey - the developerAppInsightsApiKey value to set.
      Returns:
      the BotProperties object itself.

    • developerAppInsightsApplicationId

      public String developerAppInsightsApplicationId()
      Get the developerAppInsightsApplicationId property: The Application Insights App Id.
      Returns:
      the developerAppInsightsApplicationId value.

    • withDeveloperAppInsightsApplicationId

      public BotProperties withDeveloperAppInsightsApplicationId(String developerAppInsightsApplicationId)
      Set the developerAppInsightsApplicationId property: The Application Insights App Id.
      Parameters:
      developerAppInsightsApplicationId - the developerAppInsightsApplicationId value to set.
      Returns:
      the BotProperties object itself.

    • luisAppIds

      public List<String> luisAppIds()
      Get the luisAppIds property: Collection of LUIS App Ids.
      Returns:
      the luisAppIds value.

    • withLuisAppIds

      public BotProperties withLuisAppIds(List<String> luisAppIds)
      Set the luisAppIds property: Collection of LUIS App Ids.
      Parameters:
      luisAppIds - the luisAppIds value to set.
      Returns:
      the BotProperties object itself.

    • luisKey

      public String luisKey()
      Get the luisKey property: The LUIS Key.
      Returns:
      the luisKey value.

    • withLuisKey

      public BotProperties withLuisKey(String luisKey)
      Set the luisKey property: The LUIS Key.
      Parameters:
      luisKey - the luisKey value to set.
      Returns:
      the BotProperties object itself.

    • isCmekEnabled

      public Boolean isCmekEnabled()
      Get the isCmekEnabled property: Whether Cmek is enabled.
      Returns:
      the isCmekEnabled value.

    • withIsCmekEnabled

      public BotProperties withIsCmekEnabled(Boolean isCmekEnabled)
      Set the isCmekEnabled property: Whether Cmek is enabled.
      Parameters:
      isCmekEnabled - the isCmekEnabled value to set.
      Returns:
      the BotProperties object itself.

    • cmekKeyVaultUrl

      public String cmekKeyVaultUrl()
      Get the cmekKeyVaultUrl property: The CMK Url.
      Returns:
      the cmekKeyVaultUrl value.

    • withCmekKeyVaultUrl

      public BotProperties withCmekKeyVaultUrl(String cmekKeyVaultUrl)
      Set the cmekKeyVaultUrl property: The CMK Url.
      Parameters:
      cmekKeyVaultUrl - the cmekKeyVaultUrl value to set.
      Returns:
      the BotProperties object itself.

    • cmekEncryptionStatus

      public String cmekEncryptionStatus()
      Get the cmekEncryptionStatus property: The CMK encryption status.
      Returns:
      the cmekEncryptionStatus value.

    • tenantId

      public String tenantId()
      Get the tenantId property: The Tenant Id for the bot.
      Returns:
      the tenantId value.

    • withTenantId

      public BotProperties withTenantId(String tenantId)
      Set the tenantId property: The Tenant Id for the bot.
      Parameters:
      tenantId - the tenantId value to set.
      Returns:
      the BotProperties object itself.

    • publicNetworkAccess

      public PublicNetworkAccess publicNetworkAccess()
      Get the publicNetworkAccess property: Whether the bot is in an isolated network.
      Returns:
      the publicNetworkAccess value.

    • withPublicNetworkAccess

      public BotProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
      Set the publicNetworkAccess property: Whether the bot is in an isolated network.
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the BotProperties object itself.

    • isStreamingSupported

      public Boolean isStreamingSupported()
      Get the isStreamingSupported property: Whether the bot is streaming supported.
      Returns:
      the isStreamingSupported value.

    • withIsStreamingSupported

      public BotProperties withIsStreamingSupported(Boolean isStreamingSupported)
      Set the isStreamingSupported property: Whether the bot is streaming supported.
      Parameters:
      isStreamingSupported - the isStreamingSupported value to set.
      Returns:
      the BotProperties object itself.

    • isDeveloperAppInsightsApiKeySet

      public Boolean isDeveloperAppInsightsApiKeySet()
      Get the isDeveloperAppInsightsApiKeySet property: Whether the bot is developerAppInsightsApiKey set.
      Returns:
      the isDeveloperAppInsightsApiKeySet value.

    • migrationToken

      public String migrationToken()
      Get the migrationToken property: Token used to migrate non Azure bot to azure subscription.
      Returns:
      the migrationToken value.

    • disableLocalAuth

      public Boolean disableLocalAuth()
      Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
      Returns:
      the disableLocalAuth value.

    • withDisableLocalAuth

      public BotProperties withDisableLocalAuth(Boolean disableLocalAuth)
      Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
      Parameters:
      disableLocalAuth - the disableLocalAuth value to set.
      Returns:
      the BotProperties object itself.

    • schemaTransformationVersion

      public String schemaTransformationVersion()
      Get the schemaTransformationVersion property: The channel schema transformation version for the bot.
      Returns:
      the schemaTransformationVersion value.

    • withSchemaTransformationVersion

      public BotProperties withSchemaTransformationVersion(String schemaTransformationVersion)
      Set the schemaTransformationVersion property: The channel schema transformation version for the bot.
      Parameters:
      schemaTransformationVersion - the schemaTransformationVersion value to set.
      Returns:
      the BotProperties object itself.

    • storageResourceId

      public String storageResourceId()
      Get the storageResourceId property: The storage resourceId for the bot.
      Returns:
      the storageResourceId value.

    • withStorageResourceId

      public BotProperties withStorageResourceId(String storageResourceId)
      Set the storageResourceId property: The storage resourceId for the bot.
      Parameters:
      storageResourceId - the storageResourceId value to set.
      Returns:
      the BotProperties object itself.

    • openWithHint

      public String openWithHint()
      Get the openWithHint property: The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
      Returns:
      the openWithHint value.

    • withOpenWithHint

      public BotProperties withOpenWithHint(String openWithHint)
      Set the openWithHint property: The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
      Parameters:
      openWithHint - the openWithHint value to set.
      Returns:
      the BotProperties object itself.

    • appPasswordHint

      public String appPasswordHint()
      Get the appPasswordHint property: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret.
      Returns:
      the appPasswordHint value.

    • withAppPasswordHint

      public BotProperties withAppPasswordHint(String appPasswordHint)
      Set the appPasswordHint property: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret.
      Parameters:
      appPasswordHint - the appPasswordHint value to set.
      Returns:
      the BotProperties object itself.

    • provisioningState

      public String provisioningState()
      Get the provisioningState property: Provisioning state of the resource.
      Returns:
      the provisioningState value.

    • publishingCredentials

      public String publishingCredentials()
      Get the publishingCredentials property: Publishing credentials of the resource.
      Returns:
      the publishingCredentials value.

    • withPublishingCredentials

      public BotProperties withPublishingCredentials(String publishingCredentials)
      Set the publishingCredentials property: Publishing credentials of the resource.
      Parameters:
      publishingCredentials - the publishingCredentials value to set.
      Returns:
      the BotProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<BotProperties>
      Throws:
      IOException

    • fromJson

      public static BotProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BotProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BotProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the BotProperties.