Class AccountProperties


  • public final class AccountProperties
    extends Object
    Properties of Cognitive Services account.
    • Constructor Detail

      • AccountProperties

        public AccountProperties()
    • Method Detail

      • provisioningState

        public ProvisioningState provisioningState()
        Get the provisioningState property: Gets the status of the cognitive services account at the time the operation was called.
        Returns:
        the provisioningState value.
      • endpoint

        public String endpoint()
        Get the endpoint property: Endpoint of the created account.
        Returns:
        the endpoint value.
      • internalId

        public String internalId()
        Get the internalId property: The internal identifier (deprecated, do not use this property).
        Returns:
        the internalId value.
      • capabilities

        public List<SkuCapability> capabilities()
        Get the capabilities property: Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only.
        Returns:
        the capabilities value.
      • isMigrated

        public Boolean isMigrated()
        Get the isMigrated property: If the resource is migrated from an existing key.
        Returns:
        the isMigrated value.
      • migrationToken

        public String migrationToken()
        Get the migrationToken property: Resource migration token.
        Returns:
        the migrationToken value.
      • withMigrationToken

        public AccountProperties withMigrationToken​(String migrationToken)
        Set the migrationToken property: Resource migration token.
        Parameters:
        migrationToken - the migrationToken value to set.
        Returns:
        the AccountProperties object itself.
      • skuChangeInfo

        public SkuChangeInfo skuChangeInfo()
        Get the skuChangeInfo property: Sku change info of account.
        Returns:
        the skuChangeInfo value.
      • customSubDomainName

        public String customSubDomainName()
        Get the customSubDomainName property: Optional subdomain name used for token-based authentication.
        Returns:
        the customSubDomainName value.
      • withCustomSubDomainName

        public AccountProperties withCustomSubDomainName​(String customSubDomainName)
        Set the customSubDomainName property: Optional subdomain name used for token-based authentication.
        Parameters:
        customSubDomainName - the customSubDomainName value to set.
        Returns:
        the AccountProperties object itself.
      • networkAcls

        public NetworkRuleSet networkAcls()
        Get the networkAcls property: A collection of rules governing the accessibility from specific network locations.
        Returns:
        the networkAcls value.
      • withNetworkAcls

        public AccountProperties withNetworkAcls​(NetworkRuleSet networkAcls)
        Set the networkAcls property: A collection of rules governing the accessibility from specific network locations.
        Parameters:
        networkAcls - the networkAcls value to set.
        Returns:
        the AccountProperties object itself.
      • encryption

        public Encryption encryption()
        Get the encryption property: The encryption properties for this resource.
        Returns:
        the encryption value.
      • withEncryption

        public AccountProperties withEncryption​(Encryption encryption)
        Set the encryption property: The encryption properties for this resource.
        Parameters:
        encryption - the encryption value to set.
        Returns:
        the AccountProperties object itself.
      • userOwnedStorage

        public List<UserOwnedStorage> userOwnedStorage()
        Get the userOwnedStorage property: The storage accounts for this resource.
        Returns:
        the userOwnedStorage value.
      • withUserOwnedStorage

        public AccountProperties withUserOwnedStorage​(List<UserOwnedStorage> userOwnedStorage)
        Set the userOwnedStorage property: The storage accounts for this resource.
        Parameters:
        userOwnedStorage - the userOwnedStorage value to set.
        Returns:
        the AccountProperties object itself.
      • privateEndpointConnections

        public List<PrivateEndpointConnectionInner> privateEndpointConnections()
        Get the privateEndpointConnections property: The private endpoint connection associated with the Cognitive Services account.
        Returns:
        the privateEndpointConnections value.
      • publicNetworkAccess

        public PublicNetworkAccess publicNetworkAccess()
        Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this account.
        Returns:
        the publicNetworkAccess value.
      • withPublicNetworkAccess

        public AccountProperties withPublicNetworkAccess​(PublicNetworkAccess publicNetworkAccess)
        Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this account.
        Parameters:
        publicNetworkAccess - the publicNetworkAccess value to set.
        Returns:
        the AccountProperties object itself.
      • apiProperties

        public ApiProperties apiProperties()
        Get the apiProperties property: The api properties for special APIs.
        Returns:
        the apiProperties value.
      • withApiProperties

        public AccountProperties withApiProperties​(ApiProperties apiProperties)
        Set the apiProperties property: The api properties for special APIs.
        Parameters:
        apiProperties - the apiProperties value to set.
        Returns:
        the AccountProperties object itself.
      • dateCreated

        public String dateCreated()
        Get the dateCreated property: Gets the date of cognitive services account creation.
        Returns:
        the dateCreated value.
      • callRateLimit

        public CallRateLimit callRateLimit()
        Get the callRateLimit property: The call rate limit Cognitive Services account.
        Returns:
        the callRateLimit value.
      • dynamicThrottlingEnabled

        public Boolean dynamicThrottlingEnabled()
        Get the dynamicThrottlingEnabled property: The flag to enable dynamic throttling.
        Returns:
        the dynamicThrottlingEnabled value.
      • withDynamicThrottlingEnabled

        public AccountProperties withDynamicThrottlingEnabled​(Boolean dynamicThrottlingEnabled)
        Set the dynamicThrottlingEnabled property: The flag to enable dynamic throttling.
        Parameters:
        dynamicThrottlingEnabled - the dynamicThrottlingEnabled value to set.
        Returns:
        the AccountProperties object itself.
      • quotaLimit

        public QuotaLimit quotaLimit()
        Get the quotaLimit property: The quotaLimit property.
        Returns:
        the quotaLimit value.
      • restrictOutboundNetworkAccess

        public Boolean restrictOutboundNetworkAccess()
        Get the restrictOutboundNetworkAccess property: The restrictOutboundNetworkAccess property.
        Returns:
        the restrictOutboundNetworkAccess value.
      • withRestrictOutboundNetworkAccess

        public AccountProperties withRestrictOutboundNetworkAccess​(Boolean restrictOutboundNetworkAccess)
        Set the restrictOutboundNetworkAccess property: The restrictOutboundNetworkAccess property.
        Parameters:
        restrictOutboundNetworkAccess - the restrictOutboundNetworkAccess value to set.
        Returns:
        the AccountProperties object itself.
      • allowedFqdnList

        public List<String> allowedFqdnList()
        Get the allowedFqdnList property: The allowedFqdnList property.
        Returns:
        the allowedFqdnList value.
      • withAllowedFqdnList

        public AccountProperties withAllowedFqdnList​(List<String> allowedFqdnList)
        Set the allowedFqdnList property: The allowedFqdnList property.
        Parameters:
        allowedFqdnList - the allowedFqdnList value to set.
        Returns:
        the AccountProperties object itself.
      • disableLocalAuth

        public Boolean disableLocalAuth()
        Get the disableLocalAuth property: The disableLocalAuth property.
        Returns:
        the disableLocalAuth value.
      • withDisableLocalAuth

        public AccountProperties withDisableLocalAuth​(Boolean disableLocalAuth)
        Set the disableLocalAuth property: The disableLocalAuth property.
        Parameters:
        disableLocalAuth - the disableLocalAuth value to set.
        Returns:
        the AccountProperties object itself.
      • endpoints

        public Map<String,​String> endpoints()
        Get the endpoints property: Dictionary of <string>.
        Returns:
        the endpoints value.
      • restore

        public Boolean restore()
        Get the restore property: The restore property.
        Returns:
        the restore value.
      • withRestore

        public AccountProperties withRestore​(Boolean restore)
        Set the restore property: The restore property.
        Parameters:
        restore - the restore value to set.
        Returns:
        the AccountProperties object itself.
      • deletionDate

        public String deletionDate()
        Get the deletionDate property: The deletion date, only available for deleted account.
        Returns:
        the deletionDate value.
      • scheduledPurgeDate

        public String scheduledPurgeDate()
        Get the scheduledPurgeDate property: The scheduled purge date, only available for deleted account.
        Returns:
        the scheduledPurgeDate value.
      • validate

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