Interface MigrationResource
public interface MigrationResource
An immutable client-side representation of MigrationResource.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the MigrationResource definition.static interfaceThe MigrationResource definition stages.static interfaceThe template for MigrationResource update.static interfaceThe MigrationResource update stages. -
Method Summary
Modifier and TypeMethodDescriptioncancel()Gets the cancel property: To trigger cancel for entire migration we need to send this flag as True.Gets the currentStatus property: Current status of migration.Gets the dbsToCancelMigrationOn property: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array.Gets the dbsToMigrate property: Number of databases to migrate.Gets the dbsToTriggerCutoverOn property: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array.id()Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.MigrationResourceInner object.location()Gets the location property: The geo-location where the resource lives.Gets the migrationId property: ID for migration, a GUID.Gets the migrationMode property: There are two types of migration modes Online and Offline.Gets the migrationWindowEndTimeInUtc property: End time in UTC for migration window.Gets the migrationWindowStartTimeInUtc property: Start time in UTC for migration window.name()Gets the name property: The name of the resource.Gets the overwriteDbsInTarget property: Indicates whether the databases on the target server can be overwritten, if already present.refresh()Refreshes the resource to sync with Azure.refresh(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Regionregion()Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.Gets the secretParameters property: Migration secret parameters.Gets the setupLogicalReplicationOnSourceDbIfNeeded property: Indicates whether to setup LogicalReplicationOnSourceDb, if needed.Gets the sourceDbServerFullyQualifiedDomainName property: Source server fully qualified domain name or ip.Gets the sourceDbServerMetadata property: Metadata of the source database server.Gets the sourceDbServerResourceId property: ResourceId of the source database server.Gets the startDataMigration property: Indicates whether the data migration should start right away.com.azure.core.management.SystemDataGets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.tags()Gets the tags property: Resource tags.Gets the targetDbServerFullyQualifiedDomainName property: Target server fully qualified domain name or ip.Gets the targetDbServerMetadata property: Metadata of the target database server.Gets the targetDbServerResourceId property: ResourceId of the source database server.Gets the triggerCutover property: To trigger cutover for entire migration we need to send this flag as True.type()Gets the type property: The type of the resource.update()Begins update for the MigrationResource resource.
-
Method Details
-
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
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
migrationId
String migrationId()Gets the migrationId property: ID for migration, a GUID.- Returns:
- the migrationId value.
-
currentStatus
MigrationStatus currentStatus()Gets the currentStatus property: Current status of migration.- Returns:
- the currentStatus value.
-
migrationMode
MigrationMode migrationMode()Gets the migrationMode property: There are two types of migration modes Online and Offline.- Returns:
- the migrationMode value.
-
sourceDbServerMetadata
DbServerMetadata sourceDbServerMetadata()Gets the sourceDbServerMetadata property: Metadata of the source database server.- Returns:
- the sourceDbServerMetadata value.
-
targetDbServerMetadata
DbServerMetadata targetDbServerMetadata()Gets the targetDbServerMetadata property: Metadata of the target database server.- Returns:
- the targetDbServerMetadata value.
-
sourceDbServerResourceId
String sourceDbServerResourceId()Gets the sourceDbServerResourceId property: ResourceId of the source database server.- Returns:
- the sourceDbServerResourceId value.
-
sourceDbServerFullyQualifiedDomainName
String sourceDbServerFullyQualifiedDomainName()Gets the sourceDbServerFullyQualifiedDomainName property: Source server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection.- Returns:
- the sourceDbServerFullyQualifiedDomainName value.
-
targetDbServerResourceId
String targetDbServerResourceId()Gets the targetDbServerResourceId property: ResourceId of the source database server.- Returns:
- the targetDbServerResourceId value.
-
targetDbServerFullyQualifiedDomainName
String targetDbServerFullyQualifiedDomainName()Gets the targetDbServerFullyQualifiedDomainName property: Target server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection.- Returns:
- the targetDbServerFullyQualifiedDomainName value.
-
secretParameters
MigrationSecretParameters secretParameters()Gets the secretParameters property: Migration secret parameters.- Returns:
- the secretParameters value.
-
dbsToMigrate
Gets the dbsToMigrate property: Number of databases to migrate.- Returns:
- the dbsToMigrate value.
-
setupLogicalReplicationOnSourceDbIfNeeded
LogicalReplicationOnSourceDbEnum setupLogicalReplicationOnSourceDbIfNeeded()Gets the setupLogicalReplicationOnSourceDbIfNeeded property: Indicates whether to setup LogicalReplicationOnSourceDb, if needed.- Returns:
- the setupLogicalReplicationOnSourceDbIfNeeded value.
-
overwriteDbsInTarget
OverwriteDbsInTargetEnum overwriteDbsInTarget()Gets the overwriteDbsInTarget property: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.- Returns:
- the overwriteDbsInTarget value.
-
migrationWindowStartTimeInUtc
OffsetDateTime migrationWindowStartTimeInUtc()Gets the migrationWindowStartTimeInUtc property: Start time in UTC for migration window.- Returns:
- the migrationWindowStartTimeInUtc value.
-
migrationWindowEndTimeInUtc
OffsetDateTime migrationWindowEndTimeInUtc()Gets the migrationWindowEndTimeInUtc property: End time in UTC for migration window.- Returns:
- the migrationWindowEndTimeInUtc value.
-
startDataMigration
StartDataMigrationEnum startDataMigration()Gets the startDataMigration property: Indicates whether the data migration should start right away.- Returns:
- the startDataMigration value.
-
triggerCutover
TriggerCutoverEnum triggerCutover()Gets the triggerCutover property: To trigger cutover for entire migration we need to send this flag as True.- Returns:
- the triggerCutover value.
-
dbsToTriggerCutoverOn
Gets the dbsToTriggerCutoverOn property: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array.- Returns:
- the dbsToTriggerCutoverOn value.
-
cancel
CancelEnum cancel()Gets the cancel property: To trigger cancel for entire migration we need to send this flag as True.- Returns:
- the cancel value.
-
dbsToCancelMigrationOn
Gets the dbsToCancelMigrationOn property: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array.- Returns:
- the dbsToCancelMigrationOn 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.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
MigrationResourceInner innerModel()Gets the inner com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.MigrationResourceInner object.- Returns:
- the inner object.
-
update
MigrationResource.Update update()Begins update for the MigrationResource resource.- Returns:
- the stage of resource update.
-
refresh
MigrationResource refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context- The context to associate with this operation.- Returns:
- the refreshed resource.
-