public interface ExecuteSqlRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDatabase()
public abstract String getDatabase() Required. Name of the database where the query will be executed.
Note - Value provided should be the same as expected from SELECT
current_database(); and NOT as a resource reference.
string database = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The database. |
getDatabaseBytes()
public abstract ByteString getDatabaseBytes() Required. Name of the database where the query will be executed.
Note - Value provided should be the same as expected from SELECT
current_database(); and NOT as a resource reference.
string database = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for database. |
getInstance()
public abstract String getInstance()Required. The instance where the SQL will be executed. For the required format, see the comment on the Instance.name field.
string instance = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The instance. |
getInstanceBytes()
public abstract ByteString getInstanceBytes()Required. The instance where the SQL will be executed. For the required format, see the comment on the Instance.name field.
string instance = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for instance. |
getPassword()
public abstract String getPassword()Optional. The database native user’s password.
string password = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The password. |
getPasswordBytes()
public abstract ByteString getPasswordBytes()Optional. The database native user’s password.
string password = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for password. |
getSqlStatement()
public abstract String getSqlStatement()Required. SQL statement to execute on database. Any valid statement is permitted, including DDL, DML, DQL statements.
string sql_statement = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The sqlStatement. |
getSqlStatementBytes()
public abstract ByteString getSqlStatementBytes()Required. SQL statement to execute on database. Any valid statement is permitted, including DDL, DML, DQL statements.
string sql_statement = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for sqlStatement. |
getUser()
public abstract String getUser() Required. Database user to be used for executing the SQL.
Note - Value provided should be the same as expected from
SELECT current_user; and NOT as a resource reference.
string user = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The user. |
getUserBytes()
public abstract ByteString getUserBytes() Required. Database user to be used for executing the SQL.
Note - Value provided should be the same as expected from
SELECT current_user; and NOT as a resource reference.
string user = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for user. |
getUserCredentialCase()
public abstract ExecuteSqlRequest.UserCredentialCase getUserCredentialCase()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.UserCredentialCase |
|
getValidateOnly()
public abstract boolean getValidateOnly()Optional. If set, validates the sql statement by performing syntax and semantic validation and doesn't execute the query.
bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The validateOnly. |
hasPassword()
public abstract boolean hasPassword()Optional. The database native user’s password.
string password = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the password field is set. |