MicrosoftSQLServerSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.MicrosoftSQLServerSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MicrosoftSQLServerSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that defines a Microsoft SQL Server endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MicrosoftSQLServerSettings()

Constructors
Constructor and Description
`MicrosoftSQLServerSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MicrosoftSQLServerSettings`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBcpPacketSize()` The maximum size of the packets (in bytes) used to transfer data using BCP.
`String`	`getControlTablesFileGroup()` Specify a filegroup for the AWS DMS internal tables.
`String`	`getDatabaseName()` Database name for the endpoint.
`String`	`getPassword()` Endpoint connection password.
`Integer`	`getPort()` Endpoint TCP port.
`Boolean`	`getReadBackupOnly()` When this attribute is set to `Y`, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.
`String`	`getSafeguardPolicy()` Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
`String`	`getServerName()` Fully qualified domain name of the endpoint.
`Boolean`	`getUseBcpFullLoad()` Use this to attribute to transfer data for full-load operations using BCP.
`String`	`getUsername()` Endpoint connection user name.
`int`	`hashCode()`
`Boolean`	`isReadBackupOnly()` When this attribute is set to `Y`, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.
`Boolean`	`isUseBcpFullLoad()` Use this to attribute to transfer data for full-load operations using BCP.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBcpPacketSize(Integer bcpPacketSize)` The maximum size of the packets (in bytes) used to transfer data using BCP.
`void`	`setControlTablesFileGroup(String controlTablesFileGroup)` Specify a filegroup for the AWS DMS internal tables.
`void`	`setDatabaseName(String databaseName)` Database name for the endpoint.
`void`	`setPassword(String password)` Endpoint connection password.
`void`	`setPort(Integer port)` Endpoint TCP port.
`void`	`setReadBackupOnly(Boolean readBackupOnly)` When this attribute is set to `Y`, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.
`void`	`setSafeguardPolicy(String safeguardPolicy)` Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
`void`	`setServerName(String serverName)` Fully qualified domain name of the endpoint.
`void`	`setUseBcpFullLoad(Boolean useBcpFullLoad)` Use this to attribute to transfer data for full-load operations using BCP.
`void`	`setUsername(String username)` Endpoint connection user name.
`String`	`toString()` Returns a string representation of this object.
`MicrosoftSQLServerSettings`	`withBcpPacketSize(Integer bcpPacketSize)` The maximum size of the packets (in bytes) used to transfer data using BCP.
`MicrosoftSQLServerSettings`	`withControlTablesFileGroup(String controlTablesFileGroup)` Specify a filegroup for the AWS DMS internal tables.
`MicrosoftSQLServerSettings`	`withDatabaseName(String databaseName)` Database name for the endpoint.
`MicrosoftSQLServerSettings`	`withPassword(String password)` Endpoint connection password.
`MicrosoftSQLServerSettings`	`withPort(Integer port)` Endpoint TCP port.
`MicrosoftSQLServerSettings`	`withReadBackupOnly(Boolean readBackupOnly)` When this attribute is set to `Y`, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.
`MicrosoftSQLServerSettings`	`withSafeguardPolicy(SafeguardPolicy safeguardPolicy)` Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
`MicrosoftSQLServerSettings`	`withSafeguardPolicy(String safeguardPolicy)` Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
`MicrosoftSQLServerSettings`	`withServerName(String serverName)` Fully qualified domain name of the endpoint.
`MicrosoftSQLServerSettings`	`withUseBcpFullLoad(Boolean useBcpFullLoad)` Use this to attribute to transfer data for full-load operations using BCP.
`MicrosoftSQLServerSettings`	`withUsername(String username)` Endpoint connection user name.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MicrosoftSQLServerSettings
```
public MicrosoftSQLServerSettings()
```
- Method Detail
  - setPort
```
public void setPort(Integer port)
```
    Endpoint TCP port.
    
    Parameters:
    
    port - Endpoint TCP port.
  - getPort
```
public Integer getPort()
```
    Endpoint TCP port.
    
    Returns:
    
    Endpoint TCP port.
  - withPort
```
public MicrosoftSQLServerSettings withPort(Integer port)
```
    Endpoint TCP port.
    
    Parameters:
    
    port - Endpoint TCP port.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBcpPacketSize
```
public void setBcpPacketSize(Integer bcpPacketSize)
```
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    
    Parameters:
    
    bcpPacketSize - The maximum size of the packets (in bytes) used to transfer data using BCP.
  - getBcpPacketSize
```
public Integer getBcpPacketSize()
```
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    
    Returns:
    
    The maximum size of the packets (in bytes) used to transfer data using BCP.
  - withBcpPacketSize
```
public MicrosoftSQLServerSettings withBcpPacketSize(Integer bcpPacketSize)
```
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    
    Parameters:
    
    bcpPacketSize - The maximum size of the packets (in bytes) used to transfer data using BCP.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    Database name for the endpoint.
    
    Parameters:
    
    databaseName - Database name for the endpoint.
  - getDatabaseName
```
public String getDatabaseName()
```
    Database name for the endpoint.
    
    Returns:
    
    Database name for the endpoint.
  - withDatabaseName
