com.sas.cas.actions.fedSql

Class ExecDirectOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.fedSql.ExecDirectOptions

All Implemented Interfaces:

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

public class ExecDirectOptions
extends CASGeneratedActionOptions

Options for execDirect: Submits a SAS FedSQL language statement for immediate execution.

See Also:

Serialized Form

Nested Class Summary

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	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_METHOD
static java.lang.String	KEY_QUERY
static java.lang.String	KEY_SHOWPLAN
static java.lang.String	KEY_VALIDATEONLY

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
ExecDirectOptions()
ExecDirectOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getMethod()
java.lang.String	getQuery()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getShowPlan()
java.lang.Boolean	getValidateOnly()
ExecDirectOptions	setMethod(java.lang.Boolean value) Sets the value of parameter 'method': when set to True, prints a brief description of the FedSQL query plan.
ExecDirectOptions	setQuery(java.lang.String value) Sets the value of parameter 'query': specifies a SAS FedSQL language statement.
ExecDirectOptions	setShowPlan(java.lang.Boolean value) Sets the value of parameter 'showPlan': when set to True, prints an XML tree representing the FedSQL query plan.
ExecDirectOptions	setValidateOnly(java.lang.Boolean value) Sets the value of parameter 'validateOnly': when set to True, validates the query syntax and returns without executing the query.

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

ACTION_SET_NAME

public static final java.lang.String ACTION_SET_NAME

See Also:

Constant Field Values

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

KEY_QUERY

public static final java.lang.String KEY_QUERY

See Also:

Constant Field Values

KEY_VALIDATEONLY

public static final java.lang.String KEY_VALIDATEONLY

See Also:

Constant Field Values

KEY_METHOD

public static final java.lang.String KEY_METHOD

See Also:

Constant Field Values

KEY_SHOWPLAN

public static final java.lang.String KEY_SHOWPLAN

See Also:

Constant Field Values

Constructor Detail

ExecDirectOptions

public ExecDirectOptions()

ExecDirectOptions

public ExecDirectOptions(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

getQuery

public java.lang.String getQuery()

setQuery

public ExecDirectOptions setQuery(java.lang.String value)

Sets the value of parameter 'query': specifies a SAS FedSQL language statement.

Parameters:

value - The value

Returns:

The options object

getValidateOnly

public java.lang.Boolean getValidateOnly()

setValidateOnly

public ExecDirectOptions setValidateOnly(java.lang.Boolean value)

Sets the value of parameter 'validateOnly': when set to True, validates the query syntax and returns without executing the query. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getMethod

public java.lang.Boolean getMethod()

setMethod

public ExecDirectOptions setMethod(java.lang.Boolean value)

Sets the value of parameter 'method': when set to True, prints a brief description of the FedSQL query plan. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getShowPlan

public java.lang.Boolean getShowPlan()

setShowPlan

public ExecDirectOptions setShowPlan(java.lang.Boolean value)

Sets the value of parameter 'showPlan': when set to True, prints an XML tree representing the FedSQL query plan. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object