Package com.azure.resourcemanager.synapse.models

Interface SqlPool

  • public interface SqlPool
    An immutable client-side representation of SqlPool.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.

      • sku

        Sku sku()
        Gets the sku property: Sku SQL pool SKU.
        Returns:
        the sku value.

      • maxSizeBytes

        Long maxSizeBytes()
        Gets the maxSizeBytes property: Maximum size in bytes.
        Returns:
        the maxSizeBytes value.

      • collation

        String collation()
        Gets the collation property: Collation mode.
        Returns:
        the collation value.

      • sourceDatabaseId

        String sourceDatabaseId()
        Gets the sourceDatabaseId property: Source database to create from.
        Returns:
        the sourceDatabaseId value.

      • recoverableDatabaseId

        String recoverableDatabaseId()
        Gets the recoverableDatabaseId property: Backup database to restore from.
        Returns:
        the recoverableDatabaseId value.

      • provisioningState

        String provisioningState()
        Gets the provisioningState property: Resource state.
        Returns:
        the provisioningState value.

      • status

        String status()
        Gets the status property: Resource status.
        Returns:
        the status value.

      • restorePointInTime

        OffsetDateTime restorePointInTime()
        Gets the restorePointInTime property: Snapshot time to restore.
        Returns:
        the restorePointInTime value.

      • createMode

        CreateMode createMode()
        Gets the createMode property: Specifies the mode of sql pool creation.

        Default: regular sql pool creation.

        PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

        Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

        Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

        Returns:
        the createMode value.

      • creationDate

        OffsetDateTime creationDate()
        Gets the creationDate property: Date the SQL pool was created.
        Returns:
        the creationDate value.

      • storageAccountType

        StorageAccountType storageAccountType()
        Gets the storageAccountType property: The storage account type used to store backups for this sql pool.
        Returns:
        the storageAccountType value.

      • sourceDatabaseDeletionDate

        OffsetDateTime sourceDatabaseDeletionDate()
        Gets the sourceDatabaseDeletionDate property: Specifies the time that the sql pool was deleted.
        Returns:
        the sourceDatabaseDeletionDate value.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • innerModel

        SqlPoolInner innerModel()
        Gets the inner com.azure.resourcemanager.synapse.fluent.models.SqlPoolInner object.
        Returns:
        the inner object.

      • update

        SqlPool.Update update()
        Begins update for the SqlPool resource.
        Returns:
        the stage of resource update.

      • refresh

        SqlPool refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        SqlPool refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • pause

        Object pause()
        Pause a SQL pool.
        Returns:
        any object.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • pause

        Object pause​(com.azure.core.util.Context context)
        Pause a SQL pool.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        any object.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • resume

        Object resume()
        Resume a SQL pool.
        Returns:
        any object.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • resume

        Object resume​(com.azure.core.util.Context context)
        Resume a SQL pool.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        any object.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • rename

        void rename​(ResourceMoveDefinition parameters)
        Rename a SQL pool.
        Parameters:
        parameters - The resource move definition for renaming this Sql pool.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • renameWithResponse

        com.azure.core.http.rest.Response<Void> renameWithResponse​(ResourceMoveDefinition parameters,
                                                           com.azure.core.util.Context context)
        Rename a SQL pool.
        Parameters:
        parameters - The resource move definition for renaming this Sql pool.
        context - The context to associate with this operation.
        Returns:
        the Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.