Package net.snowflake.client.core

Enum SFSessionProperty

java.lang.Object

java.lang.Enum<SFSessionProperty>

net.snowflake.client.core.SFSessionProperty

All Implemented Interfaces:

Serializable, Comparable<SFSessionProperty>

public enum SFSessionProperty
extends Enum<SFSessionProperty>

session properties accepted for opening a new session.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCOUNT
ALLOW_UNDERSCORES_IN_HOST
APP_ID
APP_VERSION
APPLICATION
AUTHENTICATOR
BROWSER_RESPONSE_TIMEOUT
CLEAR_BATCH_ONLY_AFTER_SUCCESSFUL_EXECUTION
CLIENT_CONFIG_FILE
CLIENT_INFO
CLIENT_OUT_OF_BAND_TELEMETRY_ENABLED
CLIENT_TREAT_TIME_AS_WALL_CLOCK_TIME
DATABASE
DIAGNOSTICS_ALLOWLIST_FILE
DISABLE_CONSOLE_LOGIN
DISABLE_GCS_DEFAULT_CREDENTIALS
DISABLE_OCSP_CHECKS
DISABLE_QUERY_CONTEXT_CACHE
DISABLE_SAML_URL_CHECK
DISABLE_SOCKS_PROXY
ENABLE_CLIENT_REQUEST_MFA_TOKEN
ENABLE_CLIENT_STORE_TEMPORARY_CREDENTIAL
ENABLE_DIAGNOSTICS
ENABLE_EXACT_SCHEMA_SEARCH_ENABLED
ENABLE_PATTERN_SEARCH
ENABLE_PUT_GET
ENABLE_WILDCARDS_IN_SHOW_METADATA_COMMANDS
GZIP_DISABLED
HTAP_OOB_TELEMETRY_ENABLED
HTTP_CLIENT_CONNECTION_TIMEOUT
HTTP_CLIENT_SOCKET_TIMEOUT
HTTP_HEADER_CUSTOMIZERS
ID_TOKEN_PASSWORD
IMPLICIT_SERVER_SIDE_QUERY_TIMEOUT
INJECT_CLIENT_PAUSE
INJECT_SOCKET_TIMEOUT
INJECT_WAIT_IN_PUT
INSECURE_MODE	Deprecated. Use DISABLE_OCSP_CHECKS for clarity.
JAVA_LOGGING_CONSOLE_STD_OUT
JAVA_LOGGING_CONSOLE_STD_OUT_THRESHOLD
JDBC_ARROW_TREAT_DECIMAL_AS_INT
JDBC_DEFAULT_FORMAT_DATE_WITH_TIMEZONE
JDBC_GET_DATE_USE_NULL_TIMEZONE
LOGIN_TIMEOUT
MAX_HTTP_RETRIES
MAX_TLS_VERSION
MIN_TLS_VERSION
NETWORK_TIMEOUT
NON_PROXY_HOSTS
OAUTH_AUTHORIZATION_URL
OAUTH_CLIENT_ID
OAUTH_CLIENT_SECRET
OAUTH_ENABLE_SINGLE_USE_REFRESH_TOKENS
OAUTH_REDIRECT_URI
OAUTH_SCOPE
OAUTH_TOKEN_REQUEST_URL
OCSP_FAIL_OPEN
OKTA_USERNAME
OWNER_ONLY_STAGE_FILE_PERMISSIONS_ENABLED
PASSCODE
PASSCODE_IN_PASSWORD
PASSWORD
PRIVATE_KEY
PRIVATE_KEY_BASE64
PRIVATE_KEY_FILE
PRIVATE_KEY_FILE_PWD	Deprecated. Use PRIVATE_KEY_PWD for clarity.
PRIVATE_KEY_PWD
PROXY_HOST
PROXY_PASSWORD
PROXY_PORT
PROXY_PROTOCOL
PROXY_USER
PUT_GET_MAX_RETRIES
QUERY_TIMEOUT
RETRY_TIMEOUT
ROLE
SCHEMA
SERVER_URL
STRINGS_QUOTED
TOKEN
TRACING
USE_PROXY
USER
USER_AGENT_SUFFIX
VALIDATE_DEFAULT_PARAMETERS
WAREHOUSE
WORKLOAD_IDENTITY_ENTRA_RESOURCE
WORKLOAD_IDENTITY_PROVIDER

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	APPLICATION_REGEX

Method Summary

