* Provides information that defines an Oracle endpoint. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class OracleSettings implements Serializable, Cloneable, StructuredPojo { /** ** Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables * PRIMARY KEY supplemental logging on all tables selected for a migration task. *
** If you use this option, you still need to enable database-level supplemental logging. *
*/ private Boolean addSupplementalLogging; /** *
* Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the
* dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the
* AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves
* performance by ensuring that the correct logs are accessed from the outset.
*
* Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in
* the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read
* changes. This need arises because the previous primary instance is now a standby instance after switchover.
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*
* Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the
* dest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
*
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS * needs information about what destination to get archive redo logs from to read changes. DMS needs this because * after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby * setup you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
*
* In a primary-to-multiple-standby setup, you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*
* Set this attribute to true to enable replication of Oracle tables containing columns that are nested
* tables or defined types.
*
* Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC)
* load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default)
* and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.
*
* Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture * (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the * default) and 200,000 (the maximum). *
*/ private Integer readAheadBlocks; /** *
* Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path
* prefix replacement using direct file access.
*
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all
* online redo logs.
*
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an * Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs. *
*/ private String oraclePathPrefix; /** ** Set this string attribute to the required value in order to use the Binary Reader to capture change data for an * Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root * to access the redo logs. *
*/ private String usePathPrefix; /** *
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle
* as the source. This setting tells DMS instance to replace the default Oracle root with the specified
* usePathPrefix setting to access the redo logs.
*
* Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the * same tablespace on the target. *
*/ private Boolean enableHomogenousTablespace; /** *
* When set to true, this attribute helps to increase the commit rate on the Oracle target database by
* writing directly to tables and not writing a trail to database logs.
*
* When this field is set to Y, DMS only accesses the archived redo logs. If the archived redo logs are
* stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.
*
* For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value
* from the asm_user_password value. You set this value as part of the comma-separated value
* that you set to the Password request parameter when you create the endpoint to access transaction
* logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*
* For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server
* value. You set asm_server as part of the extra connection attribute string to access an Oracle
* server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*
* For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value.
* You set asm_user as part of the extra connection attribute string to access an Oracle server with
* Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*
* Specifies whether the length of a character column is in bytes or in characters. To indicate that the character
* column length is in characters, set this attribute to CHAR. Otherwise, the character column length
* is in bytes.
*
* Example: charLengthSemantics=CHAR;
*
* Database name for the endpoint. *
*/ private String databaseName; /** *
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad
* is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that
* the target table cannot have any constraints or indexes.
*
* When set to true, this attribute causes a task to fail if the actual size of an LOB column is
* greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead of
* truncating the LOB data.
*
* Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data * type is converted to precision 38, scale 10. *
*
* Example: numberDataTypeScale=12
*
* Endpoint connection password. *
*/ private String password; /** ** Endpoint TCP port. *
*/ private Integer port; /** *
* When set to true, this attribute supports tablespace replication.
*
* Specifies the number of seconds that the system waits before resending a query. *
*
* Example: retryInterval=6;
*
* For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access
* Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of
* the comma-separated value you set to the Password request parameter when you create the endpoint.
* The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting.
* For more information, see
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
* For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns
* and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the
* SecurityDbEncryption setting. For more information on setting the key name value of
* SecurityDbEncryptionName, see the information and example for setting the
* securityDbEncryptionName extra connection attribute in
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
* Fully qualified domain name of the endpoint. *
*
* For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
* Endpoint.Address
* field.
*
* Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the
* SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function
* that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName
* to call it instead.
*
* Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active * Data Guard standby database, use this attribute to specify the time lag between primary and standby databases. *
** In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for * replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in * production. *
*/ private Integer standbyDelayTime; /** ** Endpoint connection user name. *
*/ private String username; /** *
* Set this attribute to Y to capture change data using the Binary Reader utility. Set
* UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle
* as the source, you set additional attributes. For more information about using this setting with Oracle Automatic
* Storage Management (ASM), see Using
* Oracle LogMiner or DMS Binary Reader for CDC.
*
* Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path * protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables * during a full load. *
*/ private Boolean useDirectPathFullLoad; /** *
* Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this
* attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader
* to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using
* Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret. The role must allow the
* iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Oracle endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId. Or you can specify clear-text values for UserName,
* Password, ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle
* endpoint connection details.
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that
* specifies DMS as the trusted entity and grants the required permissions to access the
* SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value
* that allows access to the Oracle ASM of the endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName,
* AsmPassword, and AsmServerName. You can't specify both. For more information on
* creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to
* access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or
* friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details
* for the Oracle endpoint.
*
* Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is true.
*
* When true, converts timestamps with the timezone datatype to their UTC value.
*
* The timeframe in minutes to check for open transactions for a CDC-only task. *
** You can specify an integer value between 0 (the default) and 240 (the maximum). *
*
* This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours including
* the value for OpenTransactionWindow.
*
* Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables * PRIMARY KEY supplemental logging on all tables selected for a migration task. *
** If you use this option, you still need to enable database-level supplemental logging. *
* * @param addSupplementalLogging * Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute * enables PRIMARY KEY supplemental logging on all tables selected for a migration task. ** If you use this option, you still need to enable database-level supplemental logging. */ public void setAddSupplementalLogging(Boolean addSupplementalLogging) { this.addSupplementalLogging = addSupplementalLogging; } /** *
* Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables * PRIMARY KEY supplemental logging on all tables selected for a migration task. *
** If you use this option, you still need to enable database-level supplemental logging. *
* * @return Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute * enables PRIMARY KEY supplemental logging on all tables selected for a migration task. ** If you use this option, you still need to enable database-level supplemental logging. */ public Boolean getAddSupplementalLogging() { return this.addSupplementalLogging; } /** *
* Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables * PRIMARY KEY supplemental logging on all tables selected for a migration task. *
** If you use this option, you still need to enable database-level supplemental logging. *
* * @param addSupplementalLogging * Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute * enables PRIMARY KEY supplemental logging on all tables selected for a migration task. ** If you use this option, you still need to enable database-level supplemental logging. * @return Returns a reference to this object so that method calls can be chained together. */ public OracleSettings withAddSupplementalLogging(Boolean addSupplementalLogging) { setAddSupplementalLogging(addSupplementalLogging); return this; } /** *
* Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables * PRIMARY KEY supplemental logging on all tables selected for a migration task. *
** If you use this option, you still need to enable database-level supplemental logging. *
* * @return Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute * enables PRIMARY KEY supplemental logging on all tables selected for a migration task. ** If you use this option, you still need to enable database-level supplemental logging. */ public Boolean isAddSupplementalLogging() { return this.addSupplementalLogging; } /** *
* Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the
* dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the
* AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves
* performance by ensuring that the correct logs are accessed from the outset.
*
AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this
* improves performance by ensuring that the correct logs are accessed from the outset.
*/
public void setArchivedLogDestId(Integer archivedLogDestId) {
this.archivedLogDestId = archivedLogDestId;
}
/**
*
* Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the
* dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the
* AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves
* performance by ensuring that the correct logs are accessed from the outset.
*
AdditionalArchivedLogDestId option to specify the additional destination ID. Doing
* this improves performance by ensuring that the correct logs are accessed from the outset.
*/
public Integer getArchivedLogDestId() {
return this.archivedLogDestId;
}
/**
*
* Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the
* dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the
* AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves
* performance by ensuring that the correct logs are accessed from the outset.
*
AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this
* improves performance by ensuring that the correct logs are accessed from the outset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withArchivedLogDestId(Integer archivedLogDestId) {
setArchivedLogDestId(archivedLogDestId);
return this;
}
/**
*
* Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in
* the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read
* changes. This need arises because the previous primary instance is now a standby instance after switchover.
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*
ArchivedLogDestId in a primary/ standby setup. This attribute is
* useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo
* logs from to read changes. This need arises because the previous primary instance is now a standby
* instance after switchover.
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*/
public void setAdditionalArchivedLogDestId(Integer additionalArchivedLogDestId) {
this.additionalArchivedLogDestId = additionalArchivedLogDestId;
}
/**
*
* Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in
* the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read
* changes. This need arises because the previous primary instance is now a standby instance after switchover.
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*
ArchivedLogDestId in a primary/ standby setup. This attribute is
* useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo
* logs from to read changes. This need arises because the previous primary instance is now a standby
* instance after switchover.
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*/
public Integer getAdditionalArchivedLogDestId() {
return this.additionalArchivedLogDestId;
}
/**
*
* Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in
* the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read
* changes. This need arises because the previous primary instance is now a standby instance after switchover.
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*
ArchivedLogDestId in a primary/ standby setup. This attribute is
* useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo
* logs from to read changes. This need arises because the previous primary instance is now a standby
* instance after switchover.
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withAdditionalArchivedLogDestId(Integer additionalArchivedLogDestId) {
setAdditionalArchivedLogDestId(additionalArchivedLogDestId);
return this;
}
/**
*
* Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the
* dest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
*
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS * needs information about what destination to get archive redo logs from to read changes. DMS needs this because * after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby * setup you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
*
* In a primary-to-multiple-standby setup, you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*
dest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
* * This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this * case, DMS needs information about what destination to get archive redo logs from to read changes. DMS * needs this because after the switchover the previous primary is a standby instance. For example, in a * primary-to-single standby setup you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
*
* In a primary-to-multiple-standby setup, you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
*
* Although DMS supports the use of the Oracle
* Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the
*
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS
* needs information about what destination to get archive redo logs from to read changes. DMS needs this because
* after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby
* setup you might apply the following settings.
*
*
* In a primary-to-multiple-standby setup, you might apply the following settings.
*
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*/
public java.util.Listdest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
* RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
* dest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this * case, DMS needs information about what destination to get archive redo logs from to read changes. DMS * needs this because after the switchover the previous primary is a standby instance. For example, in a * primary-to-single standby setup you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
*
* In a primary-to-multiple-standby setup, you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
*
* Although DMS supports the use of the Oracle
* Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the
*
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS
* needs information about what destination to get archive redo logs from to read changes. DMS needs this because
* after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby
* setup you might apply the following settings.
*
*
* In a primary-to-multiple-standby setup, you might apply the following settings.
*
*
* Although DMS supports the use of the Oracle
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setExtraArchivedLogDestIds(java.util.Collection)} or
* {@link #withExtraArchivedLogDestIds(java.util.Collection)} if you want to override the existing values.
* RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
*/
public void setExtraArchivedLogDestIds(java.util.Collectiondest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
* RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
* dest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this * case, DMS needs information about what destination to get archive redo logs from to read changes. DMS * needs this because after the switchover the previous primary is a standby instance. For example, in a * primary-to-single standby setup you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
*
* In a primary-to-multiple-standby setup, you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
*
* Although DMS supports the use of the Oracle
* Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the
*
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS
* needs information about what destination to get archive redo logs from to read changes. DMS needs this because
* after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby
* setup you might apply the following settings.
*
*
* In a primary-to-multiple-standby setup, you might apply the following settings.
*
*
* Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withExtraArchivedLogDestIds(Integer... extraArchivedLogDestIds) {
if (this.extraArchivedLogDestIds == null) {
setExtraArchivedLogDestIds(new java.util.ArrayListdest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
* RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
* dest_id column in the v$archived_log view. Use this setting with the
* archivedLogDestId extra connection attribute in a primary-to-single setup or a
* primary-to-multiple-standby setup.
* This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this * case, DMS needs information about what destination to get archive redo logs from to read changes. DMS * needs this because after the switchover the previous primary is a standby instance. For example, in a * primary-to-single standby setup you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
*
* In a primary-to-multiple-standby setup, you might apply the following settings. *
*
* archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
*
* Although DMS supports the use of the Oracle
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC)
* load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default)
* and 8 (the maximum). Use this attribute together with the
* Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC)
* load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default)
* and 8 (the maximum). Use this attribute together with the
* Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC)
* load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default)
* and 8 (the maximum). Use this attribute together with the
* Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture
* (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the
* default) and 200,000 (the maximum).
*
* Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture
* (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the
* default) and 200,000 (the maximum).
*
* Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture
* (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the
* default) and 200,000 (the maximum).
*
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this attribute to
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.
*
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.
*
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.
*
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root
* to access the redo logs.
*
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root
* to access the redo logs.
*
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root
* to access the redo logs.
*
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle
* as the source. This setting tells DMS instance to replace the default Oracle root with the specified
*
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle
* as the source. This setting tells DMS instance to replace the default Oracle root with the specified
*
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle
* as the source. This setting tells DMS instance to replace the default Oracle root with the specified
*
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle
* as the source. This setting tells DMS instance to replace the default Oracle root with the specified
*
* Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the
* same tablespace on the target.
*
* Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the
* same tablespace on the target.
*
* Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the
* same tablespace on the target.
*
* Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the
* same tablespace on the target.
*
* When set to
* When set to
* When set to
* When set to
* When this field is set to
* When this field is set to
* When this field is set to
* When this field is set to
* For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value
* from the
* For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value
* from the
* For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value
* from the
* For an Oracle source endpoint, your ASM server address. You can set this value from the
* For an Oracle source endpoint, your ASM server address. You can set this value from the
* For an Oracle source endpoint, your ASM server address. You can set this value from the
* For an Oracle source endpoint, your ASM user name. You can set this value from the
* For an Oracle source endpoint, your ASM user name. You can set this value from the
* For an Oracle source endpoint, your ASM user name. You can set this value from the
* Specifies whether the length of a character column is in bytes or in characters. To indicate that the character
* column length is in characters, set this attribute to
* Example: RESETLOGS option to open the database, never use
* RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withExtraArchivedLogDestIds(java.util.Collectiontrue to enable replication of Oracle tables containing columns that are nested
* tables or defined types.
* true to enable replication of Oracle tables containing columns that are
* nested tables or defined types.
*/
public void setAllowSelectNestedTables(Boolean allowSelectNestedTables) {
this.allowSelectNestedTables = allowSelectNestedTables;
}
/**
* true to enable replication of Oracle tables containing columns that are nested
* tables or defined types.
* true to enable replication of Oracle tables containing columns that
* are nested tables or defined types.
*/
public Boolean getAllowSelectNestedTables() {
return this.allowSelectNestedTables;
}
/**
* true to enable replication of Oracle tables containing columns that are nested
* tables or defined types.
* true to enable replication of Oracle tables containing columns that are
* nested tables or defined types.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withAllowSelectNestedTables(Boolean allowSelectNestedTables) {
setAllowSelectNestedTables(allowSelectNestedTables);
return this;
}
/**
* true to enable replication of Oracle tables containing columns that are nested
* tables or defined types.
* true to enable replication of Oracle tables containing columns that
* are nested tables or defined types.
*/
public Boolean isAllowSelectNestedTables() {
return this.allowSelectNestedTables;
}
/**
* readAheadBlocks attribute.
* readAheadBlocks
* attribute.
*/
public void setParallelAsmReadThreads(Integer parallelAsmReadThreads) {
this.parallelAsmReadThreads = parallelAsmReadThreads;
}
/**
* readAheadBlocks attribute.
* readAheadBlocks
* attribute.
*/
public Integer getParallelAsmReadThreads() {
return this.parallelAsmReadThreads;
}
/**
* readAheadBlocks attribute.
* readAheadBlocks
* attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withParallelAsmReadThreads(Integer parallelAsmReadThreads) {
setParallelAsmReadThreads(parallelAsmReadThreads);
return this;
}
/**
* false in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path
* prefix replacement using direct file access.
* false in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any
* specified path prefix replacement using direct file access.
*/
public void setAccessAlternateDirectly(Boolean accessAlternateDirectly) {
this.accessAlternateDirectly = accessAlternateDirectly;
}
/**
* false in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path
* prefix replacement using direct file access.
* false in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any
* specified path prefix replacement using direct file access.
*/
public Boolean getAccessAlternateDirectly() {
return this.accessAlternateDirectly;
}
/**
* false in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path
* prefix replacement using direct file access.
* false in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any
* specified path prefix replacement using direct file access.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withAccessAlternateDirectly(Boolean accessAlternateDirectly) {
setAccessAlternateDirectly(accessAlternateDirectly);
return this;
}
/**
* false in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path
* prefix replacement using direct file access.
* false in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any
* specified path prefix replacement using direct file access.
*/
public Boolean isAccessAlternateDirectly() {
return this.accessAlternateDirectly;
}
/**
* true in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all
* online redo logs.
* true in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement
* to access all online redo logs.
*/
public void setUseAlternateFolderForOnline(Boolean useAlternateFolderForOnline) {
this.useAlternateFolderForOnline = useAlternateFolderForOnline;
}
/**
* true in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all
* online redo logs.
* true in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement
* to access all online redo logs.
*/
public Boolean getUseAlternateFolderForOnline() {
return this.useAlternateFolderForOnline;
}
/**
* true in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all
* online redo logs.
* true in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement
* to access all online redo logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withUseAlternateFolderForOnline(Boolean useAlternateFolderForOnline) {
setUseAlternateFolderForOnline(useAlternateFolderForOnline);
return this;
}
/**
* true in order to use the Binary Reader to capture change data for an Amazon
* RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all
* online redo logs.
* true in order to use the Binary Reader to capture change data for an
* Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement
* to access all online redo logs.
*/
public Boolean isUseAlternateFolderForOnline() {
return this.useAlternateFolderForOnline;
}
/**
* usePathPrefix setting to access the redo logs.
* usePathPrefix setting to access the redo logs.
*/
public void setReplacePathPrefix(Boolean replacePathPrefix) {
this.replacePathPrefix = replacePathPrefix;
}
/**
* usePathPrefix setting to access the redo logs.
* usePathPrefix setting to access the redo logs.
*/
public Boolean getReplacePathPrefix() {
return this.replacePathPrefix;
}
/**
* usePathPrefix setting to access the redo logs.
* usePathPrefix setting to access the redo logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withReplacePathPrefix(Boolean replacePathPrefix) {
setReplacePathPrefix(replacePathPrefix);
return this;
}
/**
* usePathPrefix setting to access the redo logs.
* usePathPrefix setting to access the redo logs.
*/
public Boolean isReplacePathPrefix() {
return this.replacePathPrefix;
}
/**
* true, this attribute helps to increase the commit rate on the Oracle target database by
* writing directly to tables and not writing a trail to database logs.
* true, this attribute helps to increase the commit rate on the Oracle target
* database by writing directly to tables and not writing a trail to database logs.
*/
public void setDirectPathNoLog(Boolean directPathNoLog) {
this.directPathNoLog = directPathNoLog;
}
/**
* true, this attribute helps to increase the commit rate on the Oracle target database by
* writing directly to tables and not writing a trail to database logs.
* true, this attribute helps to increase the commit rate on the Oracle target
* database by writing directly to tables and not writing a trail to database logs.
*/
public Boolean getDirectPathNoLog() {
return this.directPathNoLog;
}
/**
* true, this attribute helps to increase the commit rate on the Oracle target database by
* writing directly to tables and not writing a trail to database logs.
* true, this attribute helps to increase the commit rate on the Oracle target
* database by writing directly to tables and not writing a trail to database logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withDirectPathNoLog(Boolean directPathNoLog) {
setDirectPathNoLog(directPathNoLog);
return this;
}
/**
* true, this attribute helps to increase the commit rate on the Oracle target database by
* writing directly to tables and not writing a trail to database logs.
* true, this attribute helps to increase the commit rate on the Oracle target
* database by writing directly to tables and not writing a trail to database logs.
*/
public Boolean isDirectPathNoLog() {
return this.directPathNoLog;
}
/**
* Y, DMS only accesses the archived redo logs. If the archived redo logs are
* stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.
* Y, DMS only accesses the archived redo logs. If the archived redo
* logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM
* privileges.
*/
public void setArchivedLogsOnly(Boolean archivedLogsOnly) {
this.archivedLogsOnly = archivedLogsOnly;
}
/**
* Y, DMS only accesses the archived redo logs. If the archived redo logs are
* stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.
* Y, DMS only accesses the archived redo logs. If the archived redo
* logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM
* privileges.
*/
public Boolean getArchivedLogsOnly() {
return this.archivedLogsOnly;
}
/**
* Y, DMS only accesses the archived redo logs. If the archived redo logs are
* stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.
* Y, DMS only accesses the archived redo logs. If the archived redo
* logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM
* privileges.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withArchivedLogsOnly(Boolean archivedLogsOnly) {
setArchivedLogsOnly(archivedLogsOnly);
return this;
}
/**
* Y, DMS only accesses the archived redo logs. If the archived redo logs are
* stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.
* Y, DMS only accesses the archived redo logs. If the archived redo
* logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM
* privileges.
*/
public Boolean isArchivedLogsOnly() {
return this.archivedLogsOnly;
}
/**
* asm_user_password value. You set this value as part of the comma-separated value
* that you set to the Password request parameter when you create the endpoint to access transaction
* logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_user_password value. You set this value as part of the
* comma-separated value that you set to the Password request parameter when you create the
* endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
public void setAsmPassword(String asmPassword) {
this.asmPassword = asmPassword;
}
/**
* asm_user_password value. You set this value as part of the comma-separated value
* that you set to the Password request parameter when you create the endpoint to access transaction
* logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_user_password value. You set this value as part of the
* comma-separated value that you set to the Password request parameter when you create the
* endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
public String getAsmPassword() {
return this.asmPassword;
}
/**
* asm_user_password value. You set this value as part of the comma-separated value
* that you set to the Password request parameter when you create the endpoint to access transaction
* logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_user_password value. You set this value as part of the
* comma-separated value that you set to the Password request parameter when you create the
* endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withAsmPassword(String asmPassword) {
setAsmPassword(asmPassword);
return this;
}
/**
* asm_server
* value. You set asm_server as part of the extra connection attribute string to access an Oracle
* server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_server value. You set asm_server as part of the extra connection attribute
* string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
public void setAsmServer(String asmServer) {
this.asmServer = asmServer;
}
/**
* asm_server
* value. You set asm_server as part of the extra connection attribute string to access an Oracle
* server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_server value. You set asm_server as part of the extra connection attribute
* string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
public String getAsmServer() {
return this.asmServer;
}
/**
* asm_server
* value. You set asm_server as part of the extra connection attribute string to access an Oracle
* server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_server value. You set asm_server as part of the extra connection attribute
* string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withAsmServer(String asmServer) {
setAsmServer(asmServer);
return this;
}
/**
* asm_user value.
* You set asm_user as part of the extra connection attribute string to access an Oracle server with
* Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_user
* value. You set asm_user as part of the extra connection attribute string to access an Oracle
* server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
public void setAsmUser(String asmUser) {
this.asmUser = asmUser;
}
/**
* asm_user value.
* You set asm_user as part of the extra connection attribute string to access an Oracle server with
* Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_user
* value. You set asm_user as part of the extra connection attribute string to access an Oracle
* server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
public String getAsmUser() {
return this.asmUser;
}
/**
* asm_user value.
* You set asm_user as part of the extra connection attribute string to access an Oracle server with
* Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* asm_user
* value. You set asm_user as part of the extra connection attribute string to access an Oracle
* server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withAsmUser(String asmUser) {
setAsmUser(asmUser);
return this;
}
/**
* CHAR. Otherwise, the character column length
* is in bytes.
* charLengthSemantics=CHAR;
* CHAR. Otherwise, the
* character column length is in bytes.
* Example: charLengthSemantics=CHAR;
* @see CharLengthSemantics
*/
public void setCharLengthSemantics(String charLengthSemantics) {
this.charLengthSemantics = charLengthSemantics;
}
/**
*
* Specifies whether the length of a character column is in bytes or in characters. To indicate that the character
* column length is in characters, set this attribute to CHAR. Otherwise, the character column length
* is in bytes.
*
* Example: charLengthSemantics=CHAR;
*
CHAR. Otherwise, the
* character column length is in bytes.
*
* Example: charLengthSemantics=CHAR;
* @see CharLengthSemantics
*/
public String getCharLengthSemantics() {
return this.charLengthSemantics;
}
/**
*
* Specifies whether the length of a character column is in bytes or in characters. To indicate that the character
* column length is in characters, set this attribute to CHAR. Otherwise, the character column length
* is in bytes.
*
* Example: charLengthSemantics=CHAR;
*
CHAR. Otherwise, the
* character column length is in bytes.
*
* Example: charLengthSemantics=CHAR;
* @return Returns a reference to this object so that method calls can be chained together.
* @see CharLengthSemantics
*/
public OracleSettings withCharLengthSemantics(String charLengthSemantics) {
setCharLengthSemantics(charLengthSemantics);
return this;
}
/**
*
* Specifies whether the length of a character column is in bytes or in characters. To indicate that the character
* column length is in characters, set this attribute to CHAR. Otherwise, the character column length
* is in bytes.
*
* Example: charLengthSemantics=CHAR;
*
CHAR. Otherwise, the
* character column length is in bytes.
*
* Example: charLengthSemantics=CHAR;
* @return Returns a reference to this object so that method calls can be chained together.
* @see CharLengthSemantics
*/
public OracleSettings withCharLengthSemantics(CharLengthSemantics charLengthSemantics) {
this.charLengthSemantics = charLengthSemantics.toString();
return this;
}
/**
*
* Database name for the endpoint. *
* * @param databaseName * Database name for the endpoint. */ public void setDatabaseName(String databaseName) { this.databaseName = databaseName; } /** ** Database name for the endpoint. *
* * @return Database name for the endpoint. */ public String getDatabaseName() { return this.databaseName; } /** ** Database name for the endpoint. *
* * @param databaseName * Database name for the endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public OracleSettings withDatabaseName(String databaseName) { setDatabaseName(databaseName); return this; } /** *
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad
* is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that
* the target table cannot have any constraints or indexes.
*
true, this attribute specifies a parallel load when
* useDirectPathFullLoad is set to Y. This attribute also only applies when you use
* the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
*/
public void setDirectPathParallelLoad(Boolean directPathParallelLoad) {
this.directPathParallelLoad = directPathParallelLoad;
}
/**
*
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad
* is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that
* the target table cannot have any constraints or indexes.
*
true, this attribute specifies a parallel load when
* useDirectPathFullLoad is set to Y. This attribute also only applies when you
* use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
*/
public Boolean getDirectPathParallelLoad() {
return this.directPathParallelLoad;
}
/**
*
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad
* is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that
* the target table cannot have any constraints or indexes.
*
true, this attribute specifies a parallel load when
* useDirectPathFullLoad is set to Y. This attribute also only applies when you use
* the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withDirectPathParallelLoad(Boolean directPathParallelLoad) {
setDirectPathParallelLoad(directPathParallelLoad);
return this;
}
/**
*
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad
* is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that
* the target table cannot have any constraints or indexes.
*
true, this attribute specifies a parallel load when
* useDirectPathFullLoad is set to Y. This attribute also only applies when you
* use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
*/
public Boolean isDirectPathParallelLoad() {
return this.directPathParallelLoad;
}
/**
*
* When set to true, this attribute causes a task to fail if the actual size of an LOB column is
* greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead of
* truncating the LOB data.
*
true, this attribute causes a task to fail if the actual size of an LOB column is
* greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead
* of truncating the LOB data.
*/
public void setFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation) {
this.failTasksOnLobTruncation = failTasksOnLobTruncation;
}
/**
*
* When set to true, this attribute causes a task to fail if the actual size of an LOB column is
* greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead of
* truncating the LOB data.
*
true, this attribute causes a task to fail if the actual size of an LOB column
* is greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead
* of truncating the LOB data.
*/
public Boolean getFailTasksOnLobTruncation() {
return this.failTasksOnLobTruncation;
}
/**
*
* When set to true, this attribute causes a task to fail if the actual size of an LOB column is
* greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead of
* truncating the LOB data.
*
true, this attribute causes a task to fail if the actual size of an LOB column is
* greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead
* of truncating the LOB data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation) {
setFailTasksOnLobTruncation(failTasksOnLobTruncation);
return this;
}
/**
*
* When set to true, this attribute causes a task to fail if the actual size of an LOB column is
* greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead of
* truncating the LOB data.
*
true, this attribute causes a task to fail if the actual size of an LOB column
* is greater than the specified LobMaxSize.
*
* If a task is set to limited LOB mode and this option is set to true, the task fails instead
* of truncating the LOB data.
*/
public Boolean isFailTasksOnLobTruncation() {
return this.failTasksOnLobTruncation;
}
/**
*
* Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data * type is converted to precision 38, scale 10. *
*
* Example: numberDataTypeScale=12
*
* Example: numberDataTypeScale=12
*/
public void setNumberDatatypeScale(Integer numberDatatypeScale) {
this.numberDatatypeScale = numberDatatypeScale;
}
/**
*
* Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data * type is converted to precision 38, scale 10. *
*
* Example: numberDataTypeScale=12
*
* Example: numberDataTypeScale=12
*/
public Integer getNumberDatatypeScale() {
return this.numberDatatypeScale;
}
/**
*
* Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data * type is converted to precision 38, scale 10. *
*
* Example: numberDataTypeScale=12
*
* Example: numberDataTypeScale=12
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withNumberDatatypeScale(Integer numberDatatypeScale) {
setNumberDatatypeScale(numberDatatypeScale);
return this;
}
/**
*
* Endpoint connection password. *
* * @param password * Endpoint connection password. */ public void setPassword(String password) { this.password = password; } /** ** Endpoint connection password. *
* * @return Endpoint connection password. */ public String getPassword() { return this.password; } /** ** Endpoint connection password. *
* * @param password * Endpoint connection password. * @return Returns a reference to this object so that method calls can be chained together. */ public OracleSettings withPassword(String password) { setPassword(password); return this; } /** ** Endpoint TCP port. *
* * @param port * Endpoint TCP port. */ public void setPort(Integer port) { this.port = port; } /** ** Endpoint TCP port. *
* * @return Endpoint TCP port. */ public Integer getPort() { return this.port; } /** ** Endpoint TCP port. *
* * @param port * Endpoint TCP port. * @return Returns a reference to this object so that method calls can be chained together. */ public OracleSettings withPort(Integer port) { setPort(port); return this; } /** *
* When set to true, this attribute supports tablespace replication.
*
true, this attribute supports tablespace replication.
*/
public void setReadTableSpaceName(Boolean readTableSpaceName) {
this.readTableSpaceName = readTableSpaceName;
}
/**
*
* When set to true, this attribute supports tablespace replication.
*
true, this attribute supports tablespace replication.
*/
public Boolean getReadTableSpaceName() {
return this.readTableSpaceName;
}
/**
*
* When set to true, this attribute supports tablespace replication.
*
true, this attribute supports tablespace replication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withReadTableSpaceName(Boolean readTableSpaceName) {
setReadTableSpaceName(readTableSpaceName);
return this;
}
/**
*
* When set to true, this attribute supports tablespace replication.
*
true, this attribute supports tablespace replication.
*/
public Boolean isReadTableSpaceName() {
return this.readTableSpaceName;
}
/**
* * Specifies the number of seconds that the system waits before resending a query. *
*
* Example: retryInterval=6;
*
* Example: retryInterval=6;
*/
public void setRetryInterval(Integer retryInterval) {
this.retryInterval = retryInterval;
}
/**
*
* Specifies the number of seconds that the system waits before resending a query. *
*
* Example: retryInterval=6;
*
* Example: retryInterval=6;
*/
public Integer getRetryInterval() {
return this.retryInterval;
}
/**
*
* Specifies the number of seconds that the system waits before resending a query. *
*
* Example: retryInterval=6;
*
* Example: retryInterval=6;
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withRetryInterval(Integer retryInterval) {
setRetryInterval(retryInterval);
return this;
}
/**
*
* For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access
* Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of
* the comma-separated value you set to the Password request parameter when you create the endpoint.
* The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting.
* For more information, see
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
TDE_Password part of the comma-separated value you set to the Password
* request parameter when you create the endpoint. The SecurityDbEncryptian setting is related
* to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration
* Service User Guide.
*/
public void setSecurityDbEncryption(String securityDbEncryption) {
this.securityDbEncryption = securityDbEncryption;
}
/**
*
* For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access
* Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of
* the comma-separated value you set to the Password request parameter when you create the endpoint.
* The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting.
* For more information, see
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
TDE_Password part of the comma-separated value you set to the Password
* request parameter when you create the endpoint. The SecurityDbEncryptian setting is related
* to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration
* Service User Guide.
*/
public String getSecurityDbEncryption() {
return this.securityDbEncryption;
}
/**
*
* For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access
* Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of
* the comma-separated value you set to the Password request parameter when you create the endpoint.
* The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting.
* For more information, see
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
TDE_Password part of the comma-separated value you set to the Password
* request parameter when you create the endpoint. The SecurityDbEncryptian setting is related
* to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration
* Service User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withSecurityDbEncryption(String securityDbEncryption) {
setSecurityDbEncryption(securityDbEncryption);
return this;
}
/**
*
* For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns
* and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the
* SecurityDbEncryption setting. For more information on setting the key name value of
* SecurityDbEncryptionName, see the information and example for setting the
* securityDbEncryptionName extra connection attribute in
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
SecurityDbEncryption setting. For more information on setting the key name value
* of SecurityDbEncryptionName, see the information and example for setting the
* securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration
* Service User Guide.
*/
public void setSecurityDbEncryptionName(String securityDbEncryptionName) {
this.securityDbEncryptionName = securityDbEncryptionName;
}
/**
*
* For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns
* and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the
* SecurityDbEncryption setting. For more information on setting the key name value of
* SecurityDbEncryptionName, see the information and example for setting the
* securityDbEncryptionName extra connection attribute in
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
SecurityDbEncryption setting. For more information on setting the key name
* value of SecurityDbEncryptionName, see the information and example for setting the
* securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration
* Service User Guide.
*/
public String getSecurityDbEncryptionName() {
return this.securityDbEncryptionName;
}
/**
*
* For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns
* and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the
* SecurityDbEncryption setting. For more information on setting the key name value of
* SecurityDbEncryptionName, see the information and example for setting the
* securityDbEncryptionName extra connection attribute in
* Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
* Guide.
*
SecurityDbEncryption setting. For more information on setting the key name value
* of SecurityDbEncryptionName, see the information and example for setting the
* securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration
* Service User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withSecurityDbEncryptionName(String securityDbEncryptionName) {
setSecurityDbEncryptionName(securityDbEncryptionName);
return this;
}
/**
* * Fully qualified domain name of the endpoint. *
*
* For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
* Endpoint.Address
* field.
*
* For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
* Endpoint.Address
* field.
*/
public void setServerName(String serverName) {
this.serverName = serverName;
}
/**
*
* Fully qualified domain name of the endpoint. *
*
* For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
* Endpoint.Address
* field.
*
* For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
* Endpoint.Address
* field.
*/
public String getServerName() {
return this.serverName;
}
/**
*
* Fully qualified domain name of the endpoint. *
*
* For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
* Endpoint.Address
* field.
*
* For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
* Endpoint.Address
* field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withServerName(String serverName) {
setServerName(serverName);
return this;
}
/**
*
* Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the
* SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function
* that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName
* to call it instead.
*
SDO_GEOMETRY to GEOJSON format. By default, DMS
* calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own
* custom function that mimics the operation of SDOGEOJSON and set
* SpatialDataOptionToGeoJsonFunctionName to call it instead.
*/
public void setSpatialDataOptionToGeoJsonFunctionName(String spatialDataOptionToGeoJsonFunctionName) {
this.spatialDataOptionToGeoJsonFunctionName = spatialDataOptionToGeoJsonFunctionName;
}
/**
*
* Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the
* SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function
* that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName
* to call it instead.
*
SDO_GEOMETRY to GEOJSON format. By default, DMS
* calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own
* custom function that mimics the operation of SDOGEOJSON and set
* SpatialDataOptionToGeoJsonFunctionName to call it instead.
*/
public String getSpatialDataOptionToGeoJsonFunctionName() {
return this.spatialDataOptionToGeoJsonFunctionName;
}
/**
*
* Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the
* SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function
* that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName
* to call it instead.
*
SDO_GEOMETRY to GEOJSON format. By default, DMS
* calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own
* custom function that mimics the operation of SDOGEOJSON and set
* SpatialDataOptionToGeoJsonFunctionName to call it instead.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withSpatialDataOptionToGeoJsonFunctionName(String spatialDataOptionToGeoJsonFunctionName) {
setSpatialDataOptionToGeoJsonFunctionName(spatialDataOptionToGeoJsonFunctionName);
return this;
}
/**
* * Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active * Data Guard standby database, use this attribute to specify the time lag between primary and standby databases. *
** In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for * replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in * production. *
* * @param standbyDelayTime * Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle * Active Data Guard standby database, use this attribute to specify the time lag between primary and standby * databases. ** In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for * replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be * in production. */ public void setStandbyDelayTime(Integer standbyDelayTime) { this.standbyDelayTime = standbyDelayTime; } /** *
* Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active * Data Guard standby database, use this attribute to specify the time lag between primary and standby databases. *
** In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for * replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in * production. *
* * @return Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle * Active Data Guard standby database, use this attribute to specify the time lag between primary and * standby databases. ** In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for * replicating ongoing changes. Doing this eliminates the need to connect to an active database that might * be in production. */ public Integer getStandbyDelayTime() { return this.standbyDelayTime; } /** *
* Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active * Data Guard standby database, use this attribute to specify the time lag between primary and standby databases. *
** In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for * replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in * production. *
* * @param standbyDelayTime * Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle * Active Data Guard standby database, use this attribute to specify the time lag between primary and standby * databases. ** In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for * replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be * in production. * @return Returns a reference to this object so that method calls can be chained together. */ public OracleSettings withStandbyDelayTime(Integer standbyDelayTime) { setStandbyDelayTime(standbyDelayTime); return this; } /** *
* Endpoint connection user name. *
* * @param username * Endpoint connection user name. */ public void setUsername(String username) { this.username = username; } /** ** Endpoint connection user name. *
* * @return Endpoint connection user name. */ public String getUsername() { return this.username; } /** ** Endpoint connection user name. *
* * @param username * Endpoint connection user name. * @return Returns a reference to this object so that method calls can be chained together. */ public OracleSettings withUsername(String username) { setUsername(username); return this; } /** *
* Set this attribute to Y to capture change data using the Binary Reader utility. Set
* UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle
* as the source, you set additional attributes. For more information about using this setting with Oracle Automatic
* Storage Management (ASM), see Using
* Oracle LogMiner or DMS Binary Reader for CDC.
*
UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for
* Oracle as the source, you set additional attributes. For more information about using this setting with
* Oracle Automatic Storage Management (ASM), see
* Using Oracle LogMiner or DMS Binary Reader for CDC.
*/
public void setUseBFile(Boolean useBFile) {
this.useBFile = useBFile;
}
/**
*
* Set this attribute to Y to capture change data using the Binary Reader utility. Set
* UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle
* as the source, you set additional attributes. For more information about using this setting with Oracle Automatic
* Storage Management (ASM), see Using
* Oracle LogMiner or DMS Binary Reader for CDC.
*
UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for
* Oracle as the source, you set additional attributes. For more information about using this setting with
* Oracle Automatic Storage Management (ASM), see
* Using Oracle LogMiner or DMS Binary Reader for CDC.
*/
public Boolean getUseBFile() {
return this.useBFile;
}
/**
*
* Set this attribute to Y to capture change data using the Binary Reader utility. Set
* UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle
* as the source, you set additional attributes. For more information about using this setting with Oracle Automatic
* Storage Management (ASM), see Using
* Oracle LogMiner or DMS Binary Reader for CDC.
*
UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for
* Oracle as the source, you set additional attributes. For more information about using this setting with
* Oracle Automatic Storage Management (ASM), see
* Using Oracle LogMiner or DMS Binary Reader for CDC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withUseBFile(Boolean useBFile) {
setUseBFile(useBFile);
return this;
}
/**
*
* Set this attribute to Y to capture change data using the Binary Reader utility. Set
* UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle
* as the source, you set additional attributes. For more information about using this setting with Oracle Automatic
* Storage Management (ASM), see Using
* Oracle LogMiner or DMS Binary Reader for CDC.
*
UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for
* Oracle as the source, you set additional attributes. For more information about using this setting with
* Oracle Automatic Storage Management (ASM), see
* Using Oracle LogMiner or DMS Binary Reader for CDC.
*/
public Boolean isUseBFile() {
return this.useBFile;
}
/**
* * Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path * protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables * during a full load. *
* * @param useDirectPathFullLoad * Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path * protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target * tables during a full load. */ public void setUseDirectPathFullLoad(Boolean useDirectPathFullLoad) { this.useDirectPathFullLoad = useDirectPathFullLoad; } /** ** Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path * protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables * during a full load. *
* * @return Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct * path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle * target tables during a full load. */ public Boolean getUseDirectPathFullLoad() { return this.useDirectPathFullLoad; } /** ** Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path * protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables * during a full load. *
* * @param useDirectPathFullLoad * Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path * protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target * tables during a full load. * @return Returns a reference to this object so that method calls can be chained together. */ public OracleSettings withUseDirectPathFullLoad(Boolean useDirectPathFullLoad) { setUseDirectPathFullLoad(useDirectPathFullLoad); return this; } /** ** Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path * protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables * during a full load. *
* * @return Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct * path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle * target tables during a full load. */ public Boolean isUseDirectPathFullLoad() { return this.useDirectPathFullLoad; } /** *
* Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this
* attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader
* to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using
* Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*
UseLogminerReader to N, also set UseBfile to Y. For more information on this
* setting and using Oracle ASM, see
* Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*/
public void setUseLogminerReader(Boolean useLogminerReader) {
this.useLogminerReader = useLogminerReader;
}
/**
*
* Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this
* attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader
* to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using
* Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*
UseLogminerReader to N, also set UseBfile to Y. For more information on this
* setting and using Oracle ASM, see
* Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*/
public Boolean getUseLogminerReader() {
return this.useLogminerReader;
}
/**
*
* Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this
* attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader
* to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using
* Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*
UseLogminerReader to N, also set UseBfile to Y. For more information on this
* setting and using Oracle ASM, see
* Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withUseLogminerReader(Boolean useLogminerReader) {
setUseLogminerReader(useLogminerReader);
return this;
}
/**
*
* Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this
* attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader
* to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using
* Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*
UseLogminerReader to N, also set UseBfile to Y. For more information on this
* setting and using Oracle ASM, see
* Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
*/
public Boolean isUseLogminerReader() {
return this.useLogminerReader;
}
/**
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret. The role must allow the
* iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Oracle endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId. Or you can specify clear-text values for UserName,
* Password, ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerSecret. The role must allow the
* iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the Oracle endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerSecretId. Or you can specify clear-text values for
* UserName, Password, ServerName, and Port. You can't
* specify both. For more information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
* see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret. The role must allow the
* iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Oracle endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId. Or you can specify clear-text values for UserName,
* Password, ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerSecret. The role must allow
* the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the Oracle endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerSecretId. Or you can specify clear-text values for
* UserName, Password, ServerName, and Port. You can't
* specify both. For more information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
* see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret. The role must allow the
* iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Oracle endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId. Or you can specify clear-text values for UserName,
* Password, ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerSecret. The role must allow the
* iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the Oracle endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerSecretId. Or you can specify clear-text values for
* UserName, Password, ServerName, and Port. You can't
* specify both. For more information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
* see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle
* endpoint connection details.
*
SecretsManagerSecret that contains the
* Oracle endpoint connection details.
*/
public void setSecretsManagerSecretId(String secretsManagerSecretId) {
this.secretsManagerSecretId = secretsManagerSecretId;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle
* endpoint connection details.
*
SecretsManagerSecret that contains the
* Oracle endpoint connection details.
*/
public String getSecretsManagerSecretId() {
return this.secretsManagerSecretId;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle
* endpoint connection details.
*
SecretsManagerSecret that contains the
* Oracle endpoint connection details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withSecretsManagerSecretId(String secretsManagerSecretId) {
setSecretsManagerSecretId(secretsManagerSecretId);
return this;
}
/**
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that
* specifies DMS as the trusted entity and grants the required permissions to access the
* SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value
* that allows access to the Oracle ASM of the endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName,
* AsmPassword, and AsmServerName. You can't specify both. For more information on
* creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to
* access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret
* value that allows access to the Oracle ASM of the endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for
* AsmUserName, AsmPassword, and AsmServerName. You can't specify
* both. For more information on creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId
* required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that
* specifies DMS as the trusted entity and grants the required permissions to access the
* SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value
* that allows access to the Oracle ASM of the endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName,
* AsmPassword, and AsmServerName. You can't specify both. For more information on
* creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to
* access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the
* secret value that allows access to the Oracle ASM of the endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for
* AsmUserName, AsmPassword, and AsmServerName. You can't specify
* both. For more information on creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId
* required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that
* specifies DMS as the trusted entity and grants the required permissions to access the
* SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value
* that allows access to the Oracle ASM of the endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName,
* AsmPassword, and AsmServerName. You can't specify both. For more information on
* creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to
* access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret
* value that allows access to the Oracle ASM of the endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for
* AsmUserName, AsmPassword, and AsmServerName. You can't specify
* both. For more information on creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId
* required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or
* friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details
* for the Oracle endpoint.
*
SecretsManagerOracleAsmSecret that contains the Oracle ASM connection
* details for the Oracle endpoint.
*/
public void setSecretsManagerOracleAsmSecretId(String secretsManagerOracleAsmSecretId) {
this.secretsManagerOracleAsmSecretId = secretsManagerOracleAsmSecretId;
}
/**
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or
* friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details
* for the Oracle endpoint.
*
SecretsManagerOracleAsmSecret that contains the Oracle ASM
* connection details for the Oracle endpoint.
*/
public String getSecretsManagerOracleAsmSecretId() {
return this.secretsManagerOracleAsmSecretId;
}
/**
*
* Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or
* friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details
* for the Oracle endpoint.
*
SecretsManagerOracleAsmSecret that contains the Oracle ASM connection
* details for the Oracle endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withSecretsManagerOracleAsmSecretId(String secretsManagerOracleAsmSecretId) {
setSecretsManagerOracleAsmSecretId(secretsManagerOracleAsmSecretId);
return this;
}
/**
*
* Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is true.
*
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is true.
*/
public void setTrimSpaceInChar(Boolean trimSpaceInChar) {
this.trimSpaceInChar = trimSpaceInChar;
}
/**
*
* Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is true.
*
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is true.
*/
public Boolean getTrimSpaceInChar() {
return this.trimSpaceInChar;
}
/**
*
* Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is true.
*
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withTrimSpaceInChar(Boolean trimSpaceInChar) {
setTrimSpaceInChar(trimSpaceInChar);
return this;
}
/**
*
* Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is true.
*
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is true.
*/
public Boolean isTrimSpaceInChar() {
return this.trimSpaceInChar;
}
/**
*
* When true, converts timestamps with the timezone datatype to their UTC value.
*
timezone datatype to their UTC value.
*/
public void setConvertTimestampWithZoneToUTC(Boolean convertTimestampWithZoneToUTC) {
this.convertTimestampWithZoneToUTC = convertTimestampWithZoneToUTC;
}
/**
*
* When true, converts timestamps with the timezone datatype to their UTC value.
*
timezone datatype to their UTC value.
*/
public Boolean getConvertTimestampWithZoneToUTC() {
return this.convertTimestampWithZoneToUTC;
}
/**
*
* When true, converts timestamps with the timezone datatype to their UTC value.
*
timezone datatype to their UTC value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OracleSettings withConvertTimestampWithZoneToUTC(Boolean convertTimestampWithZoneToUTC) {
setConvertTimestampWithZoneToUTC(convertTimestampWithZoneToUTC);
return this;
}
/**
*
* When true, converts timestamps with the timezone datatype to their UTC value.
*
timezone datatype to their UTC value.
*/
public Boolean isConvertTimestampWithZoneToUTC() {
return this.convertTimestampWithZoneToUTC;
}
/**
* * The timeframe in minutes to check for open transactions for a CDC-only task. *
** You can specify an integer value between 0 (the default) and 240 (the maximum). *
*
* This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours including
* the value for OpenTransactionWindow.
*
* You can specify an integer value between 0 (the default) and 240 (the maximum). *
*
* This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours
* including the value for OpenTransactionWindow.
*
* The timeframe in minutes to check for open transactions for a CDC-only task. *
** You can specify an integer value between 0 (the default) and 240 (the maximum). *
*
* This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours including
* the value for OpenTransactionWindow.
*
* You can specify an integer value between 0 (the default) and 240 (the maximum). *
*
* This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours
* including the value for OpenTransactionWindow.
*
* The timeframe in minutes to check for open transactions for a CDC-only task. *
** You can specify an integer value between 0 (the default) and 240 (the maximum). *
*
* This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours including
* the value for OpenTransactionWindow.
*
* You can specify an integer value between 0 (the default) and 240 (the maximum). *
*
* This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours
* including the value for OpenTransactionWindow.
*