Class ExecuteSqlRequest.Builder (0.44.0)

public static final class ExecuteSqlRequest.Builder extends GeneratedMessageV3.Builder<ExecuteSqlRequest.Builder> implements ExecuteSqlRequestOrBuilder

Request for ExecuteSql rpc.

Protobuf type google.cloud.alloydb.v1.ExecuteSqlRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecuteSqlRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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
Overrides

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.

clearField(Descriptors.FieldDescriptor field)

public ExecuteSqlRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecuteSqlRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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

clone()

public ExecuteSqlRequest.Builder clone()
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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
Overrides

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

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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExecuteSqlRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteSqlRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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 String

The 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 ByteString

The bytes for database to set.

Returns
Type Description
ExecuteSqlRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExecuteSqlRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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 String

The 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 ByteString

The 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 String

The 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 ByteString

The bytes for password to set.

Returns
Type Description
ExecuteSqlRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecuteSqlRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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 String

The 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 ByteString

The bytes for sqlStatement to set.

Returns
Type Description
ExecuteSqlRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteSqlRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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 String

The 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 ByteString

The bytes for user to set.

Returns
Type Description
ExecuteSqlRequest.Builder

This builder for chaining.