```
public MicrosoftSQLServerSettings withDatabaseName(String databaseName)
```
    Database name for the endpoint.
    
    Parameters:
    
    databaseName - Database name for the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setControlTablesFileGroup
```
public void setControlTablesFileGroup(String controlTablesFileGroup)
```
    Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.
    
    Parameters:
    
    controlTablesFileGroup - Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.
  - getControlTablesFileGroup
```
public String getControlTablesFileGroup()
```
    Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.
    
    Returns:
    
    Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.
  - withControlTablesFileGroup
```
public MicrosoftSQLServerSettings withControlTablesFileGroup(String controlTablesFileGroup)
```
    Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.
    
    Parameters:
    
    controlTablesFileGroup - Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(String password)
```
    Endpoint connection password.
    
    Parameters:
    
    password - Endpoint connection password.
  - getPassword
```
public String getPassword()
```
    Endpoint connection password.
    
    Returns:
    
    Endpoint connection password.
  - withPassword
```
public MicrosoftSQLServerSettings withPassword(String password)
```
    Endpoint connection password.
    
    Parameters:
    
    password - Endpoint connection password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReadBackupOnly
```
public void setReadBackupOnly(Boolean readBackupOnly)
```
    When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
    
    Parameters:
    
    readBackupOnly - When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
  - getReadBackupOnly
```
public Boolean getReadBackupOnly()
```
    When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
    
    Returns:
    
    When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
  - withReadBackupOnly
```
public MicrosoftSQLServerSettings withReadBackupOnly(Boolean readBackupOnly)
```
    When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
    
    Parameters:
    
    readBackupOnly - When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReadBackupOnly
```
public Boolean isReadBackupOnly()
```
    When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
    
    Returns:
    
    When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
  - setSafeguardPolicy
```
public void setSafeguardPolicy(String safeguardPolicy)
```
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    Parameters:
    
    safeguardPolicy - Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    See Also:
    
    SafeguardPolicy
  - getSafeguardPolicy
```
public String getSafeguardPolicy()
```
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    Returns:
    
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    See Also:
    
    SafeguardPolicy
  - withSafeguardPolicy
```
public MicrosoftSQLServerSettings withSafeguardPolicy(String safeguardPolicy)
```
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    Parameters:
    
    safeguardPolicy - Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SafeguardPolicy
  - withSafeguardPolicy
```
public MicrosoftSQLServerSettings withSafeguardPolicy(SafeguardPolicy safeguardPolicy)
```
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    Parameters:
    
    safeguardPolicy - Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    
    Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
    
    Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SafeguardPolicy
  - setServerName
```
public void setServerName(String serverName)
```
    Fully qualified domain name of the endpoint.
    
    Parameters:
    
    serverName - Fully qualified domain name of the endpoint.
  - getServerName
```
public String getServerName()
```
    Fully qualified domain name of the endpoint.
    
    Returns:
    
    Fully qualified domain name of the endpoint.
  - withServerName
```
public MicrosoftSQLServerSettings withServerName(String serverName)
```
    Fully qualified domain name of the endpoint.
    
    Parameters:
    
    serverName - Fully qualified domain name of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    Endpoint connection user name.
    
    Parameters:
    
    username - Endpoint connection user name.
  - getUsername
```
public String getUsername()
```
    Endpoint connection user name.
    
    Returns:
    
    Endpoint connection user name.
  - withUsername
```
public MicrosoftSQLServerSettings withUsername(String username)
```
    Endpoint connection user name.
    
    Parameters:
    
    username - Endpoint connection user name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUseBcpFullLoad
```
public void setUseBcpFullLoad(Boolean useBcpFullLoad)
```
    Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
    
    Parameters:
    
    useBcpFullLoad - Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
  - getUseBcpFullLoad
```
public Boolean getUseBcpFullLoad()
```
    Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
    
    Returns:
    
    Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
  - withUseBcpFullLoad
```
public MicrosoftSQLServerSettings withUseBcpFullLoad(Boolean useBcpFullLoad)
```
    Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
    
    Parameters:
    
    useBcpFullLoad - Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseBcpFullLoad
```
public Boolean isUseBcpFullLoad()
```
    Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
    
    Returns:
    
    Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MicrosoftSQLServerSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class MicrosoftSQLServerSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MicrosoftSQLServerSettings

Method Detail

setPort

getPort

withPort

setBcpPacketSize

getBcpPacketSize

withBcpPacketSize

setDatabaseName

getDatabaseName

withDatabaseName

setControlTablesFileGroup

getControlTablesFileGroup

withControlTablesFileGroup

setPassword

getPassword

withPassword

setReadBackupOnly

getReadBackupOnly

withReadBackupOnly

isReadBackupOnly

setSafeguardPolicy

getSafeguardPolicy

withSafeguardPolicy

withSafeguardPolicy

setServerName

getServerName

withServerName

setUsername

getUsername

withUsername

setUseBcpFullLoad

getUseBcpFullLoad

withUseBcpFullLoad

isUseBcpFullLoad

toString

equals

hashCode

clone

marshall