SqlPool Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.15

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.models.Resource
  • • com.azure.analytics.synapse.artifacts.models.TrackedResource
    • • com.azure.analytics.synapse.artifacts.models.SqlPool

public class SqlPool
extends TrackedResource

SQL pool

A SQL Analytics pool.

Constructor Summary

Constructor	Description
SqlPool()	Creates an instance of SqlPool class.

Method Summary

Modifier and Type	Method and Description
String	getCollation() Get the collation property: Collation mode.
CreateMode	getCreateMode() Get the createMode property: Specifies the mode of sql pool creation.
OffsetDateTime	getCreationDate() Get the creationDate property: Date the SQL pool was created.
Long	getMaxSizeBytes() Get the maxSizeBytes property: Maximum size in bytes.
String	getProvisioningState() Get the provisioningState property: Resource state.
String	getRecoverableDatabaseId() Get the recoverableDatabaseId property: Backup database to restore from.
String	getRestorePointInTime() Get the restorePointInTime property: Snapshot time to restore.
Sku	getSku() Get the sku property: Sku
String	getSourceDatabaseId() Get the sourceDatabaseId property: Source database to create from.
String	getStatus() Get the status property: Resource status.
SqlPool	setCollation(String collation) Set the collation property: Collation mode.
SqlPool	setCreateMode(CreateMode createMode) Set the createMode property: Specifies the mode of sql pool creation.
SqlPool	setCreationDate(OffsetDateTime creationDate) Set the creationDate property: Date the SQL pool was created.
SqlPool	setLocation(String location) Set the location property: The geo-location where the resource lives.
SqlPool	setMaxSizeBytes(Long maxSizeBytes) Set the maxSizeBytes property: Maximum size in bytes.
SqlPool	setProvisioningState(String provisioningState) Set the provisioningState property: Resource state.
SqlPool	setRecoverableDatabaseId(String recoverableDatabaseId) Set the recoverableDatabaseId property: Backup database to restore from.
SqlPool	setRestorePointInTime(String restorePointInTime) Set the restorePointInTime property: Snapshot time to restore.
SqlPool	setSku(Sku sku) Set the sku property: Sku
SqlPool	setSourceDatabaseId(String sourceDatabaseId) Set the sourceDatabaseId property: Source database to create from.
SqlPool	setStatus(String status) Set the status property: Resource status.
SqlPool	setTags(Map<String,String> tags) Set the tags property: Resource tags.

Methods inherited from Resource

getId getName getType

Methods inherited from TrackedResource

getLocation getTags setLocation setTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlPool

public SqlPool()

Creates an instance of SqlPool class.

Method Details

getCollation

public String getCollation()

Get the collation property: Collation mode.

Returns:

the collation value.

getCreateMode

public CreateMode getCreateMode()

Get 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.

getCreationDate

public OffsetDateTime getCreationDate()

Get the creationDate property: Date the SQL pool was created.

Returns:

the creationDate value.

getMaxSizeBytes

public Long getMaxSizeBytes()

Get the maxSizeBytes property: Maximum size in bytes.

Returns:

the maxSizeBytes value.

getProvisioningState

public String getProvisioningState()

Get the provisioningState property: Resource state.

Returns:

the provisioningState value.

getRecoverableDatabaseId

public String getRecoverableDatabaseId()

Get the recoverableDatabaseId property: Backup database to restore from.

Returns:

the recoverableDatabaseId value.

getRestorePointInTime

public String getRestorePointInTime()

Get the restorePointInTime property: Snapshot time to restore.

Returns:

the restorePointInTime value.

getSku

public Sku getSku()

Get the sku property: Sku

SQL pool SKU.

Returns:

the sku value.

getSourceDatabaseId

public String getSourceDatabaseId()

Get the sourceDatabaseId property: Source database to create from.

Returns:

the sourceDatabaseId value.

getStatus

public String getStatus()

Get the status property: Resource status.

Returns:

the status value.

setCollation

public SqlPool setCollation(String collation)

Set the collation property: Collation mode.

Parameters:

collation - the collation value to set.

Returns:

the SqlPool object itself.

setCreateMode

public SqlPool setCreateMode(CreateMode createMode)

Set 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.

Parameters:

createMode - the createMode value to set.

Returns:

the SqlPool object itself.

setCreationDate

public SqlPool setCreationDate(OffsetDateTime creationDate)

Set the creationDate property: Date the SQL pool was created.

Parameters:

creationDate - the creationDate value to set.

Returns:

the SqlPool object itself.

setLocation

public SqlPool setLocation(String location)

Set the location property: The geo-location where the resource lives.

Overrides:

SqlPool.setLocation(String location)

Parameters:

location

setMaxSizeBytes

public SqlPool setMaxSizeBytes(Long maxSizeBytes)

Set the maxSizeBytes property: Maximum size in bytes.

Parameters:

maxSizeBytes - the maxSizeBytes value to set.

Returns:

the SqlPool object itself.

setProvisioningState

public SqlPool setProvisioningState(String provisioningState)

Set the provisioningState property: Resource state.

Parameters:

provisioningState - the provisioningState value to set.

Returns:

the SqlPool object itself.

setRecoverableDatabaseId

public SqlPool setRecoverableDatabaseId(String recoverableDatabaseId)

Set the recoverableDatabaseId property: Backup database to restore from.

Parameters:

recoverableDatabaseId - the recoverableDatabaseId value to set.

Returns:

the SqlPool object itself.

setRestorePointInTime

public SqlPool setRestorePointInTime(String restorePointInTime)

Set the restorePointInTime property: Snapshot time to restore.

Parameters:

restorePointInTime - the restorePointInTime value to set.

Returns:

the SqlPool object itself.

setSku

public SqlPool setSku(Sku sku)

Set the sku property: Sku

SQL pool SKU.

Parameters:

sku - the sku value to set.

Returns:

the SqlPool object itself.

setSourceDatabaseId

public SqlPool setSourceDatabaseId(String sourceDatabaseId)

Set the sourceDatabaseId property: Source database to create from.

Parameters:

sourceDatabaseId - the sourceDatabaseId value to set.

Returns:

the SqlPool object itself.

setStatus

public SqlPool setStatus(String status)

Set the status property: Resource status.

Parameters:

status - the status value to set.

Returns:

the SqlPool object itself.

setTags

public SqlPool setTags(Map tags)

Set the tags property: Resource tags.

Overrides:

SqlPool.setTags(Map<String,String> tags)

Parameters:

tags