public static final class ExecuteSqlRequest.Builder extends GeneratedMessage.Builder<ExecuteSqlRequest.Builder> implements ExecuteSqlRequestOrBuilderRequest for ExecuteSql rpc.
Protobuf type google.cloud.alloydb.v1beta.ExecuteSqlRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ExecuteSqlRequest.BuilderImplements
ExecuteSqlRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ExecuteSqlRequest build()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest |
|
buildPartial()
public ExecuteSqlRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest |
|
clear()
public ExecuteSqlRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
|
clearDatabase()
public ExecuteSqlRequest.Builder clearDatabase() 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 |
ExecuteSqlRequest.Builder |
This builder for chaining. |
clearInstance()
public ExecuteSqlRequest.Builder clearInstance()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 |
ExecuteSqlRequest.Builder |
This builder for chaining. |
clearPassword()
public ExecuteSqlRequest.Builder clearPassword()Optional. The database native user’s password.
string password = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
clearSqlStatement()
public ExecuteSqlRequest.Builder clearSqlStatement()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 |
ExecuteSqlRequest.Builder |
This builder for chaining. |
clearUser()
public ExecuteSqlRequest.Builder clearUser() 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) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
clearUserCredential()
public ExecuteSqlRequest.Builder clearUserCredential()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
|
clearValidateOnly()
public ExecuteSqlRequest.Builder clearValidateOnly()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 |
ExecuteSqlRequest.Builder |
This builder for chaining. |
getDatabase()
public 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 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. |
getDefaultInstanceForType()
public ExecuteSqlRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getInstance()
public 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 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 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 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 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 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 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) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The user. |
getUserBytes()
public 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) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for user. |
getUserCredentialCase()
public ExecuteSqlRequest.UserCredentialCase getUserCredentialCase()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.UserCredentialCase |
|
getValidateOnly()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ExecuteSqlRequest other)
public ExecuteSqlRequest.Builder mergeFrom(ExecuteSqlRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExecuteSqlRequest |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecuteSqlRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExecuteSqlRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
|
setDatabase(String value)
public ExecuteSqlRequest.Builder setDatabase(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe database to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setDatabaseBytes(ByteString value)
public ExecuteSqlRequest.Builder setDatabaseBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for database to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setInstance(String value)
public ExecuteSqlRequest.Builder setInstance(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe instance to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setInstanceBytes(ByteString value)
public ExecuteSqlRequest.Builder setInstanceBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for instance to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setPassword(String value)
public ExecuteSqlRequest.Builder setPassword(String value)Optional. The database native user’s password.
string password = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe password to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setPasswordBytes(ByteString value)
public ExecuteSqlRequest.Builder setPasswordBytes(ByteString value)Optional. The database native user’s password.
string password = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for password to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setSqlStatement(String value)
public ExecuteSqlRequest.Builder setSqlStatement(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe sqlStatement to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setSqlStatementBytes(ByteString value)
public ExecuteSqlRequest.Builder setSqlStatementBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for sqlStatement to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setUser(String value)
public ExecuteSqlRequest.Builder setUser(String value) 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) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe user to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setUserBytes(ByteString value)
public ExecuteSqlRequest.Builder setUserBytes(ByteString value) 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) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for user to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |
setValidateOnly(boolean value)
public ExecuteSqlRequest.Builder setValidateOnly(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe validateOnly to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder |
This builder for chaining. |