com.sas.cas.actions

Class Dsdb2

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.Dsdb2

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class Dsdb2
extends CASGeneratedActionOptions

Options for dsdb2.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dsdb2.SRCTYPE

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_AUTHENTICATIONDOMAIN
static java.lang.String	KEY_CATALOG
static java.lang.String	KEY_CHARMULTIPLIER
static java.lang.String	KEY_CLIENT_ENCODING
static java.lang.String	KEY_CONOPTS
static java.lang.String	KEY_DB
static java.lang.String	KEY_PWD
static java.lang.String	KEY_READBUFF
static java.lang.String	KEY_SCHEMA
static java.lang.String	KEY_SRCTYPE
static java.lang.String	KEY_UID

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
Dsdb2()
Dsdb2(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthDomain()
java.lang.String	getAuthenticationDomain()
java.lang.String	getCatalog()
java.lang.Double	getCharMultiplier()
java.lang.String	getClient_encoding()
java.lang.String	getConopts()
java.lang.String	getDatabase()
java.lang.String	getDb()
java.lang.String	getPass()
java.lang.String	getPassword()
java.lang.String	getPwd()
java.lang.Integer	getRas()
java.lang.Integer	getReadbuff()
java.lang.Integer	getRow_array_size()
java.lang.String	getSchema()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Dsdb2.SRCTYPE	getSrcType()
java.lang.String	getUid()
java.lang.String	getUser()
java.lang.String	getUsername()
Dsdb2	setAuthDomain(java.lang.String value)
Dsdb2	setAuthenticationDomain(java.lang.String value) Sets the value of parameter 'authenticationDomain': specifies the authentication domain that is used to retrieve database credentials.
Dsdb2	setCatalog(java.lang.String value) Sets the value of parameter 'catalog': specifies the database catalog name.
Dsdb2	setCharMultiplier(java.lang.Double value) Sets the value of parameter 'charMultiplier': specifies a multiplier value to expand fixed-width character variables that might require transcoding.
Dsdb2	setClient_encoding(java.lang.String value) Sets the value of parameter 'client_encoding'.
Dsdb2	setConopts(java.lang.String value) Sets the value of parameter 'conopts': specifies connection options to use for connecting to the Teradata database.
Dsdb2	setDatabase(java.lang.String value)
Dsdb2	setDb(java.lang.String value) Sets the value of parameter 'db'.
Dsdb2	setPass(java.lang.String value)
Dsdb2	setPassword(java.lang.String value)
Dsdb2	setPwd(java.lang.String value) Sets the value of parameter 'pwd'.
Dsdb2	setRas(java.lang.Integer value)
Dsdb2	setReadbuff(java.lang.Integer value) Sets the value of parameter 'readbuff': specifies the row array size to use for reading tables.
Dsdb2	setRow_array_size(java.lang.Integer value)
Dsdb2	setSchema(java.lang.String value) Sets the value of parameter 'schema'.
Dsdb2	setSrcType(Dsdb2.SRCTYPE value) Sets the value of parameter 'srcType'.
Dsdb2	setUid(java.lang.String value) Sets the value of parameter 'uid'.
Dsdb2	setUser(java.lang.String value)
Dsdb2	setUsername(java.lang.String value)

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

KEY_UID

public static final java.lang.String KEY_UID

See Also:

Constant Field Values

KEY_PWD

public static final java.lang.String KEY_PWD

See Also:

Constant Field Values

KEY_AUTHENTICATIONDOMAIN

public static final java.lang.String KEY_AUTHENTICATIONDOMAIN

See Also:

Constant Field Values

KEY_CATALOG

public static final java.lang.String KEY_CATALOG

See Also:

Constant Field Values

KEY_CONOPTS

public static final java.lang.String KEY_CONOPTS

See Also:

Constant Field Values

KEY_READBUFF

public static final java.lang.String KEY_READBUFF

See Also:

Constant Field Values

KEY_CHARMULTIPLIER

public static final java.lang.String KEY_CHARMULTIPLIER

See Also:

Constant Field Values

KEY_SRCTYPE

public static final java.lang.String KEY_SRCTYPE

See Also:

Constant Field Values

KEY_DB

public static final java.lang.String KEY_DB

See Also:

Constant Field Values

KEY_CLIENT_ENCODING

public static final java.lang.String KEY_CLIENT_ENCODING

See Also:

Constant Field Values

KEY_SCHEMA

public static final java.lang.String KEY_SCHEMA

See Also:

Constant Field Values

Constructor Detail

Dsdb2

public Dsdb2()

Dsdb2

public Dsdb2(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getUid

public java.lang.String getUid()

getUser

public java.lang.String getUser()

getUsername

public java.lang.String getUsername()

setUid

public Dsdb2 setUid(java.lang.String value)

Sets the value of parameter 'uid'.

Parameters:

value - The value

Returns:

The options object

setUser

public Dsdb2 setUser(java.lang.String value)

setUsername

public Dsdb2 setUsername(java.lang.String value)

getPwd

public java.lang.String getPwd()

getPassword

public java.lang.String getPassword()

getPass

public java.lang.String getPass()

setPwd

public Dsdb2 setPwd(java.lang.String value)

Sets the value of parameter 'pwd'.

Parameters:

value - The value

Returns:

The options object

setPassword

public Dsdb2 setPassword(java.lang.String value)

setPass

public Dsdb2 setPass(java.lang.String value)

getAuthenticationDomain

public java.lang.String getAuthenticationDomain()

getAuthDomain

public java.lang.String getAuthDomain()

setAuthenticationDomain

public Dsdb2 setAuthenticationDomain(java.lang.String value)

Sets the value of parameter 'authenticationDomain': specifies the authentication domain that is used to retrieve database credentials.

Parameters:

value - The value

Returns:

The options object

setAuthDomain

public Dsdb2 setAuthDomain(java.lang.String value)

getCatalog

public java.lang.String getCatalog()

setCatalog

public Dsdb2 setCatalog(java.lang.String value)

Sets the value of parameter 'catalog': specifies the database catalog name.

Parameters:

value - The value

Returns:

The options object

getConopts

public java.lang.String getConopts()

setConopts

public Dsdb2 setConopts(java.lang.String value)

Sets the value of parameter 'conopts': specifies connection options to use for connecting to the Teradata database.

Parameters:

value - The value

Returns:

The options object

getReadbuff

public java.lang.Integer getReadbuff()

getRas

public java.lang.Integer getRas()

getRow_array_size

public java.lang.Integer getRow_array_size()

setReadbuff

public Dsdb2 setReadbuff(java.lang.Integer value)

Sets the value of parameter 'readbuff': specifies the row array size to use for reading tables. The value is measured in bytes.

Parameters:

value - The value

Returns:

The options object

setRas

public Dsdb2 setRas(java.lang.Integer value)

setRow_array_size

public Dsdb2 setRow_array_size(java.lang.Integer value)

getCharMultiplier

public java.lang.Double getCharMultiplier()

setCharMultiplier

public Dsdb2 setCharMultiplier(java.lang.Double value)

Sets the value of parameter 'charMultiplier': specifies a multiplier value to expand fixed-width character variables that might require transcoding. SAS expands the lengths to avoid character data truncation. The lengths are increased by multiplying the length by the specified value. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getSrcType

public Dsdb2.SRCTYPE getSrcType()

setSrcType

public Dsdb2 setSrcType(Dsdb2.SRCTYPE value)

Sets the value of parameter 'srcType'. The server default is SRCTYPE.DB2.

Parameters:

value - The value

Returns:

The options object

getDb

public java.lang.String getDb()

getDatabase

public java.lang.String getDatabase()

setDb

public Dsdb2 setDb(java.lang.String value)

Sets the value of parameter 'db'.

Parameters:

value - The value

Returns:

The options object

setDatabase

public Dsdb2 setDatabase(java.lang.String value)

getClient_encoding

public java.lang.String getClient_encoding()

setClient_encoding

public Dsdb2 setClient_encoding(java.lang.String value)

Sets the value of parameter 'client_encoding'.

Parameters:

value - The value

Returns:

The options object

getSchema

public java.lang.String getSchema()

setSchema

public Dsdb2 setSchema(java.lang.String value)

Sets the value of parameter 'schema'.

Parameters:

value - The value

Returns:

The options object