Interface Migration

public interface Migration
An immutable client-side representation of Migration.

  • 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

      Map<String,String> 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: Identifier of a migration.
      Returns:
      the migrationId value.

    • currentStatus

      MigrationStatus currentStatus()
      Gets the currentStatus property: Current status of a migration.
      Returns:
      the currentStatus value.

    • migrationInstanceResourceId

      String migrationInstanceResourceId()
      Gets the migrationInstanceResourceId property: Identifier of the private endpoint migration instance.
      Returns:
      the migrationInstanceResourceId value.

    • migrationMode

      MigrationMode migrationMode()
      Gets the migrationMode property: Mode used to perform the migration: Online or Offline.
      Returns:
      the migrationMode value.

    • migrationOption

      MigrationOption migrationOption()
      Gets the migrationOption property: Supported option for a migration.
      Returns:
      the migrationOption value.

    • sourceType

      SourceType sourceType()
      Gets the sourceType property: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL.
      Returns:
      the sourceType value.

    • sslMode

      SslMode sslMode()
      Gets the sslMode property: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.
      Returns:
      the sslMode value.

    • sourceDbServerMetadata

      DbServerMetadata sourceDbServerMetadata()
      Gets the sourceDbServerMetadata property: Metadata of source database server.
      Returns:
      the sourceDbServerMetadata value.

    • targetDbServerMetadata

      DbServerMetadata targetDbServerMetadata()
      Gets the targetDbServerMetadata property: Metadata of target database server.
      Returns:
      the targetDbServerMetadata value.

    • sourceDbServerResourceId

      String sourceDbServerResourceId()
      Gets the sourceDbServerResourceId property: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username.
      Returns:
      the sourceDbServerResourceId value.

    • sourceDbServerFullyQualifiedDomainName

      String sourceDbServerFullyQualifiedDomainName()
      Gets the sourceDbServerFullyQualifiedDomainName property: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server.
      Returns:
      the sourceDbServerFullyQualifiedDomainName value.

    • targetDbServerResourceId

      String targetDbServerResourceId()
      Gets the targetDbServerResourceId property: Identifier of the target database server resource.
      Returns:
      the targetDbServerResourceId value.

    • targetDbServerFullyQualifiedDomainName

      String targetDbServerFullyQualifiedDomainName()
      Gets the targetDbServerFullyQualifiedDomainName property: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server.
      Returns:
      the targetDbServerFullyQualifiedDomainName value.

    • secretParameters

      MigrationSecretParameters secretParameters()
      Gets the secretParameters property: Migration secret parameters.
      Returns:
      the secretParameters value.

    • dbsToMigrate

      List<String> dbsToMigrate()
      Gets the dbsToMigrate property: Names of databases to migrate.
      Returns:
      the dbsToMigrate value.

    • setupLogicalReplicationOnSourceDbIfNeeded

      LogicalReplicationOnSourceServer setupLogicalReplicationOnSourceDbIfNeeded()
      Gets the setupLogicalReplicationOnSourceDbIfNeeded property: Indicates whether to setup logical replication on source server, if needed.
      Returns:
      the setupLogicalReplicationOnSourceDbIfNeeded value.

    • overwriteDbsInTarget

      OverwriteDatabasesOnTargetServer overwriteDbsInTarget()
      Gets the overwriteDbsInTarget property: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation.
      Returns:
      the overwriteDbsInTarget value.

    • migrationWindowStartTimeInUtc

      OffsetDateTime migrationWindowStartTimeInUtc()
      Gets the migrationWindowStartTimeInUtc property: Start time (UTC) for migration window.
      Returns:
      the migrationWindowStartTimeInUtc value.

    • migrationWindowEndTimeInUtc

      OffsetDateTime migrationWindowEndTimeInUtc()
      Gets the migrationWindowEndTimeInUtc property: End time (UTC) for migration window.
      Returns:
      the migrationWindowEndTimeInUtc value.

    • migrateRoles

      MigrateRolesAndPermissions migrateRoles()
      Gets the migrateRoles property: Indicates if roles and permissions must be migrated.
      Returns:
      the migrateRoles value.

    • startDataMigration

      StartDataMigration startDataMigration()
      Gets the startDataMigration property: Indicates if data migration must start right away.
      Returns:
      the startDataMigration value.

    • triggerCutover

      TriggerCutover triggerCutover()
      Gets the triggerCutover property: Indicates if cutover must be triggered for the entire migration.
      Returns:
      the triggerCutover value.

    • dbsToTriggerCutoverOn

      List<String> dbsToTriggerCutoverOn()
      Gets the dbsToTriggerCutoverOn property: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.
      Returns:
      the dbsToTriggerCutoverOn value.

    • cancel

      Cancel cancel()
      Gets the cancel property: Indicates if cancel must be triggered for the entire migration.
      Returns:
      the cancel value.

    • dbsToCancelMigrationOn

      List<String> dbsToCancelMigrationOn()
      Gets the dbsToCancelMigrationOn property: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases 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

      MigrationInner innerModel()
      Gets the inner com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.MigrationInner object.
      Returns:
      the inner object.

    • update

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

    • refresh

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

    • refresh

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