Class ExecuteSqlRequest (0.42.0)

public final class ExecuteSqlRequest extends GeneratedMessageV3 implements ExecuteSqlRequestOrBuilder

Request for ExecuteSql rpc.

Protobuf type google.cloud.alloydb.v1.ExecuteSqlRequest

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

PASSWORD_FIELD_NUMBER

public static final int PASSWORD_FIELD_NUMBER
Field Value
Type Description
int

SQL_STATEMENT_FIELD_NUMBER

public static final int SQL_STATEMENT_FIELD_NUMBER
Field Value
Type Description
int

USER_FIELD_NUMBER

public static final int USER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteSqlRequest getDefaultInstance()
Returns
Type Description
ExecuteSqlRequest

getDescriptor()

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

newBuilder()

public static ExecuteSqlRequest.Builder newBuilder()
Returns
Type Description
ExecuteSqlRequest.Builder

newBuilder(ExecuteSqlRequest prototype)

public static ExecuteSqlRequest.Builder newBuilder(ExecuteSqlRequest prototype)
Parameter
Name Description
prototype ExecuteSqlRequest
Returns
Type Description
ExecuteSqlRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteSqlRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExecuteSqlRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteSqlRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteSqlRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExecuteSqlRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExecuteSqlRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExecuteSqlRequest> parser()
Returns
Type Description
Parser<ExecuteSqlRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

public Parser<ExecuteSqlRequest> getParserForType()
Returns
Type Description
Parser<ExecuteSqlRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExecuteSqlRequest.Builder newBuilderForType()
Returns
Type Description
ExecuteSqlRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecuteSqlRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExecuteSqlRequest.Builder toBuilder()
Returns
Type Description
ExecuteSqlRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException