Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.snowflake.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.snowflake.inputs.UserParameterArgs;
import com.pulumi.snowflake.inputs.UserShowOutputArgs;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class UserState extends com.pulumi.resources.ResourceArgs {
public static final UserState Empty = new UserState();
/**
* Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check [ABORT*DETACHED*QUERY docs](https://docs.snowflake.com/en/sql-reference/parameters#abort-detached-query).
*
*/
@Import(name="abortDetachedQuery")
private @Nullable Output abortDetachedQuery;
/**
* @return Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check [ABORT*DETACHED*QUERY docs](https://docs.snowflake.com/en/sql-reference/parameters#abort-detached-query).
*
*/
public Optional> abortDetachedQuery() {
return Optional.ofNullable(this.abortDetachedQuery);
}
/**
* Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see [Transactions](https://docs.snowflake.com/en/sql-reference/transactions). For more information, check [AUTOCOMMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#autocommit).
*
*/
@Import(name="autocommit")
private @Nullable Output autocommit;
/**
* @return Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see [Transactions](https://docs.snowflake.com/en/sql-reference/transactions). For more information, check [AUTOCOMMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#autocommit).
*
*/
public Optional> autocommit() {
return Optional.ofNullable(this.autocommit);
}
/**
* The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-input-format).
*
*/
@Import(name="binaryInputFormat")
private @Nullable Output binaryInputFormat;
/**
* @return The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-input-format).
*
*/
public Optional> binaryInputFormat() {
return Optional.ofNullable(this.binaryInputFormat);
}
/**
* The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-output-format).
*
*/
@Import(name="binaryOutputFormat")
private @Nullable Output binaryOutputFormat;
/**
* @return The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-output-format).
*
*/
public Optional> binaryOutputFormat() {
return Optional.ofNullable(this.binaryOutputFormat);
}
/**
* Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check [CLIENT*MEMORY*LIMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#client-memory-limit).
*
*/
@Import(name="clientMemoryLimit")
private @Nullable Output clientMemoryLimit;
/**
* @return Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check [CLIENT*MEMORY*LIMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#client-memory-limit).
*
*/
public Optional> clientMemoryLimit() {
return Optional.ofNullable(this.clientMemoryLimit);
}
/**
* For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check [CLIENT*METADATA*REQUEST*USE*CONNECTION_CTX docs](https://docs.snowflake.com/en/sql-reference/parameters#client-metadata-request-use-connection-ctx).
*
*/
@Import(name="clientMetadataRequestUseConnectionCtx")
private @Nullable Output clientMetadataRequestUseConnectionCtx;
/**
* @return For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check [CLIENT*METADATA*REQUEST*USE*CONNECTION_CTX docs](https://docs.snowflake.com/en/sql-reference/parameters#client-metadata-request-use-connection-ctx).
*
*/
public Optional> clientMetadataRequestUseConnectionCtx() {
return Optional.ofNullable(this.clientMetadataRequestUseConnectionCtx);
}
/**
* Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check [CLIENT*PREFETCH*THREADS docs](https://docs.snowflake.com/en/sql-reference/parameters#client-prefetch-threads).
*
*/
@Import(name="clientPrefetchThreads")
private @Nullable Output clientPrefetchThreads;
/**
* @return Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check [CLIENT*PREFETCH*THREADS docs](https://docs.snowflake.com/en/sql-reference/parameters#client-prefetch-threads).
*
*/
public Optional> clientPrefetchThreads() {
return Optional.ofNullable(this.clientPrefetchThreads);
}
/**
* Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check [CLIENT*RESULT*CHUNK_SIZE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-chunk-size).
*
*/
@Import(name="clientResultChunkSize")
private @Nullable Output clientResultChunkSize;
/**
* @return Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check [CLIENT*RESULT*CHUNK_SIZE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-chunk-size).
*
*/
public Optional> clientResultChunkSize() {
return Optional.ofNullable(this.clientResultChunkSize);
}
/**
* Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check [CLIENT*RESULT*COLUMN*CASE*INSENSITIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-column-case-insensitive).
*
*/
@Import(name="clientResultColumnCaseInsensitive")
private @Nullable Output clientResultColumnCaseInsensitive;
/**
* @return Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check [CLIENT*RESULT*COLUMN*CASE*INSENSITIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-column-case-insensitive).
*
*/
public Optional> clientResultColumnCaseInsensitive() {
return Optional.ofNullable(this.clientResultColumnCaseInsensitive);
}
/**
* Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check [CLIENT*SESSION*KEEP_ALIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive).
*
*/
@Import(name="clientSessionKeepAlive")
private @Nullable Output clientSessionKeepAlive;
/**
* @return Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check [CLIENT*SESSION*KEEP_ALIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive).
*
*/
public Optional> clientSessionKeepAlive() {
return Optional.ofNullable(this.clientSessionKeepAlive);
}
/**
* Number of seconds in-between client attempts to update the token for the session. For more information, check [CLIENT*SESSION*KEEP*ALIVE*HEARTBEAT_FREQUENCY docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive-heartbeat-frequency).
*
*/
@Import(name="clientSessionKeepAliveHeartbeatFrequency")
private @Nullable Output clientSessionKeepAliveHeartbeatFrequency;
/**
* @return Number of seconds in-between client attempts to update the token for the session. For more information, check [CLIENT*SESSION*KEEP*ALIVE*HEARTBEAT_FREQUENCY docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive-heartbeat-frequency).
*
*/
public Optional> clientSessionKeepAliveHeartbeatFrequency() {
return Optional.ofNullable(this.clientSessionKeepAliveHeartbeatFrequency);
}
/**
* Specifies the [TIMESTAMP_* variation](https://docs.snowflake.com/en/sql-reference/data-types-datetime.html#label-datatypes-timestamp-variations) to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check [CLIENT*TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#client-timestamp-type-mapping).
*
*/
@Import(name="clientTimestampTypeMapping")
private @Nullable Output clientTimestampTypeMapping;
/**
* @return Specifies the [TIMESTAMP_* variation](https://docs.snowflake.com/en/sql-reference/data-types-datetime.html#label-datatypes-timestamp-variations) to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check [CLIENT*TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#client-timestamp-type-mapping).
*
*/
public Optional> clientTimestampTypeMapping() {
return Optional.ofNullable(this.clientTimestampTypeMapping);
}
/**
* Specifies a comment for the user.
*
*/
@Import(name="comment")
private @Nullable Output comment;
/**
* @return Specifies a comment for the user.
*
*/
public Optional> comment() {
return Optional.ofNullable(this.comment);
}
/**
* Specifies the input format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-input-format).
*
*/
@Import(name="dateInputFormat")
private @Nullable Output dateInputFormat;
/**
* @return Specifies the input format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-input-format).
*
*/
public Optional> dateInputFormat() {
return Optional.ofNullable(this.dateInputFormat);
}
/**
* Specifies the display format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-output-format).
*
*/
@Import(name="dateOutputFormat")
private @Nullable Output dateOutputFormat;
/**
* @return Specifies the display format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-output-format).
*
*/
public Optional> dateOutputFormat() {
return Optional.ofNullable(this.dateOutputFormat);
}
@Import(name="daysToExpiry")
private @Nullable Output daysToExpiry;
public Optional> daysToExpiry() {
return Optional.ofNullable(this.daysToExpiry);
}
/**
* Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
*
*/
@Import(name="defaultNamespace")
private @Nullable Output defaultNamespace;
/**
* @return Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
*
*/
public Optional> defaultNamespace() {
return Optional.ofNullable(this.defaultNamespace);
}
/**
* Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does **not** grant the role to the user. The role must be granted explicitly to the user using the [GRANT ROLE](https://docs.snowflake.com/en/sql-reference/sql/grant-role) command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
*
*/
@Import(name="defaultRole")
private @Nullable Output defaultRole;
/**
* @return Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does **not** grant the role to the user. The role must be granted explicitly to the user using the [GRANT ROLE](https://docs.snowflake.com/en/sql-reference/sql/grant-role) command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
*
*/
public Optional> defaultRole() {
return Optional.ofNullable(this.defaultRole);
}
/**
* Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): `DEFAULT` | `NONE` | `ALL`. More information can be found in [doc](https://docs.snowflake.com/en/sql-reference/sql/create-user#optional-object-properties-objectproperties).
*
*/
@Import(name="defaultSecondaryRolesOption")
private @Nullable Output defaultSecondaryRolesOption;
/**
* @return Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): `DEFAULT` | `NONE` | `ALL`. More information can be found in [doc](https://docs.snowflake.com/en/sql-reference/sql/create-user#optional-object-properties-objectproperties).
*
*/
public Optional> defaultSecondaryRolesOption() {
return Optional.ofNullable(this.defaultSecondaryRolesOption);
}
/**
* Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
*
*/
@Import(name="defaultWarehouse")
private @Nullable Output defaultWarehouse;
/**
* @return Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
*
*/
public Optional> defaultWarehouse() {
return Optional.ofNullable(this.defaultWarehouse);
}
@Import(name="disableMfa")
private @Nullable Output disableMfa;
public Optional> disableMfa() {
return Optional.ofNullable(this.disableMfa);
}
/**
* Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
*/
@Import(name="disabled")
private @Nullable Output disabled;
/**
* @return Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
*/
public Optional> disabled() {
return Optional.ofNullable(this.disabled);
}
/**
* Name displayed for the user in the Snowflake web interface.
*
*/
@Import(name="displayName")
private @Nullable Output displayName;
/**
* @return Name displayed for the user in the Snowflake web interface.
*
*/
public Optional> displayName() {
return Optional.ofNullable(this.displayName);
}
/**
* Email address for the user.
*
*/
@Import(name="email")
private @Nullable Output email;
/**
* @return Email address for the user.
*
*/
public Optional> email() {
return Optional.ofNullable(this.email);
}
/**
* Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check [ENABLE*UNLOAD*PHYSICAL*TYPE*OPTIMIZATION docs](https://docs.snowflake.com/en/sql-reference/parameters#enable-unload-physical-type-optimization).
*
*/
@Import(name="enableUnloadPhysicalTypeOptimization")
private @Nullable Output enableUnloadPhysicalTypeOptimization;
/**
* @return Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check [ENABLE*UNLOAD*PHYSICAL*TYPE*OPTIMIZATION docs](https://docs.snowflake.com/en/sql-reference/parameters#enable-unload-physical-type-optimization).
*
*/
public Optional> enableUnloadPhysicalTypeOptimization() {
return Optional.ofNullable(this.enableUnloadPhysicalTypeOptimization);
}
/**
* Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If `FALSE`, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLE*UNREDACTED*QUERY*SYNTAX*ERROR parameter. When using the ALTER USER command to set the parameter to `TRUE` for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check *UNREDACTED*QUERY*SYNTAX*ERROR docs[ENABLE](https://docs.snowflake.com/en/sql-reference/parameters#enable-unredacted-query-syntax-error).
*
*/
@Import(name="enableUnredactedQuerySyntaxError")
private @Nullable Output enableUnredactedQuerySyntaxError;
/**
* @return Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If `FALSE`, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLE*UNREDACTED*QUERY*SYNTAX*ERROR parameter. When using the ALTER USER command to set the parameter to `TRUE` for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check *UNREDACTED*QUERY*SYNTAX*ERROR docs[ENABLE](https://docs.snowflake.com/en/sql-reference/parameters#enable-unredacted-query-syntax-error).
*
*/
public Optional> enableUnredactedQuerySyntaxError() {
return Optional.ofNullable(this.enableUnredactedQuerySyntaxError);
}
/**
* Specifies whether to return an error when the [MERGE](https://docs.snowflake.com/en/sql-reference/sql/merge) command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_MERGE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-merge).
*
*/
@Import(name="errorOnNondeterministicMerge")
private @Nullable Output errorOnNondeterministicMerge;
/**
* @return Specifies whether to return an error when the [MERGE](https://docs.snowflake.com/en/sql-reference/sql/merge) command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_MERGE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-merge).
*
*/
public Optional> errorOnNondeterministicMerge() {
return Optional.ofNullable(this.errorOnNondeterministicMerge);
}
/**
* Specifies whether to return an error when the [UPDATE](https://docs.snowflake.com/en/sql-reference/sql/update) command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_UPDATE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-update).
*
*/
@Import(name="errorOnNondeterministicUpdate")
private @Nullable Output errorOnNondeterministicUpdate;
/**
* @return Specifies whether to return an error when the [UPDATE](https://docs.snowflake.com/en/sql-reference/sql/update) command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_UPDATE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-update).
*
*/
public Optional> errorOnNondeterministicUpdate() {
return Optional.ofNullable(this.errorOnNondeterministicUpdate);
}
/**
* First name of the user.
*
*/
@Import(name="firstName")
private @Nullable Output firstName;
/**
* @return First name of the user.
*
*/
public Optional> firstName() {
return Optional.ofNullable(this.firstName);
}
/**
* Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
*
*/
@Import(name="fullyQualifiedName")
private @Nullable Output fullyQualifiedName;
/**
* @return Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
*
*/
public Optional> fullyQualifiedName() {
return Optional.ofNullable(this.fullyQualifiedName);
}
/**
* Display format for [GEOGRAPHY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geography). For more information, check [GEOGRAPHY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geography-output-format).
*
*/
@Import(name="geographyOutputFormat")
private @Nullable Output geographyOutputFormat;
/**
* @return Display format for [GEOGRAPHY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geography). For more information, check [GEOGRAPHY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geography-output-format).
*
*/
public Optional> geographyOutputFormat() {
return Optional.ofNullable(this.geographyOutputFormat);
}
/**
* Display format for [GEOMETRY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geometry). For more information, check [GEOMETRY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geometry-output-format).
*
*/
@Import(name="geometryOutputFormat")
private @Nullable Output geometryOutputFormat;
/**
* @return Display format for [GEOMETRY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geometry). For more information, check [GEOMETRY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geometry-output-format).
*
*/
public Optional> geometryOutputFormat() {
return Optional.ofNullable(this.geometryOutputFormat);
}
/**
* Specifies how JDBC processes columns that have a scale of zero (0). For more information, check [JDBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-decimal-as-int).
*
*/
@Import(name="jdbcTreatDecimalAsInt")
private @Nullable Output jdbcTreatDecimalAsInt;
/**
* @return Specifies how JDBC processes columns that have a scale of zero (0). For more information, check [JDBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-decimal-as-int).
*
*/
public Optional> jdbcTreatDecimalAsInt() {
return Optional.ofNullable(this.jdbcTreatDecimalAsInt);
}
/**
* Specifies how JDBC processes TIMESTAMP*NTZ values. For more information, check *TREAT*TIMESTAMP*NTZ*AS*UTC docs[JDBC](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-timestamp-ntz-as-utc).
*
*/
@Import(name="jdbcTreatTimestampNtzAsUtc")
private @Nullable Output jdbcTreatTimestampNtzAsUtc;
/**
* @return Specifies how JDBC processes TIMESTAMP*NTZ values. For more information, check *TREAT*TIMESTAMP*NTZ*AS*UTC docs[JDBC](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-timestamp-ntz-as-utc).
*
*/
public Optional> jdbcTreatTimestampNtzAsUtc() {
return Optional.ofNullable(this.jdbcTreatTimestampNtzAsUtc);
}
/**
* Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the [TIMEZONE](https://docs.snowflake.com/en/sql-reference/parameters#label-timezone) parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check [JDBC*USE*SESSION_TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-use-session-timezone).
*
*/
@Import(name="jdbcUseSessionTimezone")
private @Nullable Output jdbcUseSessionTimezone;
/**
* @return Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the [TIMEZONE](https://docs.snowflake.com/en/sql-reference/parameters#label-timezone) parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check [JDBC*USE*SESSION_TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-use-session-timezone).
*
*/
public Optional> jdbcUseSessionTimezone() {
return Optional.ofNullable(this.jdbcUseSessionTimezone);
}
/**
* Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check [JSON_INDENT docs](https://docs.snowflake.com/en/sql-reference/parameters#json-indent).
*
*/
@Import(name="jsonIndent")
private @Nullable Output jsonIndent;
/**
* @return Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check [JSON_INDENT docs](https://docs.snowflake.com/en/sql-reference/parameters#json-indent).
*
*/
public Optional> jsonIndent() {
return Optional.ofNullable(this.jsonIndent);
}
/**
* Last name of the user.
*
*/
@Import(name="lastName")
private @Nullable Output lastName;
/**
* @return Last name of the user.
*
*/
public Optional> lastName() {
return Optional.ofNullable(this.lastName);
}
/**
* Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check [LOCK_TIMEOUT docs](https://docs.snowflake.com/en/sql-reference/parameters#lock-timeout).
*
*/
@Import(name="lockTimeout")
private @Nullable Output lockTimeout;
/**
* @return Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check [LOCK_TIMEOUT docs](https://docs.snowflake.com/en/sql-reference/parameters#lock-timeout).
*
*/
public Optional> lockTimeout() {
return Optional.ofNullable(this.lockTimeout);
}
/**
* Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. For more information about log levels, see [Setting log level](https://docs.snowflake.com/en/developer-guide/logging-tracing/logging-log-level). For more information, check [LOG_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#log-level).
*
*/
@Import(name="logLevel")
private @Nullable Output logLevel;
/**
* @return Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. For more information about log levels, see [Setting log level](https://docs.snowflake.com/en/developer-guide/logging-tracing/logging-log-level). For more information, check [LOG_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#log-level).
*
*/
public Optional> logLevel() {
return Optional.ofNullable(this.logLevel);
}
/**
* The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
*
*/
@Import(name="loginName")
private @Nullable Output loginName;
/**
* @return The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
*
*/
public Optional> loginName() {
return Optional.ofNullable(this.loginName);
}
/**
* Middle name of the user.
*
*/
@Import(name="middleName")
private @Nullable Output middleName;
/**
* @return Middle name of the user.
*
*/
public Optional> middleName() {
return Optional.ofNullable(this.middleName);
}
@Import(name="minsToBypassMfa")
private @Nullable Output minsToBypassMfa;
public Optional> minsToBypassMfa() {
return Optional.ofNullable(this.minsToBypassMfa);
}
@Import(name="minsToUnlock")
private @Nullable Output minsToUnlock;
public Optional> minsToUnlock() {
return Optional.ofNullable(this.minsToUnlock);
}
/**
* Number of statements to execute when using the multi-statement capability. For more information, check [MULTI*STATEMENT*COUNT docs](https://docs.snowflake.com/en/sql-reference/parameters#multi-statement-count).
*
*/
@Import(name="multiStatementCount")
private @Nullable Output multiStatementCount;
/**
* @return Number of statements to execute when using the multi-statement capability. For more information, check [MULTI*STATEMENT*COUNT docs](https://docs.snowflake.com/en/sql-reference/parameters#multi-statement-count).
*
*/
public Optional> multiStatementCount() {
return Optional.ofNullable(this.multiStatementCount);
}
/**
* Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
*/
@Import(name="mustChangePassword")
private @Nullable Output mustChangePassword;
/**
* @return Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
*/
public Optional> mustChangePassword() {
return Optional.ofNullable(this.mustChangePassword);
}
/**
* Name of the user. Note that if you do not supply login*name this will be used as login*name. Check the [docs](https://docs.snowflake.net/manuals/sql-reference/sql/create-user.html#required-parameters). Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Name of the user. Note that if you do not supply login*name this will be used as login*name. Check the [docs](https://docs.snowflake.net/manuals/sql-reference/sql/create-user.html#required-parameters). Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see [Controlling network traffic with network policies](https://docs.snowflake.com/en/user-guide/network-policies). Any existing network policy (created using [CREATE NETWORK POLICY](https://docs.snowflake.com/en/sql-reference/sql/create-network-policy)). For more information, check [NETWORK_POLICY docs](https://docs.snowflake.com/en/sql-reference/parameters#network-policy).
*
*/
@Import(name="networkPolicy")
private @Nullable Output networkPolicy;
/**
* @return Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see [Controlling network traffic with network policies](https://docs.snowflake.com/en/user-guide/network-policies). Any existing network policy (created using [CREATE NETWORK POLICY](https://docs.snowflake.com/en/sql-reference/sql/create-network-policy)). For more information, check [NETWORK_POLICY docs](https://docs.snowflake.com/en/sql-reference/parameters#network-policy).
*
*/
public Optional> networkPolicy() {
return Optional.ofNullable(this.networkPolicy);
}
/**
* Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in [increasing or decreasing order](https://docs.snowflake.com/en/user-guide/querying-sequences.html#label-querying-sequences-increasing-values). For more information, check [NOORDER*SEQUENCE*AS_DEFAULT docs](https://docs.snowflake.com/en/sql-reference/parameters#noorder-sequence-as-default).
*
*/
@Import(name="noorderSequenceAsDefault")
private @Nullable Output noorderSequenceAsDefault;
/**
* @return Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in [increasing or decreasing order](https://docs.snowflake.com/en/user-guide/querying-sequences.html#label-querying-sequences-increasing-values). For more information, check [NOORDER*SEQUENCE*AS_DEFAULT docs](https://docs.snowflake.com/en/sql-reference/parameters#noorder-sequence-as-default).
*
*/
public Optional> noorderSequenceAsDefault() {
return Optional.ofNullable(this.noorderSequenceAsDefault);
}
/**
* Specifies how ODBC processes columns that have a scale of zero (0). For more information, check [ODBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#odbc-treat-decimal-as-int).
*
*/
@Import(name="odbcTreatDecimalAsInt")
private @Nullable Output odbcTreatDecimalAsInt;
/**
* @return Specifies how ODBC processes columns that have a scale of zero (0). For more information, check [ODBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#odbc-treat-decimal-as-int).
*
*/
public Optional> odbcTreatDecimalAsInt() {
return Optional.ofNullable(this.odbcTreatDecimalAsInt);
}
/**
* Outputs the result of `SHOW PARAMETERS IN USER` for the given user.
*
*/
@Import(name="parameters")
private @Nullable Output> parameters;
/**
* @return Outputs the result of `SHOW PARAMETERS IN USER` for the given user.
*
*/
public Optional>> parameters() {
return Optional.ofNullable(this.parameters);
}
@Import(name="password")
private @Nullable Output password;
public Optional> password() {
return Optional.ofNullable(this.password);
}
/**
* Specifies whether to prevent data unload operations to internal (Snowflake) stages using [COPY INTO \n\n](https://docs.snowflake.com/en/sql-reference/sql/copy-into-location) statements. For more information, check [PREVENT*UNLOAD*TO*INTERNAL*STAGES docs](https://docs.snowflake.com/en/sql-reference/parameters#prevent-unload-to-internal-stages).
*
*/
@Import(name="preventUnloadToInternalStages")
private @Nullable Output preventUnloadToInternalStages;
/**
* @return Specifies whether to prevent data unload operations to internal (Snowflake) stages using [COPY INTO \n\n](https://docs.snowflake.com/en/sql-reference/sql/copy-into-location) statements. For more information, check [PREVENT*UNLOAD*TO*INTERNAL*STAGES docs](https://docs.snowflake.com/en/sql-reference/parameters#prevent-unload-to-internal-stages).
*
*/
public Optional> preventUnloadToInternalStages() {
return Optional.ofNullable(this.preventUnloadToInternalStages);
}
/**
* Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the [QUERY*HISTORY, QUERY*HISTORY*BY**](https://docs.snowflake.com/en/sql-reference/functions/query_history) functions. For more information, check [QUERY_TAG docs](https://docs.snowflake.com/en/sql-reference/parameters#query-tag).
*
*/
@Import(name="queryTag")
private @Nullable Output queryTag;
/**
* @return Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the [QUERY*HISTORY, QUERY*HISTORY*BY**](https://docs.snowflake.com/en/sql-reference/functions/query_history) functions. For more information, check [QUERY_TAG docs](https://docs.snowflake.com/en/sql-reference/parameters#query-tag).
*
*/
public Optional> queryTag() {
return Optional.ofNullable(this.queryTag);
}
/**
* Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see [Identifier resolution](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing)). You can use this parameter in situations in which [third-party applications always use double quotes around identifiers](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing-parameter). For more information, check [QUOTED*IDENTIFIERS*IGNORE_CASE docs](https://docs.snowflake.com/en/sql-reference/parameters#quoted-identifiers-ignore-case).
*
*/
@Import(name="quotedIdentifiersIgnoreCase")
private @Nullable Output quotedIdentifiersIgnoreCase;
/**
* @return Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see [Identifier resolution](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing)). You can use this parameter in situations in which [third-party applications always use double quotes around identifiers](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing-parameter). For more information, check [QUOTED*IDENTIFIERS*IGNORE_CASE docs](https://docs.snowflake.com/en/sql-reference/parameters#quoted-identifiers-ignore-case).
*
*/
public Optional> quotedIdentifiersIgnoreCase() {
return Optional.ofNullable(this.quotedIdentifiersIgnoreCase);
}
/**
* Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check [ROWS*PER*RESULTSET docs](https://docs.snowflake.com/en/sql-reference/parameters#rows-per-resultset).
*
*/
@Import(name="rowsPerResultset")
private @Nullable Output rowsPerResultset;
/**
* @return Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check [ROWS*PER*RESULTSET docs](https://docs.snowflake.com/en/sql-reference/parameters#rows-per-resultset).
*
*/
public Optional> rowsPerResultset() {
return Optional.ofNullable(this.rowsPerResultset);
}
/**
* Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
*
*/
@Import(name="rsaPublicKey")
private @Nullable Output rsaPublicKey;
/**
* @return Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
*
*/
public Optional> rsaPublicKey() {
return Optional.ofNullable(this.rsaPublicKey);
}
/**
* Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
*
*/
@Import(name="rsaPublicKey2")
private @Nullable Output rsaPublicKey2;
/**
* @return Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
*
*/
public Optional> rsaPublicKey2() {
return Optional.ofNullable(this.rsaPublicKey2);
}
/**
* Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via [AWS PrivateLink for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/privatelink-interface-endpoints.html) use this endpoint to connect. For more information, see [Accessing Internal stages with dedicated interface endpoints](https://docs.snowflake.com/en/user-guide/private-internal-stages-aws.html#label-aws-privatelink-internal-stage-network-isolation). For more information, check [S3*STAGE*VPCE*DNS*NAME docs](https://docs.snowflake.com/en/sql-reference/parameters#s3-stage-vpce-dns-name).
*
*/
@Import(name="s3StageVpceDnsName")
private @Nullable Output s3StageVpceDnsName;
/**
* @return Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via [AWS PrivateLink for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/privatelink-interface-endpoints.html) use this endpoint to connect. For more information, see [Accessing Internal stages with dedicated interface endpoints](https://docs.snowflake.com/en/user-guide/private-internal-stages-aws.html#label-aws-privatelink-internal-stage-network-isolation). For more information, check [S3*STAGE*VPCE*DNS*NAME docs](https://docs.snowflake.com/en/sql-reference/parameters#s3-stage-vpce-dns-name).
*
*/
public Optional> s3StageVpceDnsName() {
return Optional.ofNullable(this.s3StageVpceDnsName);
}
/**
* Specifies the path to search to resolve unqualified object names in queries. For more information, see [Name resolution in queries](https://docs.snowflake.com/en/sql-reference/name-resolution.html#label-object-name-resolution-search-path). Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check [SEARCH_PATH docs](https://docs.snowflake.com/en/sql-reference/parameters#search-path).
*
*/
@Import(name="searchPath")
private @Nullable Output searchPath;
/**
* @return Specifies the path to search to resolve unqualified object names in queries. For more information, see [Name resolution in queries](https://docs.snowflake.com/en/sql-reference/name-resolution.html#label-object-name-resolution-search-path). Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check [SEARCH_PATH docs](https://docs.snowflake.com/en/sql-reference/parameters#search-path).
*
*/
public Optional> searchPath() {
return Optional.ofNullable(this.searchPath);
}
/**
* Outputs the result of `SHOW USER` for the given user.
*
*/
@Import(name="showOutputs")
private @Nullable Output> showOutputs;
/**
* @return Outputs the result of `SHOW USER` for the given user.
*
*/
public Optional>> showOutputs() {
return Optional.ofNullable(this.showOutputs);
}
/**
* Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, see [Introduction to Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) and [Working with shares](https://docs.snowflake.com/en/user-guide/data-sharing-provider). For more information, check [SIMULATED*DATA*SHARING_CONSUMER docs](https://docs.snowflake.com/en/sql-reference/parameters#simulated-data-sharing-consumer).
*
*/
@Import(name="simulatedDataSharingConsumer")
private @Nullable Output simulatedDataSharingConsumer;
/**
* @return Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, see [Introduction to Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) and [Working with shares](https://docs.snowflake.com/en/user-guide/data-sharing-provider). For more information, check [SIMULATED*DATA*SHARING_CONSUMER docs](https://docs.snowflake.com/en/sql-reference/parameters#simulated-data-sharing-consumer).
*
*/
public Optional> simulatedDataSharingConsumer() {
return Optional.ofNullable(this.simulatedDataSharingConsumer);
}
/**
* Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the [MAX*CONCURRENCY*LEVEL](https://docs.snowflake.com/en/sql-reference/parameters#label-max-concurrency-level) parameter to ensure a warehouse is never backlogged. For more information, check [STATEMENT*QUEUED*TIMEOUT*IN*SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-queued-timeout-in-seconds).
*
*/
@Import(name="statementQueuedTimeoutInSeconds")
private @Nullable Output statementQueuedTimeoutInSeconds;
/**
* @return Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the [MAX*CONCURRENCY*LEVEL](https://docs.snowflake.com/en/sql-reference/parameters#label-max-concurrency-level) parameter to ensure a warehouse is never backlogged. For more information, check [STATEMENT*QUEUED*TIMEOUT*IN*SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-queued-timeout-in-seconds).
*
*/
public Optional> statementQueuedTimeoutInSeconds() {
return Optional.ofNullable(this.statementQueuedTimeoutInSeconds);
}
/**
* Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check [STATEMENT*TIMEOUT*IN_SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-timeout-in-seconds).
*
*/
@Import(name="statementTimeoutInSeconds")
private @Nullable Output statementTimeoutInSeconds;
/**
* @return Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check [STATEMENT*TIMEOUT*IN_SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-timeout-in-seconds).
*
*/
public Optional> statementTimeoutInSeconds() {
return Optional.ofNullable(this.statementTimeoutInSeconds);
}
/**
* This parameter specifies whether JSON output in a session is compatible with the general standard (as described by [http://json.org](http://json.org)). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check [STRICT*JSON*OUTPUT docs](https://docs.snowflake.com/en/sql-reference/parameters#strict-json-output).
*
*/
@Import(name="strictJsonOutput")
private @Nullable Output strictJsonOutput;
/**
* @return This parameter specifies whether JSON output in a session is compatible with the general standard (as described by [http://json.org](http://json.org)). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check [STRICT*JSON*OUTPUT docs](https://docs.snowflake.com/en/sql-reference/parameters#strict-json-output).
*
*/
public Optional> strictJsonOutput() {
return Optional.ofNullable(this.strictJsonOutput);
}
/**
* Specifies the input format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check [TIME*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-input-format).
*
*/
@Import(name="timeInputFormat")
private @Nullable Output timeInputFormat;
/**
* @return Specifies the input format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check [TIME*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-input-format).
*
*/
public Optional> timeInputFormat() {
return Optional.ofNullable(this.timeInputFormat);
}
/**
* Specifies the display format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIME*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-output-format).
*
*/
@Import(name="timeOutputFormat")
private @Nullable Output timeOutputFormat;
/**
* @return Specifies the display format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIME*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-output-format).
*
*/
public Optional> timeOutputFormat() {
return Optional.ofNullable(this.timeOutputFormat);
}
/**
* Specifies whether the [DATEADD](https://docs.snowflake.com/en/sql-reference/functions/dateadd) function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check [TIMESTAMP*DAY*IS*ALWAYS*24H docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-day-is-always-24h).
*
*/
@Import(name="timestampDayIsAlways24h")
private @Nullable Output timestampDayIsAlways24h;
/**
* @return Specifies whether the [DATEADD](https://docs.snowflake.com/en/sql-reference/functions/dateadd) function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check [TIMESTAMP*DAY*IS*ALWAYS*24H docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-day-is-always-24h).
*
*/
public Optional> timestampDayIsAlways24h() {
return Optional.ofNullable(this.timestampDayIsAlways24h);
}
/**
* Specifies the input format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check [TIMESTAMP*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-input-format).
*
*/
@Import(name="timestampInputFormat")
private @Nullable Output timestampInputFormat;
/**
* @return Specifies the input format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check [TIMESTAMP*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-input-format).
*
*/
public Optional> timestampInputFormat() {
return Optional.ofNullable(this.timestampInputFormat);
}
/**
* Specifies the display format for the TIMESTAMP*LTZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*LTZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ltz-output-format).
*
*/
@Import(name="timestampLtzOutputFormat")
private @Nullable Output timestampLtzOutputFormat;
/**
* @return Specifies the display format for the TIMESTAMP*LTZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*LTZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ltz-output-format).
*
*/
public Optional> timestampLtzOutputFormat() {
return Optional.ofNullable(this.timestampLtzOutputFormat);
}
/**
* Specifies the display format for the TIMESTAMP*NTZ data type. For more information, check *NTZ*OUTPUT*FORMAT docs[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ntz-output-format).
*
*/
@Import(name="timestampNtzOutputFormat")
private @Nullable Output timestampNtzOutputFormat;
/**
* @return Specifies the display format for the TIMESTAMP*NTZ data type. For more information, check *NTZ*OUTPUT*FORMAT docs[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ntz-output-format).
*
*/
public Optional> timestampNtzOutputFormat() {
return Optional.ofNullable(this.timestampNtzOutputFormat);
}
/**
* Specifies the display format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-output-format).
*
*/
@Import(name="timestampOutputFormat")
private @Nullable Output timestampOutputFormat;
/**
* @return Specifies the display format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-output-format).
*
*/
public Optional> timestampOutputFormat() {
return Optional.ofNullable(this.timestampOutputFormat);
}
/**
* Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check [TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-type-mapping).
*
*/
@Import(name="timestampTypeMapping")
private @Nullable Output timestampTypeMapping;
/**
* @return Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check [TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-type-mapping).
*
*/
public Optional> timestampTypeMapping() {
return Optional.ofNullable(this.timestampTypeMapping);
}
/**
* Specifies the display format for the TIMESTAMP*TZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*TZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-tz-output-format).
*
*/
@Import(name="timestampTzOutputFormat")
private @Nullable Output timestampTzOutputFormat;
/**
* @return Specifies the display format for the TIMESTAMP*TZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*TZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-tz-output-format).
*
*/
public Optional> timestampTzOutputFormat() {
return Optional.ofNullable(this.timestampTzOutputFormat);
}
/**
* Specifies the time zone for the session. You can specify a [time zone name](https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) or a [link name](https://data.iana.org/time-zones/tzdb-2021a/backward) from release 2021a of the [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check [TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#timezone).
*
*/
@Import(name="timezone")
private @Nullable Output timezone;
/**
* @return Specifies the time zone for the session. You can specify a [time zone name](https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) or a [link name](https://data.iana.org/time-zones/tzdb-2021a/backward) from release 2021a of the [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check [TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#timezone).
*
*/
public Optional> timezone() {
return Optional.ofNullable(this.timezone);
}
/**
* Controls how trace events are ingested into the event table. For more information about trace levels, see [Setting trace level](https://docs.snowflake.com/en/developer-guide/logging-tracing/tracing-trace-level). For more information, check [TRACE_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#trace-level).
*
*/
@Import(name="traceLevel")
private @Nullable Output traceLevel;
/**
* @return Controls how trace events are ingested into the event table. For more information about trace levels, see [Setting trace level](https://docs.snowflake.com/en/developer-guide/logging-tracing/tracing-trace-level). For more information, check [TRACE_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#trace-level).
*
*/
public Optional> traceLevel() {
return Optional.ofNullable(this.traceLevel);
}
/**
* Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check [TRANSACTION*ABORT*ON_ERROR docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-abort-on-error).
*
*/
@Import(name="transactionAbortOnError")
private @Nullable Output transactionAbortOnError;
/**
* @return Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check [TRANSACTION*ABORT*ON_ERROR docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-abort-on-error).
*
*/
public Optional> transactionAbortOnError() {
return Optional.ofNullable(this.transactionAbortOnError);
}
/**
* Specifies the isolation level for transactions in the user session. For more information, check [TRANSACTION*DEFAULT*ISOLATION_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-default-isolation-level).
*
*/
@Import(name="transactionDefaultIsolationLevel")
private @Nullable Output transactionDefaultIsolationLevel;
/**
* @return Specifies the isolation level for transactions in the user session. For more information, check [TRANSACTION*DEFAULT*ISOLATION_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-default-isolation-level).
*
*/
public Optional> transactionDefaultIsolationLevel() {
return Optional.ofNullable(this.transactionDefaultIsolationLevel);
}
/**
* Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the `YY` date format component (i.e. years represented as 2 digits). For more information, check [TWO*DIGIT*CENTURY_START docs](https://docs.snowflake.com/en/sql-reference/parameters#two-digit-century-start).
*
*/
@Import(name="twoDigitCenturyStart")
private @Nullable Output twoDigitCenturyStart;
/**
* @return Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the `YY` date format component (i.e. years represented as 2 digits). For more information, check [TWO*DIGIT*CENTURY_START docs](https://docs.snowflake.com/en/sql-reference/parameters#two-digit-century-start).
*
*/
public Optional> twoDigitCenturyStart() {
return Optional.ofNullable(this.twoDigitCenturyStart);
}
/**
* Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check [UNSUPPORTED*DDL*ACTION docs](https://docs.snowflake.com/en/sql-reference/parameters#unsupported-ddl-action).
*
*/
@Import(name="unsupportedDdlAction")
private @Nullable Output unsupportedDdlAction;
/**
* @return Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check [UNSUPPORTED*DDL*ACTION docs](https://docs.snowflake.com/en/sql-reference/parameters#unsupported-ddl-action).
*
*/
public Optional> unsupportedDdlAction() {
return Optional.ofNullable(this.unsupportedDdlAction);
}
/**
* Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check [USE*CACHED*RESULT docs](https://docs.snowflake.com/en/sql-reference/parameters#use-cached-result).
*
*/
@Import(name="useCachedResult")
private @Nullable Output useCachedResult;
/**
* @return Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check [USE*CACHED*RESULT docs](https://docs.snowflake.com/en/sql-reference/parameters#use-cached-result).
*
*/
public Optional> useCachedResult() {
return Optional.ofNullable(this.useCachedResult);
}
/**
* Specifies a type for the user.
*
*/
@Import(name="userType")
private @Nullable Output userType;
/**
* @return Specifies a type for the user.
*
*/
public Optional> userType() {
return Optional.ofNullable(this.userType);
}
/**
* Specifies how the weeks in a given year are computed. `0`: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year. `1`: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check [WEEK*OF*YEAR_POLICY docs](https://docs.snowflake.com/en/sql-reference/parameters#week-of-year-policy).
*
*/
@Import(name="weekOfYearPolicy")
private @Nullable Output weekOfYearPolicy;
/**
* @return Specifies how the weeks in a given year are computed. `0`: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year. `1`: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check [WEEK*OF*YEAR_POLICY docs](https://docs.snowflake.com/en/sql-reference/parameters#week-of-year-policy).
*
*/
public Optional> weekOfYearPolicy() {
return Optional.ofNullable(this.weekOfYearPolicy);
}
/**
* Specifies the first day of the week (used by week-related date functions). `0`: Legacy Snowflake behavior is used (i.e. ISO-like semantics). `1` (Monday) to `7` (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check [WEEK_START docs](https://docs.snowflake.com/en/sql-reference/parameters#week-start).
*
*/
@Import(name="weekStart")
private @Nullable Output weekStart;
/**
* @return Specifies the first day of the week (used by week-related date functions). `0`: Legacy Snowflake behavior is used (i.e. ISO-like semantics). `1` (Monday) to `7` (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check [WEEK_START docs](https://docs.snowflake.com/en/sql-reference/parameters#week-start).
*
*/
public Optional> weekStart() {
return Optional.ofNullable(this.weekStart);
}
private UserState() {}
private UserState(UserState $) {
this.abortDetachedQuery = $.abortDetachedQuery;
this.autocommit = $.autocommit;
this.binaryInputFormat = $.binaryInputFormat;
this.binaryOutputFormat = $.binaryOutputFormat;
this.clientMemoryLimit = $.clientMemoryLimit;
this.clientMetadataRequestUseConnectionCtx = $.clientMetadataRequestUseConnectionCtx;
this.clientPrefetchThreads = $.clientPrefetchThreads;
this.clientResultChunkSize = $.clientResultChunkSize;
this.clientResultColumnCaseInsensitive = $.clientResultColumnCaseInsensitive;
this.clientSessionKeepAlive = $.clientSessionKeepAlive;
this.clientSessionKeepAliveHeartbeatFrequency = $.clientSessionKeepAliveHeartbeatFrequency;
this.clientTimestampTypeMapping = $.clientTimestampTypeMapping;
this.comment = $.comment;
this.dateInputFormat = $.dateInputFormat;
this.dateOutputFormat = $.dateOutputFormat;
this.daysToExpiry = $.daysToExpiry;
this.defaultNamespace = $.defaultNamespace;
this.defaultRole = $.defaultRole;
this.defaultSecondaryRolesOption = $.defaultSecondaryRolesOption;
this.defaultWarehouse = $.defaultWarehouse;
this.disableMfa = $.disableMfa;
this.disabled = $.disabled;
this.displayName = $.displayName;
this.email = $.email;
this.enableUnloadPhysicalTypeOptimization = $.enableUnloadPhysicalTypeOptimization;
this.enableUnredactedQuerySyntaxError = $.enableUnredactedQuerySyntaxError;
this.errorOnNondeterministicMerge = $.errorOnNondeterministicMerge;
this.errorOnNondeterministicUpdate = $.errorOnNondeterministicUpdate;
this.firstName = $.firstName;
this.fullyQualifiedName = $.fullyQualifiedName;
this.geographyOutputFormat = $.geographyOutputFormat;
this.geometryOutputFormat = $.geometryOutputFormat;
this.jdbcTreatDecimalAsInt = $.jdbcTreatDecimalAsInt;
this.jdbcTreatTimestampNtzAsUtc = $.jdbcTreatTimestampNtzAsUtc;
this.jdbcUseSessionTimezone = $.jdbcUseSessionTimezone;
this.jsonIndent = $.jsonIndent;
this.lastName = $.lastName;
this.lockTimeout = $.lockTimeout;
this.logLevel = $.logLevel;
this.loginName = $.loginName;
this.middleName = $.middleName;
this.minsToBypassMfa = $.minsToBypassMfa;
this.minsToUnlock = $.minsToUnlock;
this.multiStatementCount = $.multiStatementCount;
this.mustChangePassword = $.mustChangePassword;
this.name = $.name;
this.networkPolicy = $.networkPolicy;
this.noorderSequenceAsDefault = $.noorderSequenceAsDefault;
this.odbcTreatDecimalAsInt = $.odbcTreatDecimalAsInt;
this.parameters = $.parameters;
this.password = $.password;
this.preventUnloadToInternalStages = $.preventUnloadToInternalStages;
this.queryTag = $.queryTag;
this.quotedIdentifiersIgnoreCase = $.quotedIdentifiersIgnoreCase;
this.rowsPerResultset = $.rowsPerResultset;
this.rsaPublicKey = $.rsaPublicKey;
this.rsaPublicKey2 = $.rsaPublicKey2;
this.s3StageVpceDnsName = $.s3StageVpceDnsName;
this.searchPath = $.searchPath;
this.showOutputs = $.showOutputs;
this.simulatedDataSharingConsumer = $.simulatedDataSharingConsumer;
this.statementQueuedTimeoutInSeconds = $.statementQueuedTimeoutInSeconds;
this.statementTimeoutInSeconds = $.statementTimeoutInSeconds;
this.strictJsonOutput = $.strictJsonOutput;
this.timeInputFormat = $.timeInputFormat;
this.timeOutputFormat = $.timeOutputFormat;
this.timestampDayIsAlways24h = $.timestampDayIsAlways24h;
this.timestampInputFormat = $.timestampInputFormat;
this.timestampLtzOutputFormat = $.timestampLtzOutputFormat;
this.timestampNtzOutputFormat = $.timestampNtzOutputFormat;
this.timestampOutputFormat = $.timestampOutputFormat;
this.timestampTypeMapping = $.timestampTypeMapping;
this.timestampTzOutputFormat = $.timestampTzOutputFormat;
this.timezone = $.timezone;
this.traceLevel = $.traceLevel;
this.transactionAbortOnError = $.transactionAbortOnError;
this.transactionDefaultIsolationLevel = $.transactionDefaultIsolationLevel;
this.twoDigitCenturyStart = $.twoDigitCenturyStart;
this.unsupportedDdlAction = $.unsupportedDdlAction;
this.useCachedResult = $.useCachedResult;
this.userType = $.userType;
this.weekOfYearPolicy = $.weekOfYearPolicy;
this.weekStart = $.weekStart;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(UserState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private UserState $;
public Builder() {
$ = new UserState();
}
public Builder(UserState defaults) {
$ = new UserState(Objects.requireNonNull(defaults));
}
/**
* @param abortDetachedQuery Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check [ABORT*DETACHED*QUERY docs](https://docs.snowflake.com/en/sql-reference/parameters#abort-detached-query).
*
* @return builder
*
*/
public Builder abortDetachedQuery(@Nullable Output abortDetachedQuery) {
$.abortDetachedQuery = abortDetachedQuery;
return this;
}
/**
* @param abortDetachedQuery Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check [ABORT*DETACHED*QUERY docs](https://docs.snowflake.com/en/sql-reference/parameters#abort-detached-query).
*
* @return builder
*
*/
public Builder abortDetachedQuery(Boolean abortDetachedQuery) {
return abortDetachedQuery(Output.of(abortDetachedQuery));
}
/**
* @param autocommit Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see [Transactions](https://docs.snowflake.com/en/sql-reference/transactions). For more information, check [AUTOCOMMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#autocommit).
*
* @return builder
*
*/
public Builder autocommit(@Nullable Output autocommit) {
$.autocommit = autocommit;
return this;
}
/**
* @param autocommit Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see [Transactions](https://docs.snowflake.com/en/sql-reference/transactions). For more information, check [AUTOCOMMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#autocommit).
*
* @return builder
*
*/
public Builder autocommit(Boolean autocommit) {
return autocommit(Output.of(autocommit));
}
/**
* @param binaryInputFormat The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-input-format).
*
* @return builder
*
*/
public Builder binaryInputFormat(@Nullable Output binaryInputFormat) {
$.binaryInputFormat = binaryInputFormat;
return this;
}
/**
* @param binaryInputFormat The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-input-format).
*
* @return builder
*
*/
public Builder binaryInputFormat(String binaryInputFormat) {
return binaryInputFormat(Output.of(binaryInputFormat));
}
/**
* @param binaryOutputFormat The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-output-format).
*
* @return builder
*
*/
public Builder binaryOutputFormat(@Nullable Output binaryOutputFormat) {
$.binaryOutputFormat = binaryOutputFormat;
return this;
}
/**
* @param binaryOutputFormat The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see [Binary input and output](https://docs.snowflake.com/en/sql-reference/binary-input-output). For more information, check [BINARY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#binary-output-format).
*
* @return builder
*
*/
public Builder binaryOutputFormat(String binaryOutputFormat) {
return binaryOutputFormat(Output.of(binaryOutputFormat));
}
/**
* @param clientMemoryLimit Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check [CLIENT*MEMORY*LIMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#client-memory-limit).
*
* @return builder
*
*/
public Builder clientMemoryLimit(@Nullable Output clientMemoryLimit) {
$.clientMemoryLimit = clientMemoryLimit;
return this;
}
/**
* @param clientMemoryLimit Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check [CLIENT*MEMORY*LIMIT docs](https://docs.snowflake.com/en/sql-reference/parameters#client-memory-limit).
*
* @return builder
*
*/
public Builder clientMemoryLimit(Integer clientMemoryLimit) {
return clientMemoryLimit(Output.of(clientMemoryLimit));
}
/**
* @param clientMetadataRequestUseConnectionCtx For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check [CLIENT*METADATA*REQUEST*USE*CONNECTION_CTX docs](https://docs.snowflake.com/en/sql-reference/parameters#client-metadata-request-use-connection-ctx).
*
* @return builder
*
*/
public Builder clientMetadataRequestUseConnectionCtx(@Nullable Output clientMetadataRequestUseConnectionCtx) {
$.clientMetadataRequestUseConnectionCtx = clientMetadataRequestUseConnectionCtx;
return this;
}
/**
* @param clientMetadataRequestUseConnectionCtx For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check [CLIENT*METADATA*REQUEST*USE*CONNECTION_CTX docs](https://docs.snowflake.com/en/sql-reference/parameters#client-metadata-request-use-connection-ctx).
*
* @return builder
*
*/
public Builder clientMetadataRequestUseConnectionCtx(Boolean clientMetadataRequestUseConnectionCtx) {
return clientMetadataRequestUseConnectionCtx(Output.of(clientMetadataRequestUseConnectionCtx));
}
/**
* @param clientPrefetchThreads Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check [CLIENT*PREFETCH*THREADS docs](https://docs.snowflake.com/en/sql-reference/parameters#client-prefetch-threads).
*
* @return builder
*
*/
public Builder clientPrefetchThreads(@Nullable Output clientPrefetchThreads) {
$.clientPrefetchThreads = clientPrefetchThreads;
return this;
}
/**
* @param clientPrefetchThreads Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check [CLIENT*PREFETCH*THREADS docs](https://docs.snowflake.com/en/sql-reference/parameters#client-prefetch-threads).
*
* @return builder
*
*/
public Builder clientPrefetchThreads(Integer clientPrefetchThreads) {
return clientPrefetchThreads(Output.of(clientPrefetchThreads));
}
/**
* @param clientResultChunkSize Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check [CLIENT*RESULT*CHUNK_SIZE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-chunk-size).
*
* @return builder
*
*/
public Builder clientResultChunkSize(@Nullable Output clientResultChunkSize) {
$.clientResultChunkSize = clientResultChunkSize;
return this;
}
/**
* @param clientResultChunkSize Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check [CLIENT*RESULT*CHUNK_SIZE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-chunk-size).
*
* @return builder
*
*/
public Builder clientResultChunkSize(Integer clientResultChunkSize) {
return clientResultChunkSize(Output.of(clientResultChunkSize));
}
/**
* @param clientResultColumnCaseInsensitive Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check [CLIENT*RESULT*COLUMN*CASE*INSENSITIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-column-case-insensitive).
*
* @return builder
*
*/
public Builder clientResultColumnCaseInsensitive(@Nullable Output clientResultColumnCaseInsensitive) {
$.clientResultColumnCaseInsensitive = clientResultColumnCaseInsensitive;
return this;
}
/**
* @param clientResultColumnCaseInsensitive Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check [CLIENT*RESULT*COLUMN*CASE*INSENSITIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-result-column-case-insensitive).
*
* @return builder
*
*/
public Builder clientResultColumnCaseInsensitive(Boolean clientResultColumnCaseInsensitive) {
return clientResultColumnCaseInsensitive(Output.of(clientResultColumnCaseInsensitive));
}
/**
* @param clientSessionKeepAlive Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check [CLIENT*SESSION*KEEP_ALIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive).
*
* @return builder
*
*/
public Builder clientSessionKeepAlive(@Nullable Output clientSessionKeepAlive) {
$.clientSessionKeepAlive = clientSessionKeepAlive;
return this;
}
/**
* @param clientSessionKeepAlive Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check [CLIENT*SESSION*KEEP_ALIVE docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive).
*
* @return builder
*
*/
public Builder clientSessionKeepAlive(Boolean clientSessionKeepAlive) {
return clientSessionKeepAlive(Output.of(clientSessionKeepAlive));
}
/**
* @param clientSessionKeepAliveHeartbeatFrequency Number of seconds in-between client attempts to update the token for the session. For more information, check [CLIENT*SESSION*KEEP*ALIVE*HEARTBEAT_FREQUENCY docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive-heartbeat-frequency).
*
* @return builder
*
*/
public Builder clientSessionKeepAliveHeartbeatFrequency(@Nullable Output clientSessionKeepAliveHeartbeatFrequency) {
$.clientSessionKeepAliveHeartbeatFrequency = clientSessionKeepAliveHeartbeatFrequency;
return this;
}
/**
* @param clientSessionKeepAliveHeartbeatFrequency Number of seconds in-between client attempts to update the token for the session. For more information, check [CLIENT*SESSION*KEEP*ALIVE*HEARTBEAT_FREQUENCY docs](https://docs.snowflake.com/en/sql-reference/parameters#client-session-keep-alive-heartbeat-frequency).
*
* @return builder
*
*/
public Builder clientSessionKeepAliveHeartbeatFrequency(Integer clientSessionKeepAliveHeartbeatFrequency) {
return clientSessionKeepAliveHeartbeatFrequency(Output.of(clientSessionKeepAliveHeartbeatFrequency));
}
/**
* @param clientTimestampTypeMapping Specifies the [TIMESTAMP_* variation](https://docs.snowflake.com/en/sql-reference/data-types-datetime.html#label-datatypes-timestamp-variations) to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check [CLIENT*TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#client-timestamp-type-mapping).
*
* @return builder
*
*/
public Builder clientTimestampTypeMapping(@Nullable Output clientTimestampTypeMapping) {
$.clientTimestampTypeMapping = clientTimestampTypeMapping;
return this;
}
/**
* @param clientTimestampTypeMapping Specifies the [TIMESTAMP_* variation](https://docs.snowflake.com/en/sql-reference/data-types-datetime.html#label-datatypes-timestamp-variations) to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check [CLIENT*TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#client-timestamp-type-mapping).
*
* @return builder
*
*/
public Builder clientTimestampTypeMapping(String clientTimestampTypeMapping) {
return clientTimestampTypeMapping(Output.of(clientTimestampTypeMapping));
}
/**
* @param comment Specifies a comment for the user.
*
* @return builder
*
*/
public Builder comment(@Nullable Output comment) {
$.comment = comment;
return this;
}
/**
* @param comment Specifies a comment for the user.
*
* @return builder
*
*/
public Builder comment(String comment) {
return comment(Output.of(comment));
}
/**
* @param dateInputFormat Specifies the input format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-input-format).
*
* @return builder
*
*/
public Builder dateInputFormat(@Nullable Output dateInputFormat) {
$.dateInputFormat = dateInputFormat;
return this;
}
/**
* @param dateInputFormat Specifies the input format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-input-format).
*
* @return builder
*
*/
public Builder dateInputFormat(String dateInputFormat) {
return dateInputFormat(Output.of(dateInputFormat));
}
/**
* @param dateOutputFormat Specifies the display format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-output-format).
*
* @return builder
*
*/
public Builder dateOutputFormat(@Nullable Output dateOutputFormat) {
$.dateOutputFormat = dateOutputFormat;
return this;
}
/**
* @param dateOutputFormat Specifies the display format for the DATE data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [DATE*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#date-output-format).
*
* @return builder
*
*/
public Builder dateOutputFormat(String dateOutputFormat) {
return dateOutputFormat(Output.of(dateOutputFormat));
}
public Builder daysToExpiry(@Nullable Output daysToExpiry) {
$.daysToExpiry = daysToExpiry;
return this;
}
public Builder daysToExpiry(Integer daysToExpiry) {
return daysToExpiry(Output.of(daysToExpiry));
}
/**
* @param defaultNamespace Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
*
* @return builder
*
*/
public Builder defaultNamespace(@Nullable Output defaultNamespace) {
$.defaultNamespace = defaultNamespace;
return this;
}
/**
* @param defaultNamespace Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
*
* @return builder
*
*/
public Builder defaultNamespace(String defaultNamespace) {
return defaultNamespace(Output.of(defaultNamespace));
}
/**
* @param defaultRole Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does **not** grant the role to the user. The role must be granted explicitly to the user using the [GRANT ROLE](https://docs.snowflake.com/en/sql-reference/sql/grant-role) command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
*
* @return builder
*
*/
public Builder defaultRole(@Nullable Output defaultRole) {
$.defaultRole = defaultRole;
return this;
}
/**
* @param defaultRole Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does **not** grant the role to the user. The role must be granted explicitly to the user using the [GRANT ROLE](https://docs.snowflake.com/en/sql-reference/sql/grant-role) command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
*
* @return builder
*
*/
public Builder defaultRole(String defaultRole) {
return defaultRole(Output.of(defaultRole));
}
/**
* @param defaultSecondaryRolesOption Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): `DEFAULT` | `NONE` | `ALL`. More information can be found in [doc](https://docs.snowflake.com/en/sql-reference/sql/create-user#optional-object-properties-objectproperties).
*
* @return builder
*
*/
public Builder defaultSecondaryRolesOption(@Nullable Output defaultSecondaryRolesOption) {
$.defaultSecondaryRolesOption = defaultSecondaryRolesOption;
return this;
}
/**
* @param defaultSecondaryRolesOption Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): `DEFAULT` | `NONE` | `ALL`. More information can be found in [doc](https://docs.snowflake.com/en/sql-reference/sql/create-user#optional-object-properties-objectproperties).
*
* @return builder
*
*/
public Builder defaultSecondaryRolesOption(String defaultSecondaryRolesOption) {
return defaultSecondaryRolesOption(Output.of(defaultSecondaryRolesOption));
}
/**
* @param defaultWarehouse Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
*
* @return builder
*
*/
public Builder defaultWarehouse(@Nullable Output defaultWarehouse) {
$.defaultWarehouse = defaultWarehouse;
return this;
}
/**
* @param defaultWarehouse Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
*
* @return builder
*
*/
public Builder defaultWarehouse(String defaultWarehouse) {
return defaultWarehouse(Output.of(defaultWarehouse));
}
public Builder disableMfa(@Nullable Output disableMfa) {
$.disableMfa = disableMfa;
return this;
}
public Builder disableMfa(String disableMfa) {
return disableMfa(Output.of(disableMfa));
}
/**
* @param disabled Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
* @return builder
*
*/
public Builder disabled(@Nullable Output disabled) {
$.disabled = disabled;
return this;
}
/**
* @param disabled Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
* @return builder
*
*/
public Builder disabled(String disabled) {
return disabled(Output.of(disabled));
}
/**
* @param displayName Name displayed for the user in the Snowflake web interface.
*
* @return builder
*
*/
public Builder displayName(@Nullable Output displayName) {
$.displayName = displayName;
return this;
}
/**
* @param displayName Name displayed for the user in the Snowflake web interface.
*
* @return builder
*
*/
public Builder displayName(String displayName) {
return displayName(Output.of(displayName));
}
/**
* @param email Email address for the user.
*
* @return builder
*
*/
public Builder email(@Nullable Output email) {
$.email = email;
return this;
}
/**
* @param email Email address for the user.
*
* @return builder
*
*/
public Builder email(String email) {
return email(Output.of(email));
}
/**
* @param enableUnloadPhysicalTypeOptimization Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check [ENABLE*UNLOAD*PHYSICAL*TYPE*OPTIMIZATION docs](https://docs.snowflake.com/en/sql-reference/parameters#enable-unload-physical-type-optimization).
*
* @return builder
*
*/
public Builder enableUnloadPhysicalTypeOptimization(@Nullable Output enableUnloadPhysicalTypeOptimization) {
$.enableUnloadPhysicalTypeOptimization = enableUnloadPhysicalTypeOptimization;
return this;
}
/**
* @param enableUnloadPhysicalTypeOptimization Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check [ENABLE*UNLOAD*PHYSICAL*TYPE*OPTIMIZATION docs](https://docs.snowflake.com/en/sql-reference/parameters#enable-unload-physical-type-optimization).
*
* @return builder
*
*/
public Builder enableUnloadPhysicalTypeOptimization(Boolean enableUnloadPhysicalTypeOptimization) {
return enableUnloadPhysicalTypeOptimization(Output.of(enableUnloadPhysicalTypeOptimization));
}
/**
* @param enableUnredactedQuerySyntaxError Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If `FALSE`, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLE*UNREDACTED*QUERY*SYNTAX*ERROR parameter. When using the ALTER USER command to set the parameter to `TRUE` for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check *UNREDACTED*QUERY*SYNTAX*ERROR docs[ENABLE](https://docs.snowflake.com/en/sql-reference/parameters#enable-unredacted-query-syntax-error).
*
* @return builder
*
*/
public Builder enableUnredactedQuerySyntaxError(@Nullable Output enableUnredactedQuerySyntaxError) {
$.enableUnredactedQuerySyntaxError = enableUnredactedQuerySyntaxError;
return this;
}
/**
* @param enableUnredactedQuerySyntaxError Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If `FALSE`, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLE*UNREDACTED*QUERY*SYNTAX*ERROR parameter. When using the ALTER USER command to set the parameter to `TRUE` for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check *UNREDACTED*QUERY*SYNTAX*ERROR docs[ENABLE](https://docs.snowflake.com/en/sql-reference/parameters#enable-unredacted-query-syntax-error).
*
* @return builder
*
*/
public Builder enableUnredactedQuerySyntaxError(Boolean enableUnredactedQuerySyntaxError) {
return enableUnredactedQuerySyntaxError(Output.of(enableUnredactedQuerySyntaxError));
}
/**
* @param errorOnNondeterministicMerge Specifies whether to return an error when the [MERGE](https://docs.snowflake.com/en/sql-reference/sql/merge) command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_MERGE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-merge).
*
* @return builder
*
*/
public Builder errorOnNondeterministicMerge(@Nullable Output errorOnNondeterministicMerge) {
$.errorOnNondeterministicMerge = errorOnNondeterministicMerge;
return this;
}
/**
* @param errorOnNondeterministicMerge Specifies whether to return an error when the [MERGE](https://docs.snowflake.com/en/sql-reference/sql/merge) command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_MERGE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-merge).
*
* @return builder
*
*/
public Builder errorOnNondeterministicMerge(Boolean errorOnNondeterministicMerge) {
return errorOnNondeterministicMerge(Output.of(errorOnNondeterministicMerge));
}
/**
* @param errorOnNondeterministicUpdate Specifies whether to return an error when the [UPDATE](https://docs.snowflake.com/en/sql-reference/sql/update) command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_UPDATE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-update).
*
* @return builder
*
*/
public Builder errorOnNondeterministicUpdate(@Nullable Output errorOnNondeterministicUpdate) {
$.errorOnNondeterministicUpdate = errorOnNondeterministicUpdate;
return this;
}
/**
* @param errorOnNondeterministicUpdate Specifies whether to return an error when the [UPDATE](https://docs.snowflake.com/en/sql-reference/sql/update) command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check [ERROR*ON*NONDETERMINISTIC_UPDATE docs](https://docs.snowflake.com/en/sql-reference/parameters#error-on-nondeterministic-update).
*
* @return builder
*
*/
public Builder errorOnNondeterministicUpdate(Boolean errorOnNondeterministicUpdate) {
return errorOnNondeterministicUpdate(Output.of(errorOnNondeterministicUpdate));
}
/**
* @param firstName First name of the user.
*
* @return builder
*
*/
public Builder firstName(@Nullable Output firstName) {
$.firstName = firstName;
return this;
}
/**
* @param firstName First name of the user.
*
* @return builder
*
*/
public Builder firstName(String firstName) {
return firstName(Output.of(firstName));
}
/**
* @param fullyQualifiedName Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
*
* @return builder
*
*/
public Builder fullyQualifiedName(@Nullable Output fullyQualifiedName) {
$.fullyQualifiedName = fullyQualifiedName;
return this;
}
/**
* @param fullyQualifiedName Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
*
* @return builder
*
*/
public Builder fullyQualifiedName(String fullyQualifiedName) {
return fullyQualifiedName(Output.of(fullyQualifiedName));
}
/**
* @param geographyOutputFormat Display format for [GEOGRAPHY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geography). For more information, check [GEOGRAPHY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geography-output-format).
*
* @return builder
*
*/
public Builder geographyOutputFormat(@Nullable Output geographyOutputFormat) {
$.geographyOutputFormat = geographyOutputFormat;
return this;
}
/**
* @param geographyOutputFormat Display format for [GEOGRAPHY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geography). For more information, check [GEOGRAPHY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geography-output-format).
*
* @return builder
*
*/
public Builder geographyOutputFormat(String geographyOutputFormat) {
return geographyOutputFormat(Output.of(geographyOutputFormat));
}
/**
* @param geometryOutputFormat Display format for [GEOMETRY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geometry). For more information, check [GEOMETRY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geometry-output-format).
*
* @return builder
*
*/
public Builder geometryOutputFormat(@Nullable Output geometryOutputFormat) {
$.geometryOutputFormat = geometryOutputFormat;
return this;
}
/**
* @param geometryOutputFormat Display format for [GEOMETRY values](https://docs.snowflake.com/en/sql-reference/data-types-geospatial.html#label-data-types-geometry). For more information, check [GEOMETRY*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#geometry-output-format).
*
* @return builder
*
*/
public Builder geometryOutputFormat(String geometryOutputFormat) {
return geometryOutputFormat(Output.of(geometryOutputFormat));
}
/**
* @param jdbcTreatDecimalAsInt Specifies how JDBC processes columns that have a scale of zero (0). For more information, check [JDBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-decimal-as-int).
*
* @return builder
*
*/
public Builder jdbcTreatDecimalAsInt(@Nullable Output jdbcTreatDecimalAsInt) {
$.jdbcTreatDecimalAsInt = jdbcTreatDecimalAsInt;
return this;
}
/**
* @param jdbcTreatDecimalAsInt Specifies how JDBC processes columns that have a scale of zero (0). For more information, check [JDBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-decimal-as-int).
*
* @return builder
*
*/
public Builder jdbcTreatDecimalAsInt(Boolean jdbcTreatDecimalAsInt) {
return jdbcTreatDecimalAsInt(Output.of(jdbcTreatDecimalAsInt));
}
/**
* @param jdbcTreatTimestampNtzAsUtc Specifies how JDBC processes TIMESTAMP*NTZ values. For more information, check *TREAT*TIMESTAMP*NTZ*AS*UTC docs[JDBC](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-timestamp-ntz-as-utc).
*
* @return builder
*
*/
public Builder jdbcTreatTimestampNtzAsUtc(@Nullable Output jdbcTreatTimestampNtzAsUtc) {
$.jdbcTreatTimestampNtzAsUtc = jdbcTreatTimestampNtzAsUtc;
return this;
}
/**
* @param jdbcTreatTimestampNtzAsUtc Specifies how JDBC processes TIMESTAMP*NTZ values. For more information, check *TREAT*TIMESTAMP*NTZ*AS*UTC docs[JDBC](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-timestamp-ntz-as-utc).
*
* @return builder
*
*/
public Builder jdbcTreatTimestampNtzAsUtc(Boolean jdbcTreatTimestampNtzAsUtc) {
return jdbcTreatTimestampNtzAsUtc(Output.of(jdbcTreatTimestampNtzAsUtc));
}
/**
* @param jdbcUseSessionTimezone Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the [TIMEZONE](https://docs.snowflake.com/en/sql-reference/parameters#label-timezone) parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check [JDBC*USE*SESSION_TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-use-session-timezone).
*
* @return builder
*
*/
public Builder jdbcUseSessionTimezone(@Nullable Output jdbcUseSessionTimezone) {
$.jdbcUseSessionTimezone = jdbcUseSessionTimezone;
return this;
}
/**
* @param jdbcUseSessionTimezone Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the [TIMEZONE](https://docs.snowflake.com/en/sql-reference/parameters#label-timezone) parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check [JDBC*USE*SESSION_TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#jdbc-use-session-timezone).
*
* @return builder
*
*/
public Builder jdbcUseSessionTimezone(Boolean jdbcUseSessionTimezone) {
return jdbcUseSessionTimezone(Output.of(jdbcUseSessionTimezone));
}
/**
* @param jsonIndent Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check [JSON_INDENT docs](https://docs.snowflake.com/en/sql-reference/parameters#json-indent).
*
* @return builder
*
*/
public Builder jsonIndent(@Nullable Output jsonIndent) {
$.jsonIndent = jsonIndent;
return this;
}
/**
* @param jsonIndent Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check [JSON_INDENT docs](https://docs.snowflake.com/en/sql-reference/parameters#json-indent).
*
* @return builder
*
*/
public Builder jsonIndent(Integer jsonIndent) {
return jsonIndent(Output.of(jsonIndent));
}
/**
* @param lastName Last name of the user.
*
* @return builder
*
*/
public Builder lastName(@Nullable Output lastName) {
$.lastName = lastName;
return this;
}
/**
* @param lastName Last name of the user.
*
* @return builder
*
*/
public Builder lastName(String lastName) {
return lastName(Output.of(lastName));
}
/**
* @param lockTimeout Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check [LOCK_TIMEOUT docs](https://docs.snowflake.com/en/sql-reference/parameters#lock-timeout).
*
* @return builder
*
*/
public Builder lockTimeout(@Nullable Output lockTimeout) {
$.lockTimeout = lockTimeout;
return this;
}
/**
* @param lockTimeout Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check [LOCK_TIMEOUT docs](https://docs.snowflake.com/en/sql-reference/parameters#lock-timeout).
*
* @return builder
*
*/
public Builder lockTimeout(Integer lockTimeout) {
return lockTimeout(Output.of(lockTimeout));
}
/**
* @param logLevel Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. For more information about log levels, see [Setting log level](https://docs.snowflake.com/en/developer-guide/logging-tracing/logging-log-level). For more information, check [LOG_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#log-level).
*
* @return builder
*
*/
public Builder logLevel(@Nullable Output logLevel) {
$.logLevel = logLevel;
return this;
}
/**
* @param logLevel Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. For more information about log levels, see [Setting log level](https://docs.snowflake.com/en/developer-guide/logging-tracing/logging-log-level). For more information, check [LOG_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#log-level).
*
* @return builder
*
*/
public Builder logLevel(String logLevel) {
return logLevel(Output.of(logLevel));
}
/**
* @param loginName The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
*
* @return builder
*
*/
public Builder loginName(@Nullable Output loginName) {
$.loginName = loginName;
return this;
}
/**
* @param loginName The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
*
* @return builder
*
*/
public Builder loginName(String loginName) {
return loginName(Output.of(loginName));
}
/**
* @param middleName Middle name of the user.
*
* @return builder
*
*/
public Builder middleName(@Nullable Output middleName) {
$.middleName = middleName;
return this;
}
/**
* @param middleName Middle name of the user.
*
* @return builder
*
*/
public Builder middleName(String middleName) {
return middleName(Output.of(middleName));
}
public Builder minsToBypassMfa(@Nullable Output minsToBypassMfa) {
$.minsToBypassMfa = minsToBypassMfa;
return this;
}
public Builder minsToBypassMfa(Integer minsToBypassMfa) {
return minsToBypassMfa(Output.of(minsToBypassMfa));
}
public Builder minsToUnlock(@Nullable Output minsToUnlock) {
$.minsToUnlock = minsToUnlock;
return this;
}
public Builder minsToUnlock(Integer minsToUnlock) {
return minsToUnlock(Output.of(minsToUnlock));
}
/**
* @param multiStatementCount Number of statements to execute when using the multi-statement capability. For more information, check [MULTI*STATEMENT*COUNT docs](https://docs.snowflake.com/en/sql-reference/parameters#multi-statement-count).
*
* @return builder
*
*/
public Builder multiStatementCount(@Nullable Output multiStatementCount) {
$.multiStatementCount = multiStatementCount;
return this;
}
/**
* @param multiStatementCount Number of statements to execute when using the multi-statement capability. For more information, check [MULTI*STATEMENT*COUNT docs](https://docs.snowflake.com/en/sql-reference/parameters#multi-statement-count).
*
* @return builder
*
*/
public Builder multiStatementCount(Integer multiStatementCount) {
return multiStatementCount(Output.of(multiStatementCount));
}
/**
* @param mustChangePassword Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
* @return builder
*
*/
public Builder mustChangePassword(@Nullable Output mustChangePassword) {
$.mustChangePassword = mustChangePassword;
return this;
}
/**
* @param mustChangePassword Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
*
* @return builder
*
*/
public Builder mustChangePassword(String mustChangePassword) {
return mustChangePassword(Output.of(mustChangePassword));
}
/**
* @param name Name of the user. Note that if you do not supply login*name this will be used as login*name. Check the [docs](https://docs.snowflake.net/manuals/sql-reference/sql/create-user.html#required-parameters). Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Name of the user. Note that if you do not supply login*name this will be used as login*name. Check the [docs](https://docs.snowflake.net/manuals/sql-reference/sql/create-user.html#required-parameters). Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param networkPolicy Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see [Controlling network traffic with network policies](https://docs.snowflake.com/en/user-guide/network-policies). Any existing network policy (created using [CREATE NETWORK POLICY](https://docs.snowflake.com/en/sql-reference/sql/create-network-policy)). For more information, check [NETWORK_POLICY docs](https://docs.snowflake.com/en/sql-reference/parameters#network-policy).
*
* @return builder
*
*/
public Builder networkPolicy(@Nullable Output networkPolicy) {
$.networkPolicy = networkPolicy;
return this;
}
/**
* @param networkPolicy Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see [Controlling network traffic with network policies](https://docs.snowflake.com/en/user-guide/network-policies). Any existing network policy (created using [CREATE NETWORK POLICY](https://docs.snowflake.com/en/sql-reference/sql/create-network-policy)). For more information, check [NETWORK_POLICY docs](https://docs.snowflake.com/en/sql-reference/parameters#network-policy).
*
* @return builder
*
*/
public Builder networkPolicy(String networkPolicy) {
return networkPolicy(Output.of(networkPolicy));
}
/**
* @param noorderSequenceAsDefault Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in [increasing or decreasing order](https://docs.snowflake.com/en/user-guide/querying-sequences.html#label-querying-sequences-increasing-values). For more information, check [NOORDER*SEQUENCE*AS_DEFAULT docs](https://docs.snowflake.com/en/sql-reference/parameters#noorder-sequence-as-default).
*
* @return builder
*
*/
public Builder noorderSequenceAsDefault(@Nullable Output noorderSequenceAsDefault) {
$.noorderSequenceAsDefault = noorderSequenceAsDefault;
return this;
}
/**
* @param noorderSequenceAsDefault Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in [increasing or decreasing order](https://docs.snowflake.com/en/user-guide/querying-sequences.html#label-querying-sequences-increasing-values). For more information, check [NOORDER*SEQUENCE*AS_DEFAULT docs](https://docs.snowflake.com/en/sql-reference/parameters#noorder-sequence-as-default).
*
* @return builder
*
*/
public Builder noorderSequenceAsDefault(Boolean noorderSequenceAsDefault) {
return noorderSequenceAsDefault(Output.of(noorderSequenceAsDefault));
}
/**
* @param odbcTreatDecimalAsInt Specifies how ODBC processes columns that have a scale of zero (0). For more information, check [ODBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#odbc-treat-decimal-as-int).
*
* @return builder
*
*/
public Builder odbcTreatDecimalAsInt(@Nullable Output odbcTreatDecimalAsInt) {
$.odbcTreatDecimalAsInt = odbcTreatDecimalAsInt;
return this;
}
/**
* @param odbcTreatDecimalAsInt Specifies how ODBC processes columns that have a scale of zero (0). For more information, check [ODBC*TREAT*DECIMAL*AS*INT docs](https://docs.snowflake.com/en/sql-reference/parameters#odbc-treat-decimal-as-int).
*
* @return builder
*
*/
public Builder odbcTreatDecimalAsInt(Boolean odbcTreatDecimalAsInt) {
return odbcTreatDecimalAsInt(Output.of(odbcTreatDecimalAsInt));
}
/**
* @param parameters Outputs the result of `SHOW PARAMETERS IN USER` for the given user.
*
* @return builder
*
*/
public Builder parameters(@Nullable Output> parameters) {
$.parameters = parameters;
return this;
}
/**
* @param parameters Outputs the result of `SHOW PARAMETERS IN USER` for the given user.
*
* @return builder
*
*/
public Builder parameters(List parameters) {
return parameters(Output.of(parameters));
}
/**
* @param parameters Outputs the result of `SHOW PARAMETERS IN USER` for the given user.
*
* @return builder
*
*/
public Builder parameters(UserParameterArgs... parameters) {
return parameters(List.of(parameters));
}
public Builder password(@Nullable Output password) {
$.password = password;
return this;
}
public Builder password(String password) {
return password(Output.of(password));
}
/**
* @param preventUnloadToInternalStages Specifies whether to prevent data unload operations to internal (Snowflake) stages using [COPY INTO \n\n](https://docs.snowflake.com/en/sql-reference/sql/copy-into-location) statements. For more information, check [PREVENT*UNLOAD*TO*INTERNAL*STAGES docs](https://docs.snowflake.com/en/sql-reference/parameters#prevent-unload-to-internal-stages).
*
* @return builder
*
*/
public Builder preventUnloadToInternalStages(@Nullable Output preventUnloadToInternalStages) {
$.preventUnloadToInternalStages = preventUnloadToInternalStages;
return this;
}
/**
* @param preventUnloadToInternalStages Specifies whether to prevent data unload operations to internal (Snowflake) stages using [COPY INTO \n\n](https://docs.snowflake.com/en/sql-reference/sql/copy-into-location) statements. For more information, check [PREVENT*UNLOAD*TO*INTERNAL*STAGES docs](https://docs.snowflake.com/en/sql-reference/parameters#prevent-unload-to-internal-stages).
*
* @return builder
*
*/
public Builder preventUnloadToInternalStages(Boolean preventUnloadToInternalStages) {
return preventUnloadToInternalStages(Output.of(preventUnloadToInternalStages));
}
/**
* @param queryTag Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the [QUERY*HISTORY, QUERY*HISTORY*BY**](https://docs.snowflake.com/en/sql-reference/functions/query_history) functions. For more information, check [QUERY_TAG docs](https://docs.snowflake.com/en/sql-reference/parameters#query-tag).
*
* @return builder
*
*/
public Builder queryTag(@Nullable Output queryTag) {
$.queryTag = queryTag;
return this;
}
/**
* @param queryTag Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the [QUERY*HISTORY, QUERY*HISTORY*BY**](https://docs.snowflake.com/en/sql-reference/functions/query_history) functions. For more information, check [QUERY_TAG docs](https://docs.snowflake.com/en/sql-reference/parameters#query-tag).
*
* @return builder
*
*/
public Builder queryTag(String queryTag) {
return queryTag(Output.of(queryTag));
}
/**
* @param quotedIdentifiersIgnoreCase Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see [Identifier resolution](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing)). You can use this parameter in situations in which [third-party applications always use double quotes around identifiers](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing-parameter). For more information, check [QUOTED*IDENTIFIERS*IGNORE_CASE docs](https://docs.snowflake.com/en/sql-reference/parameters#quoted-identifiers-ignore-case).
*
* @return builder
*
*/
public Builder quotedIdentifiersIgnoreCase(@Nullable Output quotedIdentifiersIgnoreCase) {
$.quotedIdentifiersIgnoreCase = quotedIdentifiersIgnoreCase;
return this;
}
/**
* @param quotedIdentifiersIgnoreCase Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see [Identifier resolution](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing)). You can use this parameter in situations in which [third-party applications always use double quotes around identifiers](https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html#label-identifier-casing-parameter). For more information, check [QUOTED*IDENTIFIERS*IGNORE_CASE docs](https://docs.snowflake.com/en/sql-reference/parameters#quoted-identifiers-ignore-case).
*
* @return builder
*
*/
public Builder quotedIdentifiersIgnoreCase(Boolean quotedIdentifiersIgnoreCase) {
return quotedIdentifiersIgnoreCase(Output.of(quotedIdentifiersIgnoreCase));
}
/**
* @param rowsPerResultset Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check [ROWS*PER*RESULTSET docs](https://docs.snowflake.com/en/sql-reference/parameters#rows-per-resultset).
*
* @return builder
*
*/
public Builder rowsPerResultset(@Nullable Output rowsPerResultset) {
$.rowsPerResultset = rowsPerResultset;
return this;
}
/**
* @param rowsPerResultset Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check [ROWS*PER*RESULTSET docs](https://docs.snowflake.com/en/sql-reference/parameters#rows-per-resultset).
*
* @return builder
*
*/
public Builder rowsPerResultset(Integer rowsPerResultset) {
return rowsPerResultset(Output.of(rowsPerResultset));
}
/**
* @param rsaPublicKey Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
*
* @return builder
*
*/
public Builder rsaPublicKey(@Nullable Output rsaPublicKey) {
$.rsaPublicKey = rsaPublicKey;
return this;
}
/**
* @param rsaPublicKey Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
*
* @return builder
*
*/
public Builder rsaPublicKey(String rsaPublicKey) {
return rsaPublicKey(Output.of(rsaPublicKey));
}
/**
* @param rsaPublicKey2 Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
*
* @return builder
*
*/
public Builder rsaPublicKey2(@Nullable Output rsaPublicKey2) {
$.rsaPublicKey2 = rsaPublicKey2;
return this;
}
/**
* @param rsaPublicKey2 Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
*
* @return builder
*
*/
public Builder rsaPublicKey2(String rsaPublicKey2) {
return rsaPublicKey2(Output.of(rsaPublicKey2));
}
/**
* @param s3StageVpceDnsName Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via [AWS PrivateLink for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/privatelink-interface-endpoints.html) use this endpoint to connect. For more information, see [Accessing Internal stages with dedicated interface endpoints](https://docs.snowflake.com/en/user-guide/private-internal-stages-aws.html#label-aws-privatelink-internal-stage-network-isolation). For more information, check [S3*STAGE*VPCE*DNS*NAME docs](https://docs.snowflake.com/en/sql-reference/parameters#s3-stage-vpce-dns-name).
*
* @return builder
*
*/
public Builder s3StageVpceDnsName(@Nullable Output s3StageVpceDnsName) {
$.s3StageVpceDnsName = s3StageVpceDnsName;
return this;
}
/**
* @param s3StageVpceDnsName Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via [AWS PrivateLink for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/privatelink-interface-endpoints.html) use this endpoint to connect. For more information, see [Accessing Internal stages with dedicated interface endpoints](https://docs.snowflake.com/en/user-guide/private-internal-stages-aws.html#label-aws-privatelink-internal-stage-network-isolation). For more information, check [S3*STAGE*VPCE*DNS*NAME docs](https://docs.snowflake.com/en/sql-reference/parameters#s3-stage-vpce-dns-name).
*
* @return builder
*
*/
public Builder s3StageVpceDnsName(String s3StageVpceDnsName) {
return s3StageVpceDnsName(Output.of(s3StageVpceDnsName));
}
/**
* @param searchPath Specifies the path to search to resolve unqualified object names in queries. For more information, see [Name resolution in queries](https://docs.snowflake.com/en/sql-reference/name-resolution.html#label-object-name-resolution-search-path). Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check [SEARCH_PATH docs](https://docs.snowflake.com/en/sql-reference/parameters#search-path).
*
* @return builder
*
*/
public Builder searchPath(@Nullable Output searchPath) {
$.searchPath = searchPath;
return this;
}
/**
* @param searchPath Specifies the path to search to resolve unqualified object names in queries. For more information, see [Name resolution in queries](https://docs.snowflake.com/en/sql-reference/name-resolution.html#label-object-name-resolution-search-path). Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check [SEARCH_PATH docs](https://docs.snowflake.com/en/sql-reference/parameters#search-path).
*
* @return builder
*
*/
public Builder searchPath(String searchPath) {
return searchPath(Output.of(searchPath));
}
/**
* @param showOutputs Outputs the result of `SHOW USER` for the given user.
*
* @return builder
*
*/
public Builder showOutputs(@Nullable Output> showOutputs) {
$.showOutputs = showOutputs;
return this;
}
/**
* @param showOutputs Outputs the result of `SHOW USER` for the given user.
*
* @return builder
*
*/
public Builder showOutputs(List showOutputs) {
return showOutputs(Output.of(showOutputs));
}
/**
* @param showOutputs Outputs the result of `SHOW USER` for the given user.
*
* @return builder
*
*/
public Builder showOutputs(UserShowOutputArgs... showOutputs) {
return showOutputs(List.of(showOutputs));
}
/**
* @param simulatedDataSharingConsumer Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, see [Introduction to Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) and [Working with shares](https://docs.snowflake.com/en/user-guide/data-sharing-provider). For more information, check [SIMULATED*DATA*SHARING_CONSUMER docs](https://docs.snowflake.com/en/sql-reference/parameters#simulated-data-sharing-consumer).
*
* @return builder
*
*/
public Builder simulatedDataSharingConsumer(@Nullable Output simulatedDataSharingConsumer) {
$.simulatedDataSharingConsumer = simulatedDataSharingConsumer;
return this;
}
/**
* @param simulatedDataSharingConsumer Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, see [Introduction to Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) and [Working with shares](https://docs.snowflake.com/en/user-guide/data-sharing-provider). For more information, check [SIMULATED*DATA*SHARING_CONSUMER docs](https://docs.snowflake.com/en/sql-reference/parameters#simulated-data-sharing-consumer).
*
* @return builder
*
*/
public Builder simulatedDataSharingConsumer(String simulatedDataSharingConsumer) {
return simulatedDataSharingConsumer(Output.of(simulatedDataSharingConsumer));
}
/**
* @param statementQueuedTimeoutInSeconds Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the [MAX*CONCURRENCY*LEVEL](https://docs.snowflake.com/en/sql-reference/parameters#label-max-concurrency-level) parameter to ensure a warehouse is never backlogged. For more information, check [STATEMENT*QUEUED*TIMEOUT*IN*SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-queued-timeout-in-seconds).
*
* @return builder
*
*/
public Builder statementQueuedTimeoutInSeconds(@Nullable Output statementQueuedTimeoutInSeconds) {
$.statementQueuedTimeoutInSeconds = statementQueuedTimeoutInSeconds;
return this;
}
/**
* @param statementQueuedTimeoutInSeconds Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the [MAX*CONCURRENCY*LEVEL](https://docs.snowflake.com/en/sql-reference/parameters#label-max-concurrency-level) parameter to ensure a warehouse is never backlogged. For more information, check [STATEMENT*QUEUED*TIMEOUT*IN*SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-queued-timeout-in-seconds).
*
* @return builder
*
*/
public Builder statementQueuedTimeoutInSeconds(Integer statementQueuedTimeoutInSeconds) {
return statementQueuedTimeoutInSeconds(Output.of(statementQueuedTimeoutInSeconds));
}
/**
* @param statementTimeoutInSeconds Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check [STATEMENT*TIMEOUT*IN_SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-timeout-in-seconds).
*
* @return builder
*
*/
public Builder statementTimeoutInSeconds(@Nullable Output statementTimeoutInSeconds) {
$.statementTimeoutInSeconds = statementTimeoutInSeconds;
return this;
}
/**
* @param statementTimeoutInSeconds Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check [STATEMENT*TIMEOUT*IN_SECONDS docs](https://docs.snowflake.com/en/sql-reference/parameters#statement-timeout-in-seconds).
*
* @return builder
*
*/
public Builder statementTimeoutInSeconds(Integer statementTimeoutInSeconds) {
return statementTimeoutInSeconds(Output.of(statementTimeoutInSeconds));
}
/**
* @param strictJsonOutput This parameter specifies whether JSON output in a session is compatible with the general standard (as described by [http://json.org](http://json.org)). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check [STRICT*JSON*OUTPUT docs](https://docs.snowflake.com/en/sql-reference/parameters#strict-json-output).
*
* @return builder
*
*/
public Builder strictJsonOutput(@Nullable Output strictJsonOutput) {
$.strictJsonOutput = strictJsonOutput;
return this;
}
/**
* @param strictJsonOutput This parameter specifies whether JSON output in a session is compatible with the general standard (as described by [http://json.org](http://json.org)). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check [STRICT*JSON*OUTPUT docs](https://docs.snowflake.com/en/sql-reference/parameters#strict-json-output).
*
* @return builder
*
*/
public Builder strictJsonOutput(Boolean strictJsonOutput) {
return strictJsonOutput(Output.of(strictJsonOutput));
}
/**
* @param timeInputFormat Specifies the input format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check [TIME*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-input-format).
*
* @return builder
*
*/
public Builder timeInputFormat(@Nullable Output timeInputFormat) {
$.timeInputFormat = timeInputFormat;
return this;
}
/**
* @param timeInputFormat Specifies the input format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check [TIME*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-input-format).
*
* @return builder
*
*/
public Builder timeInputFormat(String timeInputFormat) {
return timeInputFormat(Output.of(timeInputFormat));
}
/**
* @param timeOutputFormat Specifies the display format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIME*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-output-format).
*
* @return builder
*
*/
public Builder timeOutputFormat(@Nullable Output timeOutputFormat) {
$.timeOutputFormat = timeOutputFormat;
return this;
}
/**
* @param timeOutputFormat Specifies the display format for the TIME data type. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIME*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#time-output-format).
*
* @return builder
*
*/
public Builder timeOutputFormat(String timeOutputFormat) {
return timeOutputFormat(Output.of(timeOutputFormat));
}
/**
* @param timestampDayIsAlways24h Specifies whether the [DATEADD](https://docs.snowflake.com/en/sql-reference/functions/dateadd) function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check [TIMESTAMP*DAY*IS*ALWAYS*24H docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-day-is-always-24h).
*
* @return builder
*
*/
public Builder timestampDayIsAlways24h(@Nullable Output timestampDayIsAlways24h) {
$.timestampDayIsAlways24h = timestampDayIsAlways24h;
return this;
}
/**
* @param timestampDayIsAlways24h Specifies whether the [DATEADD](https://docs.snowflake.com/en/sql-reference/functions/dateadd) function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check [TIMESTAMP*DAY*IS*ALWAYS*24H docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-day-is-always-24h).
*
* @return builder
*
*/
public Builder timestampDayIsAlways24h(Boolean timestampDayIsAlways24h) {
return timestampDayIsAlways24h(Output.of(timestampDayIsAlways24h));
}
/**
* @param timestampInputFormat Specifies the input format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check [TIMESTAMP*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-input-format).
*
* @return builder
*
*/
public Builder timestampInputFormat(@Nullable Output timestampInputFormat) {
$.timestampInputFormat = timestampInputFormat;
return this;
}
/**
* @param timestampInputFormat Specifies the input format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check [TIMESTAMP*INPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-input-format).
*
* @return builder
*
*/
public Builder timestampInputFormat(String timestampInputFormat) {
return timestampInputFormat(Output.of(timestampInputFormat));
}
/**
* @param timestampLtzOutputFormat Specifies the display format for the TIMESTAMP*LTZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*LTZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ltz-output-format).
*
* @return builder
*
*/
public Builder timestampLtzOutputFormat(@Nullable Output timestampLtzOutputFormat) {
$.timestampLtzOutputFormat = timestampLtzOutputFormat;
return this;
}
/**
* @param timestampLtzOutputFormat Specifies the display format for the TIMESTAMP*LTZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*LTZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ltz-output-format).
*
* @return builder
*
*/
public Builder timestampLtzOutputFormat(String timestampLtzOutputFormat) {
return timestampLtzOutputFormat(Output.of(timestampLtzOutputFormat));
}
/**
* @param timestampNtzOutputFormat Specifies the display format for the TIMESTAMP*NTZ data type. For more information, check *NTZ*OUTPUT*FORMAT docs[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ntz-output-format).
*
* @return builder
*
*/
public Builder timestampNtzOutputFormat(@Nullable Output timestampNtzOutputFormat) {
$.timestampNtzOutputFormat = timestampNtzOutputFormat;
return this;
}
/**
* @param timestampNtzOutputFormat Specifies the display format for the TIMESTAMP*NTZ data type. For more information, check *NTZ*OUTPUT*FORMAT docs[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-ntz-output-format).
*
* @return builder
*
*/
public Builder timestampNtzOutputFormat(String timestampNtzOutputFormat) {
return timestampNtzOutputFormat(Output.of(timestampNtzOutputFormat));
}
/**
* @param timestampOutputFormat Specifies the display format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-output-format).
*
* @return builder
*
*/
public Builder timestampOutputFormat(@Nullable Output timestampOutputFormat) {
$.timestampOutputFormat = timestampOutputFormat;
return this;
}
/**
* @param timestampOutputFormat Specifies the display format for the TIMESTAMP data type alias. For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-output-format).
*
* @return builder
*
*/
public Builder timestampOutputFormat(String timestampOutputFormat) {
return timestampOutputFormat(Output.of(timestampOutputFormat));
}
/**
* @param timestampTypeMapping Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check [TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-type-mapping).
*
* @return builder
*
*/
public Builder timestampTypeMapping(@Nullable Output timestampTypeMapping) {
$.timestampTypeMapping = timestampTypeMapping;
return this;
}
/**
* @param timestampTypeMapping Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check [TIMESTAMP*TYPE_MAPPING docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-type-mapping).
*
* @return builder
*
*/
public Builder timestampTypeMapping(String timestampTypeMapping) {
return timestampTypeMapping(Output.of(timestampTypeMapping));
}
/**
* @param timestampTzOutputFormat Specifies the display format for the TIMESTAMP*TZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*TZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-tz-output-format).
*
* @return builder
*
*/
public Builder timestampTzOutputFormat(@Nullable Output timestampTzOutputFormat) {
$.timestampTzOutputFormat = timestampTzOutputFormat;
return this;
}
/**
* @param timestampTzOutputFormat Specifies the display format for the TIMESTAMP*TZ data type. If no format is specified, defaults to *OUTPUT*FORMAT[TIMESTAMP](https://docs.snowflake.com/en/sql-reference/parameters#label-timestamp-output-format). For more information, see [Date and time input and output formats](https://docs.snowflake.com/en/sql-reference/date-time-input-output). For more information, check [TIMESTAMP*TZ*OUTPUT*FORMAT docs](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-tz-output-format).
*
* @return builder
*
*/
public Builder timestampTzOutputFormat(String timestampTzOutputFormat) {
return timestampTzOutputFormat(Output.of(timestampTzOutputFormat));
}
/**
* @param timezone Specifies the time zone for the session. You can specify a [time zone name](https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) or a [link name](https://data.iana.org/time-zones/tzdb-2021a/backward) from release 2021a of the [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check [TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#timezone).
*
* @return builder
*
*/
public Builder timezone(@Nullable Output timezone) {
$.timezone = timezone;
return this;
}
/**
* @param timezone Specifies the time zone for the session. You can specify a [time zone name](https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) or a [link name](https://data.iana.org/time-zones/tzdb-2021a/backward) from release 2021a of the [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check [TIMEZONE docs](https://docs.snowflake.com/en/sql-reference/parameters#timezone).
*
* @return builder
*
*/
public Builder timezone(String timezone) {
return timezone(Output.of(timezone));
}
/**
* @param traceLevel Controls how trace events are ingested into the event table. For more information about trace levels, see [Setting trace level](https://docs.snowflake.com/en/developer-guide/logging-tracing/tracing-trace-level). For more information, check [TRACE_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#trace-level).
*
* @return builder
*
*/
public Builder traceLevel(@Nullable Output traceLevel) {
$.traceLevel = traceLevel;
return this;
}
/**
* @param traceLevel Controls how trace events are ingested into the event table. For more information about trace levels, see [Setting trace level](https://docs.snowflake.com/en/developer-guide/logging-tracing/tracing-trace-level). For more information, check [TRACE_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#trace-level).
*
* @return builder
*
*/
public Builder traceLevel(String traceLevel) {
return traceLevel(Output.of(traceLevel));
}
/**
* @param transactionAbortOnError Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check [TRANSACTION*ABORT*ON_ERROR docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-abort-on-error).
*
* @return builder
*
*/
public Builder transactionAbortOnError(@Nullable Output transactionAbortOnError) {
$.transactionAbortOnError = transactionAbortOnError;
return this;
}
/**
* @param transactionAbortOnError Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check [TRANSACTION*ABORT*ON_ERROR docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-abort-on-error).
*
* @return builder
*
*/
public Builder transactionAbortOnError(Boolean transactionAbortOnError) {
return transactionAbortOnError(Output.of(transactionAbortOnError));
}
/**
* @param transactionDefaultIsolationLevel Specifies the isolation level for transactions in the user session. For more information, check [TRANSACTION*DEFAULT*ISOLATION_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-default-isolation-level).
*
* @return builder
*
*/
public Builder transactionDefaultIsolationLevel(@Nullable Output transactionDefaultIsolationLevel) {
$.transactionDefaultIsolationLevel = transactionDefaultIsolationLevel;
return this;
}
/**
* @param transactionDefaultIsolationLevel Specifies the isolation level for transactions in the user session. For more information, check [TRANSACTION*DEFAULT*ISOLATION_LEVEL docs](https://docs.snowflake.com/en/sql-reference/parameters#transaction-default-isolation-level).
*
* @return builder
*
*/
public Builder transactionDefaultIsolationLevel(String transactionDefaultIsolationLevel) {
return transactionDefaultIsolationLevel(Output.of(transactionDefaultIsolationLevel));
}
/**
* @param twoDigitCenturyStart Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the `YY` date format component (i.e. years represented as 2 digits). For more information, check [TWO*DIGIT*CENTURY_START docs](https://docs.snowflake.com/en/sql-reference/parameters#two-digit-century-start).
*
* @return builder
*
*/
public Builder twoDigitCenturyStart(@Nullable Output twoDigitCenturyStart) {
$.twoDigitCenturyStart = twoDigitCenturyStart;
return this;
}
/**
* @param twoDigitCenturyStart Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the `YY` date format component (i.e. years represented as 2 digits). For more information, check [TWO*DIGIT*CENTURY_START docs](https://docs.snowflake.com/en/sql-reference/parameters#two-digit-century-start).
*
* @return builder
*
*/
public Builder twoDigitCenturyStart(Integer twoDigitCenturyStart) {
return twoDigitCenturyStart(Output.of(twoDigitCenturyStart));
}
/**
* @param unsupportedDdlAction Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check [UNSUPPORTED*DDL*ACTION docs](https://docs.snowflake.com/en/sql-reference/parameters#unsupported-ddl-action).
*
* @return builder
*
*/
public Builder unsupportedDdlAction(@Nullable Output unsupportedDdlAction) {
$.unsupportedDdlAction = unsupportedDdlAction;
return this;
}
/**
* @param unsupportedDdlAction Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check [UNSUPPORTED*DDL*ACTION docs](https://docs.snowflake.com/en/sql-reference/parameters#unsupported-ddl-action).
*
* @return builder
*
*/
public Builder unsupportedDdlAction(String unsupportedDdlAction) {
return unsupportedDdlAction(Output.of(unsupportedDdlAction));
}
/**
* @param useCachedResult Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check [USE*CACHED*RESULT docs](https://docs.snowflake.com/en/sql-reference/parameters#use-cached-result).
*
* @return builder
*
*/
public Builder useCachedResult(@Nullable Output useCachedResult) {
$.useCachedResult = useCachedResult;
return this;
}
/**
* @param useCachedResult Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check [USE*CACHED*RESULT docs](https://docs.snowflake.com/en/sql-reference/parameters#use-cached-result).
*
* @return builder
*
*/
public Builder useCachedResult(Boolean useCachedResult) {
return useCachedResult(Output.of(useCachedResult));
}
/**
* @param userType Specifies a type for the user.
*
* @return builder
*
*/
public Builder userType(@Nullable Output userType) {
$.userType = userType;
return this;
}
/**
* @param userType Specifies a type for the user.
*
* @return builder
*
*/
public Builder userType(String userType) {
return userType(Output.of(userType));
}
/**
* @param weekOfYearPolicy Specifies how the weeks in a given year are computed. `0`: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year. `1`: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check [WEEK*OF*YEAR_POLICY docs](https://docs.snowflake.com/en/sql-reference/parameters#week-of-year-policy).
*
* @return builder
*
*/
public Builder weekOfYearPolicy(@Nullable Output