Modifier and Type	Method	Description
String	getPropertyKey()
Class<?>	getValueType()
boolean	isRequired()
static SFSessionProperty	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SFSessionProperty[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SERVER_URL

public static final SFSessionProperty SERVER_URL

USER

public static final SFSessionProperty USER

PASSWORD

public static final SFSessionProperty PASSWORD

ACCOUNT

public static final SFSessionProperty ACCOUNT

DATABASE

public static final SFSessionProperty DATABASE

SCHEMA

public static final SFSessionProperty SCHEMA

PASSCODE_IN_PASSWORD

public static final SFSessionProperty PASSCODE_IN_PASSWORD

PASSCODE

public static final SFSessionProperty PASSCODE

TOKEN

public static final SFSessionProperty TOKEN

ID_TOKEN_PASSWORD

public static final SFSessionProperty ID_TOKEN_PASSWORD

ROLE

public static final SFSessionProperty ROLE

AUTHENTICATOR

public static final SFSessionProperty AUTHENTICATOR

OKTA_USERNAME

public static final SFSessionProperty OKTA_USERNAME

PRIVATE_KEY

public static final SFSessionProperty PRIVATE_KEY

OAUTH_REDIRECT_URI

public static final SFSessionProperty OAUTH_REDIRECT_URI

OAUTH_CLIENT_ID

public static final SFSessionProperty OAUTH_CLIENT_ID

OAUTH_CLIENT_SECRET

public static final SFSessionProperty OAUTH_CLIENT_SECRET

OAUTH_SCOPE

public static final SFSessionProperty OAUTH_SCOPE

OAUTH_AUTHORIZATION_URL

public static final SFSessionProperty OAUTH_AUTHORIZATION_URL

OAUTH_TOKEN_REQUEST_URL

public static final SFSessionProperty OAUTH_TOKEN_REQUEST_URL

OAUTH_ENABLE_SINGLE_USE_REFRESH_TOKENS

public static final SFSessionProperty OAUTH_ENABLE_SINGLE_USE_REFRESH_TOKENS

WORKLOAD_IDENTITY_PROVIDER

public static final SFSessionProperty WORKLOAD_IDENTITY_PROVIDER

WORKLOAD_IDENTITY_ENTRA_RESOURCE

public static final SFSessionProperty WORKLOAD_IDENTITY_ENTRA_RESOURCE

WAREHOUSE

public static final SFSessionProperty WAREHOUSE

LOGIN_TIMEOUT

public static final SFSessionProperty LOGIN_TIMEOUT

NETWORK_TIMEOUT

public static final SFSessionProperty NETWORK_TIMEOUT

INJECT_SOCKET_TIMEOUT

public static final SFSessionProperty INJECT_SOCKET_TIMEOUT

INJECT_CLIENT_PAUSE

public static final SFSessionProperty INJECT_CLIENT_PAUSE

APP_ID

public static final SFSessionProperty APP_ID

APP_VERSION

public static final SFSessionProperty APP_VERSION

OCSP_FAIL_OPEN

public static final SFSessionProperty OCSP_FAIL_OPEN

INSECURE_MODE

@Deprecated
public static final SFSessionProperty INSECURE_MODE

Deprecated.

Use DISABLE_OCSP_CHECKS for clarity. This configuration option is used to disable OCSP verification.

DISABLE_OCSP_CHECKS

public static final SFSessionProperty DISABLE_OCSP_CHECKS

QUERY_TIMEOUT

public static final SFSessionProperty QUERY_TIMEOUT

STRINGS_QUOTED

public static final SFSessionProperty STRINGS_QUOTED

APPLICATION

public static final SFSessionProperty APPLICATION

TRACING

public static final SFSessionProperty TRACING

DISABLE_SOCKS_PROXY

public static final SFSessionProperty DISABLE_SOCKS_PROXY

USE_PROXY

public static final SFSessionProperty USE_PROXY

PROXY_HOST

public static final SFSessionProperty PROXY_HOST

PROXY_PORT

public static final SFSessionProperty PROXY_PORT

PROXY_USER

public static final SFSessionProperty PROXY_USER

PROXY_PASSWORD

public static final SFSessionProperty PROXY_PASSWORD

NON_PROXY_HOSTS

public static final SFSessionProperty NON_PROXY_HOSTS

PROXY_PROTOCOL

public static final SFSessionProperty PROXY_PROTOCOL

VALIDATE_DEFAULT_PARAMETERS

public static final SFSessionProperty VALIDATE_DEFAULT_PARAMETERS

INJECT_WAIT_IN_PUT

public static final SFSessionProperty INJECT_WAIT_IN_PUT

PRIVATE_KEY_FILE

public static final SFSessionProperty PRIVATE_KEY_FILE

PRIVATE_KEY_BASE64

public static final SFSessionProperty PRIVATE_KEY_BASE64

PRIVATE_KEY_FILE_PWD

@Deprecated
public static final SFSessionProperty PRIVATE_KEY_FILE_PWD

Deprecated.

Use PRIVATE_KEY_PWD for clarity. The given password will be used to decrypt the private key value independent of whether that value is supplied as a file or base64 string

PRIVATE_KEY_PWD

public static final SFSessionProperty PRIVATE_KEY_PWD

CLIENT_INFO

public static final SFSessionProperty CLIENT_INFO

ALLOW_UNDERSCORES_IN_HOST

public static final SFSessionProperty ALLOW_UNDERSCORES_IN_HOST

USER_AGENT_SUFFIX

public static final SFSessionProperty USER_AGENT_SUFFIX

CLIENT_OUT_OF_BAND_TELEMETRY_ENABLED

public static final SFSessionProperty CLIENT_OUT_OF_BAND_TELEMETRY_ENABLED

GZIP_DISABLED

public static final SFSessionProperty GZIP_DISABLED

DISABLE_QUERY_CONTEXT_CACHE

public static final SFSessionProperty DISABLE_QUERY_CONTEXT_CACHE

HTAP_OOB_TELEMETRY_ENABLED

public static final SFSessionProperty HTAP_OOB_TELEMETRY_ENABLED

CLIENT_CONFIG_FILE

public static final SFSessionProperty CLIENT_CONFIG_FILE

MAX_HTTP_RETRIES

public static final SFSessionProperty MAX_HTTP_RETRIES

ENABLE_PUT_GET

public static final SFSessionProperty ENABLE_PUT_GET

DISABLE_CONSOLE_LOGIN

public static final SFSessionProperty DISABLE_CONSOLE_LOGIN

PUT_GET_MAX_RETRIES

public static final SFSessionProperty PUT_GET_MAX_RETRIES

RETRY_TIMEOUT

public static final SFSessionProperty RETRY_TIMEOUT

ENABLE_DIAGNOSTICS

public static final SFSessionProperty ENABLE_DIAGNOSTICS

DIAGNOSTICS_ALLOWLIST_FILE

public static final SFSessionProperty DIAGNOSTICS_ALLOWLIST_FILE

ENABLE_PATTERN_SEARCH

public static final SFSessionProperty ENABLE_PATTERN_SEARCH

ENABLE_EXACT_SCHEMA_SEARCH_ENABLED

public static final SFSessionProperty ENABLE_EXACT_SCHEMA_SEARCH_ENABLED

DISABLE_GCS_DEFAULT_CREDENTIALS

public static final SFSessionProperty DISABLE_GCS_DEFAULT_CREDENTIALS

JDBC_ARROW_TREAT_DECIMAL_AS_INT

public static final SFSessionProperty JDBC_ARROW_TREAT_DECIMAL_AS_INT

DISABLE_SAML_URL_CHECK

public static final SFSessionProperty DISABLE_SAML_URL_CHECK

JDBC_DEFAULT_FORMAT_DATE_WITH_TIMEZONE

public static final SFSessionProperty JDBC_DEFAULT_FORMAT_DATE_WITH_TIMEZONE

JDBC_GET_DATE_USE_NULL_TIMEZONE

public static final SFSessionProperty JDBC_GET_DATE_USE_NULL_TIMEZONE

BROWSER_RESPONSE_TIMEOUT

public static final SFSessionProperty BROWSER_RESPONSE_TIMEOUT

ENABLE_CLIENT_STORE_TEMPORARY_CREDENTIAL

public static final SFSessionProperty ENABLE_CLIENT_STORE_TEMPORARY_CREDENTIAL

ENABLE_CLIENT_REQUEST_MFA_TOKEN

public static final SFSessionProperty ENABLE_CLIENT_REQUEST_MFA_TOKEN

HTTP_CLIENT_CONNECTION_TIMEOUT

public static final SFSessionProperty HTTP_CLIENT_CONNECTION_TIMEOUT

HTTP_CLIENT_SOCKET_TIMEOUT

public static final SFSessionProperty HTTP_CLIENT_SOCKET_TIMEOUT

JAVA_LOGGING_CONSOLE_STD_OUT

public static final SFSessionProperty JAVA_LOGGING_CONSOLE_STD_OUT

JAVA_LOGGING_CONSOLE_STD_OUT_THRESHOLD

public static final SFSessionProperty JAVA_LOGGING_CONSOLE_STD_OUT_THRESHOLD

IMPLICIT_SERVER_SIDE_QUERY_TIMEOUT

public static final SFSessionProperty IMPLICIT_SERVER_SIDE_QUERY_TIMEOUT

CLEAR_BATCH_ONLY_AFTER_SUCCESSFUL_EXECUTION

public static final SFSessionProperty CLEAR_BATCH_ONLY_AFTER_SUCCESSFUL_EXECUTION

CLIENT_TREAT_TIME_AS_WALL_CLOCK_TIME

public static final SFSessionProperty CLIENT_TREAT_TIME_AS_WALL_CLOCK_TIME

HTTP_HEADER_CUSTOMIZERS

public static final SFSessionProperty HTTP_HEADER_CUSTOMIZERS

OWNER_ONLY_STAGE_FILE_PERMISSIONS_ENABLED

public static final SFSessionProperty OWNER_ONLY_STAGE_FILE_PERMISSIONS_ENABLED

ENABLE_WILDCARDS_IN_SHOW_METADATA_COMMANDS

public static final SFSessionProperty ENABLE_WILDCARDS_IN_SHOW_METADATA_COMMANDS

MIN_TLS_VERSION

public static final SFSessionProperty MIN_TLS_VERSION

MAX_TLS_VERSION

public static final SFSessionProperty MAX_TLS_VERSION

Field Detail

APPLICATION_REGEX

public static Pattern APPLICATION_REGEX

Method Detail

values

public static SFSessionProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SFSessionProperty c : SFSessionProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SFSessionProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isRequired

public boolean isRequired()

getPropertyKey

public String getPropertyKey()

getValueType

public Class<?> getValueType()