OracleSettings (AWS Java SDK :: Services :: AWS Database Migration Service 2.21.12 API)

java.lang.Object
- software.amazon.awssdk.services.databasemigration.model.OracleSettings

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<OracleSettings.Builder,OracleSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class OracleSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OracleSettings.Builder,OracleSettings>

Provides information that defines an Oracle endpoint.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface OracleSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`OracleSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`accessAlternateDirectly()` 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.
`Integer`	`additionalArchivedLogDestId()` Set this attribute with `ArchivedLogDestId` in a primary/ standby setup.
`Boolean`	`addSupplementalLogging()` Set this attribute to set up table-level supplemental logging for the Oracle database.
`Boolean`	`allowSelectNestedTables()` Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types.
`Integer`	`archivedLogDestId()` Specifies the ID of the destination for the archived redo logs.
`Boolean`	`archivedLogsOnly()` When this field is set to `Y`, DMS only accesses the archived redo logs.
`String`	`asmPassword()` For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
`String`	`asmServer()` For an Oracle source endpoint, your ASM server address.
`String`	`asmUser()` For an Oracle source endpoint, your ASM user name.
`static OracleSettings.Builder`	`builder()`
`CharLengthSemantics`	`charLengthSemantics()` Specifies whether the length of a character column is in bytes or in characters.
`String`	`charLengthSemanticsAsString()` Specifies whether the length of a character column is in bytes or in characters.
`Boolean`	`convertTimestampWithZoneToUTC()` When true, converts timestamps with the `timezone` datatype to their UTC value.
`String`	`databaseName()` Database name for the endpoint.
`Boolean`	`directPathNoLog()` 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.
`Boolean`	`directPathParallelLoad()` When set to `true`, this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y`.
`Boolean`	`enableHomogenousTablespace()` Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Integer>`	`extraArchivedLogDestIds()` Specifies the IDs of one more destinations for one or more archived redo logs.
`Boolean`	`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`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExtraArchivedLogDestIds()` For responses, this returns true if the service returned a value for the ExtraArchivedLogDestIds property.
`int`	`hashCode()`
`Integer`	`numberDatatypeScale()` Specifies the number scale.
`Integer`	`openTransactionWindow()` The timeframe in minutes to check for open transactions for a CDC-only task.
`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.
`Integer`	`parallelAsmReadThreads()` 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).
`String`	`password()` Endpoint connection password.
`Integer`	`port()` Endpoint TCP port.
`Integer`	`readAheadBlocks()` 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).
`Boolean`	`readTableSpaceName()` When set to `true`, this attribute supports tablespace replication.
`Boolean`	`replacePathPrefix()` 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.
`Integer`	`retryInterval()` Specifies the number of seconds that the system waits before resending a query.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretsManagerAccessRoleArn()` 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`.
`String`	`secretsManagerOracleAsmAccessRoleArn()` Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
`String`	`secretsManagerOracleAsmSecretId()` Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
`String`	`secretsManagerSecretId()` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the Oracle endpoint connection details.
`String`	`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.
`String`	`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.
`static Class<? extends OracleSettings.Builder>`	`serializableBuilderClass()`
`String`	`serverName()` Fully qualified domain name of the endpoint.
`String`	`spatialDataOptionToGeoJsonFunctionName()` Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format.
`Integer`	`standbyDelayTime()` Use this attribute to specify a time in minutes for the delay in standby sync.
`OracleSettings.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`trimSpaceInChar()` Use the `TrimSpaceInChar` source endpoint setting to trim data on CHAR and NCHAR data types during migration.
`Boolean`	`useAlternateFolderForOnline()` 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.
`Boolean`	`useBFile()` Set this attribute to Y to capture change data using the Binary Reader utility.
`Boolean`	`useDirectPathFullLoad()` Set this attribute to Y to have DMS use a direct path full load.
`Boolean`	`useLogminerReader()` Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default).
`String`	`usePathPrefix()` 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.
`String`	`username()` Endpoint connection user name.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - addSupplementalLogging
```
public final Boolean 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.
    
    Returns:
    
    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.
  - archivedLogDestId
```
public final Integer 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.
    
    Returns:
    
    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
```
public final Integer 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.
    
    Returns:
    
    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.
  - hasExtraArchivedLogDestIds
```
public final boolean hasExtraArchivedLogDestIds()
```
    For responses, this returns true if the service returned a value for the ExtraArchivedLogDestIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - extraArchivedLogDestIds
```
public final List<Integer> extraArchivedLogDestIds()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExtraArchivedLogDestIds() method.
    
    Returns:
    
    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.
  - allowSelectNestedTables
```
public final Boolean allowSelectNestedTables()
```
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    
    Returns:
    
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
  - parallelAsmReadThreads
```
public final Integer parallelAsmReadThreads()
```
    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.
    
    Returns:
    
    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.
  - readAheadBlocks
```
public final Integer readAheadBlocks()
```
    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).
    
    Returns:
    
    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).
  - accessAlternateDirectly
```
public final Boolean accessAlternateDirectly()
```
    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.
    
    Returns:
    
    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.
  - useAlternateFolderForOnline
```
public final Boolean useAlternateFolderForOnline()
```
    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.
    
    Returns:
    
    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.
  - oraclePathPrefix
