Class ApiProperties


  • public final class ApiProperties
    extends Object
    The api properties for special APIs.
    • Constructor Detail

      • ApiProperties

        public ApiProperties()
    • Method Detail

      • qnaRuntimeEndpoint

        public String qnaRuntimeEndpoint()
        Get the qnaRuntimeEndpoint property: (QnAMaker Only) The runtime endpoint of QnAMaker.
        Returns:
        the qnaRuntimeEndpoint value.
      • withQnaRuntimeEndpoint

        public ApiProperties withQnaRuntimeEndpoint​(String qnaRuntimeEndpoint)
        Set the qnaRuntimeEndpoint property: (QnAMaker Only) The runtime endpoint of QnAMaker.
        Parameters:
        qnaRuntimeEndpoint - the qnaRuntimeEndpoint value to set.
        Returns:
        the ApiProperties object itself.
      • qnaAzureSearchEndpointKey

        public String qnaAzureSearchEndpointKey()
        Get the qnaAzureSearchEndpointKey property: (QnAMaker Only) The Azure Search endpoint key of QnAMaker.
        Returns:
        the qnaAzureSearchEndpointKey value.
      • withQnaAzureSearchEndpointKey

        public ApiProperties withQnaAzureSearchEndpointKey​(String qnaAzureSearchEndpointKey)
        Set the qnaAzureSearchEndpointKey property: (QnAMaker Only) The Azure Search endpoint key of QnAMaker.
        Parameters:
        qnaAzureSearchEndpointKey - the qnaAzureSearchEndpointKey value to set.
        Returns:
        the ApiProperties object itself.
      • qnaAzureSearchEndpointId

        public String qnaAzureSearchEndpointId()
        Get the qnaAzureSearchEndpointId property: (QnAMaker Only) The Azure Search endpoint id of QnAMaker.
        Returns:
        the qnaAzureSearchEndpointId value.
      • withQnaAzureSearchEndpointId

        public ApiProperties withQnaAzureSearchEndpointId​(String qnaAzureSearchEndpointId)
        Set the qnaAzureSearchEndpointId property: (QnAMaker Only) The Azure Search endpoint id of QnAMaker.
        Parameters:
        qnaAzureSearchEndpointId - the qnaAzureSearchEndpointId value to set.
        Returns:
        the ApiProperties object itself.
      • statisticsEnabled

        public Boolean statisticsEnabled()
        Get the statisticsEnabled property: (Bing Search Only) The flag to enable statistics of Bing Search.
        Returns:
        the statisticsEnabled value.
      • withStatisticsEnabled

        public ApiProperties withStatisticsEnabled​(Boolean statisticsEnabled)
        Set the statisticsEnabled property: (Bing Search Only) The flag to enable statistics of Bing Search.
        Parameters:
        statisticsEnabled - the statisticsEnabled value to set.
        Returns:
        the ApiProperties object itself.
      • eventHubConnectionString

        public String eventHubConnectionString()
        Get the eventHubConnectionString property: (Personalization Only) The flag to enable statistics of Bing Search.
        Returns:
        the eventHubConnectionString value.
      • withEventHubConnectionString

        public ApiProperties withEventHubConnectionString​(String eventHubConnectionString)
        Set the eventHubConnectionString property: (Personalization Only) The flag to enable statistics of Bing Search.
        Parameters:
        eventHubConnectionString - the eventHubConnectionString value to set.
        Returns:
        the ApiProperties object itself.
      • storageAccountConnectionString

        public String storageAccountConnectionString()
        Get the storageAccountConnectionString property: (Personalization Only) The storage account connection string.
        Returns:
        the storageAccountConnectionString value.
      • withStorageAccountConnectionString

        public ApiProperties withStorageAccountConnectionString​(String storageAccountConnectionString)
        Set the storageAccountConnectionString property: (Personalization Only) The storage account connection string.
        Parameters:
        storageAccountConnectionString - the storageAccountConnectionString value to set.
        Returns:
        the ApiProperties object itself.
      • aadClientId

        public String aadClientId()
        Get the aadClientId property: (Metrics Advisor Only) The Azure AD Client Id (Application Id).
        Returns:
        the aadClientId value.
      • withAadClientId

        public ApiProperties withAadClientId​(String aadClientId)
        Set the aadClientId property: (Metrics Advisor Only) The Azure AD Client Id (Application Id).
        Parameters:
        aadClientId - the aadClientId value to set.
        Returns:
        the ApiProperties object itself.
      • aadTenantId

        public String aadTenantId()
        Get the aadTenantId property: (Metrics Advisor Only) The Azure AD Tenant Id.
        Returns:
        the aadTenantId value.
      • withAadTenantId

        public ApiProperties withAadTenantId​(String aadTenantId)
        Set the aadTenantId property: (Metrics Advisor Only) The Azure AD Tenant Id.
        Parameters:
        aadTenantId - the aadTenantId value to set.
        Returns:
        the ApiProperties object itself.
      • superUser

        public String superUser()
        Get the superUser property: (Metrics Advisor Only) The super user of Metrics Advisor.
        Returns:
        the superUser value.
      • withSuperUser

        public ApiProperties withSuperUser​(String superUser)
        Set the superUser property: (Metrics Advisor Only) The super user of Metrics Advisor.
        Parameters:
        superUser - the superUser value to set.
        Returns:
        the ApiProperties object itself.
      • websiteName

        public String websiteName()
        Get the websiteName property: (Metrics Advisor Only) The website name of Metrics Advisor.
        Returns:
        the websiteName value.
      • withWebsiteName

        public ApiProperties withWebsiteName​(String websiteName)
        Set the websiteName property: (Metrics Advisor Only) The website name of Metrics Advisor.
        Parameters:
        websiteName - the websiteName value to set.
        Returns:
        the ApiProperties object itself.
      • additionalProperties

        public Map<String,​Object> additionalProperties()
        Get the additionalProperties property: The api properties for special APIs.
        Returns:
        the additionalProperties value.
      • withAdditionalProperties

        public ApiProperties withAdditionalProperties​(Map<String,​Object> additionalProperties)
        Set the additionalProperties property: The api properties for special APIs.
        Parameters:
        additionalProperties - the additionalProperties value to set.
        Returns:
        the ApiProperties object itself.
      • validate

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