Class MigrationPropertiesForPatch

java.lang.Object
com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.MigrationPropertiesForPatch
All Implemented Interfaces:
com.azure.json.JsonSerializable<MigrationPropertiesForPatch>
public final class MigrationPropertiesForPatch extends Object implements com.azure.json.JsonSerializable<MigrationPropertiesForPatch>
Migration properties.

  • Constructor Details

    • MigrationPropertiesForPatch

      public MigrationPropertiesForPatch()
      Creates an instance of MigrationPropertiesForPatch class.

  • Method Details

    • sourceDbServerResourceId

      public String sourceDbServerResourceId()
      Get 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.

    • withSourceDbServerResourceId

      public MigrationPropertiesForPatch withSourceDbServerResourceId(String sourceDbServerResourceId)
      Set 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.
      Parameters:
      sourceDbServerResourceId - the sourceDbServerResourceId value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • sourceDbServerFullyQualifiedDomainName

      public String sourceDbServerFullyQualifiedDomainName()
      Get 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.

    • withSourceDbServerFullyQualifiedDomainName

      public MigrationPropertiesForPatch withSourceDbServerFullyQualifiedDomainName(String sourceDbServerFullyQualifiedDomainName)
      Set 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.
      Parameters:
      sourceDbServerFullyQualifiedDomainName - the sourceDbServerFullyQualifiedDomainName value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • targetDbServerFullyQualifiedDomainName

      public String targetDbServerFullyQualifiedDomainName()
      Get 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.

    • withTargetDbServerFullyQualifiedDomainName

      public MigrationPropertiesForPatch withTargetDbServerFullyQualifiedDomainName(String targetDbServerFullyQualifiedDomainName)
      Set 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.
      Parameters:
      targetDbServerFullyQualifiedDomainName - the targetDbServerFullyQualifiedDomainName value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • secretParameters

      public MigrationSecretParametersForPatch secretParameters()
      Get the secretParameters property: Migration secret parameters.
      Returns:
      the secretParameters value.

    • withSecretParameters

      public MigrationPropertiesForPatch withSecretParameters(MigrationSecretParametersForPatch secretParameters)
      Set the secretParameters property: Migration secret parameters.
      Parameters:
      secretParameters - the secretParameters value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • dbsToMigrate

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

    • withDbsToMigrate

      public MigrationPropertiesForPatch withDbsToMigrate(List<String> dbsToMigrate)
      Set the dbsToMigrate property: Names of databases to migrate.
      Parameters:
      dbsToMigrate - the dbsToMigrate value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • setupLogicalReplicationOnSourceDbIfNeeded

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

    • withSetupLogicalReplicationOnSourceDbIfNeeded

      public MigrationPropertiesForPatch withSetupLogicalReplicationOnSourceDbIfNeeded(LogicalReplicationOnSourceServer setupLogicalReplicationOnSourceDbIfNeeded)
      Set the setupLogicalReplicationOnSourceDbIfNeeded property: Indicates whether to setup logical replication on source server, if needed.
      Parameters:
      setupLogicalReplicationOnSourceDbIfNeeded - the setupLogicalReplicationOnSourceDbIfNeeded value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • overwriteDbsInTarget

      public OverwriteDatabasesOnTargetServer overwriteDbsInTarget()
      Get 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.

    • withOverwriteDbsInTarget

      public MigrationPropertiesForPatch withOverwriteDbsInTarget(OverwriteDatabasesOnTargetServer overwriteDbsInTarget)
      Set 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.
      Parameters:
      overwriteDbsInTarget - the overwriteDbsInTarget value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • migrationWindowStartTimeInUtc

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

    • withMigrationWindowStartTimeInUtc

      public MigrationPropertiesForPatch withMigrationWindowStartTimeInUtc(OffsetDateTime migrationWindowStartTimeInUtc)
      Set the migrationWindowStartTimeInUtc property: Start time (UTC) for migration window.
      Parameters:
      migrationWindowStartTimeInUtc - the migrationWindowStartTimeInUtc value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • migrateRoles

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

    • withMigrateRoles

      public MigrationPropertiesForPatch withMigrateRoles(MigrateRolesAndPermissions migrateRoles)
      Set the migrateRoles property: Indicates if roles and permissions must be migrated.
      Parameters:
      migrateRoles - the migrateRoles value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • startDataMigration

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

    • withStartDataMigration

      public MigrationPropertiesForPatch withStartDataMigration(StartDataMigration startDataMigration)
      Set the startDataMigration property: Indicates if data migration must start right away.
      Parameters:
      startDataMigration - the startDataMigration value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • triggerCutover

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

    • withTriggerCutover

      public MigrationPropertiesForPatch withTriggerCutover(TriggerCutover triggerCutover)
      Set the triggerCutover property: Indicates if cutover must be triggered for the entire migration.
      Parameters:
      triggerCutover - the triggerCutover value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • dbsToTriggerCutoverOn

      public List<String> dbsToTriggerCutoverOn()
      Get 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.

    • withDbsToTriggerCutoverOn

      public MigrationPropertiesForPatch withDbsToTriggerCutoverOn(List<String> dbsToTriggerCutoverOn)
      Set 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.
      Parameters:
      dbsToTriggerCutoverOn - the dbsToTriggerCutoverOn value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • cancel

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

    • withCancel

      public MigrationPropertiesForPatch withCancel(Cancel cancel)
      Set the cancel property: Indicates if cancel must be triggered for the entire migration.
      Parameters:
      cancel - the cancel value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • dbsToCancelMigrationOn

      public List<String> dbsToCancelMigrationOn()
      Get 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.

    • withDbsToCancelMigrationOn

      public MigrationPropertiesForPatch withDbsToCancelMigrationOn(List<String> dbsToCancelMigrationOn)
      Set 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.
      Parameters:
      dbsToCancelMigrationOn - the dbsToCancelMigrationOn value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • migrationMode

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

    • withMigrationMode

      public MigrationPropertiesForPatch withMigrationMode(MigrationMode migrationMode)
      Set the migrationMode property: Mode used to perform the migration: Online or Offline.
      Parameters:
      migrationMode - the migrationMode value to set.
      Returns:
      the MigrationPropertiesForPatch object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<MigrationPropertiesForPatch>
      Throws:
      IOException

    • fromJson

      public static MigrationPropertiesForPatch fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of MigrationPropertiesForPatch from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of MigrationPropertiesForPatch if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the MigrationPropertiesForPatch.