```
public final 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 default Oracle root used to access the redo logs.
    
    Returns:
    
    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.
  - usePathPrefix
```
public final String usePathPrefix()
```
    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.
    
    Returns:
    
    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.
  - replacePathPrefix
```
public final Boolean replacePathPrefix()
```
    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.
    
    Returns:
    
    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.
  - enableHomogenousTablespace
```
public final Boolean enableHomogenousTablespace()
```
    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
    
    Returns:
    
    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
  - directPathNoLog
```
public final Boolean directPathNoLog()
```
    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.
    
    Returns:
    
    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.
  - archivedLogsOnly
```
public final Boolean archivedLogsOnly()
```
    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.
    
    Returns:
    
    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.
  - asmPassword
```
public final String asmPassword()
```
    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.
    
    Returns:
    
    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.
  - asmServer
```
public final String asmServer()
```
    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.
    
    Returns:
    
    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.
  - asmUser
```
public final String asmUser()
```
    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.
    
    Returns:
    
    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.
  - charLengthSemantics
```
public final 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;
    
    If the service returns an enum value that is not available in the current SDK version, charLengthSemantics will return CharLengthSemantics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from charLengthSemanticsAsString().
    
    Returns:
    
    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;
    
    See Also:
    
    CharLengthSemantics
  - charLengthSemanticsAsString
```
public final String charLengthSemanticsAsString()
```
    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;
    
    If the service returns an enum value that is not available in the current SDK version, charLengthSemantics will return CharLengthSemantics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from charLengthSemanticsAsString().
    
    Returns:
    
    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;
    
    See Also:
    
    CharLengthSemantics
  - databaseName
```
public final String databaseName()
```
    Database name for the endpoint.
    
    Returns:
    
    Database name for the endpoint.
  - directPathParallelLoad
```
public final Boolean 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.
    
    Returns:
    
    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.
  - failTasksOnLobTruncation
```
public final Boolean 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.
    
    Returns:
    
    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.
  - numberDatatypeScale
```
public final Integer 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
    
    Returns:
    
    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
  - password
```
public final String password()
```
    Endpoint connection password.
    
    Returns:
    
    Endpoint connection password.
  - port
```
public final Integer port()
```
    Endpoint TCP port.
    
    Returns:
    
    Endpoint TCP port.
  - readTableSpaceName
```
public final Boolean readTableSpaceName()
```
    When set to true, this attribute supports tablespace replication.
    
    Returns:
    
    When set to true, this attribute supports tablespace replication.
  - retryInterval
```
public final Integer retryInterval()
```
    Specifies the number of seconds that the system waits before resending a query.
    
    Example: retryInterval=6;
    
    Returns:
    
    Specifies the number of seconds that the system waits before resending a query.
    
    Example: retryInterval=6;
  - securityDbEncryption
```
public final String 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.
    
    Returns:
    
    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.
  - securityDbEncryptionName
```
public final String 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.
    
    Returns:
    
    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.
  - serverName
```
public final String 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.
    
    Returns:
    
    Fully qualified domain name of the endpoint.
    
    For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
  - spatialDataOptionToGeoJsonFunctionName
```
public final String 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.
    
    Returns:
    
    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.
  - standbyDelayTime
```
public final Integer 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.
    
    Returns:
    
    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.
  - username
```
public final String username()
```
    Endpoint connection user name.
    
    Returns:
    
    Endpoint connection user name.
  - useBFile
```
public final Boolean 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.
    
    Returns:
    
    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.
  - useDirectPathFullLoad
```
public final Boolean 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.
    
    Returns:
    
    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.
  - useLogminerReader
```
public final Boolean 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.
    
    Returns:
    
    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.
  - secretsManagerAccessRoleArn
```
public final String secretsManagerAccessRoleArn()
```
    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.
    
    Returns:
    
    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.
  - secretsManagerSecretId
```
public final String secretsManagerSecretId()
```
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    
    Returns:
    
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
  - secretsManagerOracleAsmAccessRoleArn
```
public final String secretsManagerOracleAsmAccessRoleArn()
```
    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 AsmUser, 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.
    
    Returns:
    
    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 AsmUser, 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.
  - secretsManagerOracleAsmSecretId
```
public final String 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.
    
    Returns:
    
    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.
  - trimSpaceInChar
```
public final Boolean trimSpaceInChar()
```
    Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.
    
    Returns:
    
    Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.
  - convertTimestampWithZoneToUTC
```
public final Boolean convertTimestampWithZoneToUTC()
```
    When true, converts timestamps with the timezone datatype to their UTC value.
    
    Returns:
    
    When true, converts timestamps with the timezone datatype to their UTC value.
  - openTransactionWindow
```
public final Integer 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.
    
    Returns:
    
    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.
  - toBuilder
```
public OracleSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OracleSettings.Builder,OracleSettings>
  - builder
```
public static OracleSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OracleSettings.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class OracleSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

addSupplementalLogging

archivedLogDestId

additionalArchivedLogDestId

hasExtraArchivedLogDestIds

extraArchivedLogDestIds

allowSelectNestedTables

parallelAsmReadThreads

readAheadBlocks

accessAlternateDirectly

useAlternateFolderForOnline

oraclePathPrefix

usePathPrefix

replacePathPrefix

enableHomogenousTablespace

directPathNoLog

archivedLogsOnly

asmPassword

asmServer

asmUser

charLengthSemantics

charLengthSemanticsAsString

databaseName

directPathParallelLoad

failTasksOnLobTruncation

numberDatatypeScale

password

port

readTableSpaceName

retryInterval

securityDbEncryption

securityDbEncryptionName

serverName

spatialDataOptionToGeoJsonFunctionName

standbyDelayTime

username

useBFile

useDirectPathFullLoad

useLogminerReader

secretsManagerAccessRoleArn

secretsManagerSecretId

secretsManagerOracleAsmAccessRoleArn

secretsManagerOracleAsmSecretId

trimSpaceInChar

convertTimestampWithZoneToUTC

openTransactionWindow

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields