Class ExecuteSqlPayload (0.1.0)

public final class ExecuteSqlPayload extends GeneratedMessage implements ExecuteSqlPayloadOrBuilder

The request payload used to execute SQL statements.

Protobuf type google.cloud.sql.v1beta4.ExecuteSqlPayload

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ExecuteSqlPayload

Implements

ExecuteSqlPayloadOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

APPLICATION_FIELD_NUMBER

public static final int APPLICATION_FIELD_NUMBER

Field Value
Type	Description
int

AUTO_IAM_AUTHN_FIELD_NUMBER

public static final int AUTO_IAM_AUTHN_FIELD_NUMBER

Field Value
Type	Description
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER

Field Value
Type	Description
int

PARTIAL_RESULT_MODE_FIELD_NUMBER

public static final int PARTIAL_RESULT_MODE_FIELD_NUMBER

Field Value
Type	Description
int

PASSWORD_SECRET_VERSION_FIELD_NUMBER

public static final int PASSWORD_SECRET_VERSION_FIELD_NUMBER

Field Value
Type	Description
int

ROW_LIMIT_FIELD_NUMBER

public static final int ROW_LIMIT_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 ExecuteSqlPayload getDefaultInstance()

Returns
Type	Description
ExecuteSqlPayload

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ExecuteSqlPayload.Builder newBuilder()

Returns
Type	Description
ExecuteSqlPayload.Builder

newBuilder(ExecuteSqlPayload prototype)

public static ExecuteSqlPayload.Builder newBuilder(ExecuteSqlPayload prototype)

Parameter
Name	Description
prototype	ExecuteSqlPayload

Returns
Type	Description
ExecuteSqlPayload.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteSqlPayload parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlPayload parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ExecuteSqlPayload parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlPayload parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteSqlPayload parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlPayload parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteSqlPayload parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlPayload parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ExecuteSqlPayload parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlPayload parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ExecuteSqlPayload parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlPayload parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteSqlPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ExecuteSqlPayload> parser()

Returns
Type	Description
Parser<ExecuteSqlPayload>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getApplication()

public String getApplication()

Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters.

string application = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The application.

getApplicationBytes()

public ByteString getApplicationBytes()

Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters.

string application = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for application.

getAutoIamAuthn()

public boolean getAutoIamAuthn()

Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database.

bool auto_iam_authn = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The autoIamAuthn.

getDatabase()

public String getDatabase()

Optional. Name of the database on which the statement will be executed.

string database = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Optional. Name of the database on which the statement will be executed.

string database = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for database.

getDefaultInstanceForType()

public ExecuteSqlPayload getDefaultInstanceForType()

Returns
Type	Description
ExecuteSqlPayload

getParserForType()

public Parser<ExecuteSqlPayload> getParserForType()

Returns
Type	Description
Parser<ExecuteSqlPayload>

Overrides

GeneratedMessage.getParserForType()

getPartialResultMode()

public ExecuteSqlPayload.PartialResultMode getPartialResultMode()

Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error.

.google.cloud.sql.v1beta4.ExecuteSqlPayload.PartialResultMode partial_result_mode = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ExecuteSqlPayload.PartialResultMode	The partialResultMode.

getPartialResultModeValue()

public int getPartialResultModeValue()

Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error.

.google.cloud.sql.v1beta4.ExecuteSqlPayload.PartialResultMode partial_result_mode = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for partialResultMode.

getPasswordSecretVersion()

public String getPasswordSecretVersion()

Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}. This field is used together with the user field. The secret resource name will not be stored.

string password_secret_version = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The passwordSecretVersion.

getPasswordSecretVersionBytes()

public ByteString getPasswordSecretVersionBytes()

Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}. This field is used together with the user field. The secret resource name will not be stored.

string password_secret_version = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for passwordSecretVersion.

getRowLimit()

public long getRowLimit()

Optional. The maximum number of rows returned per SQL statement.

int64 row_limit = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
long	The rowLimit.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSqlStatement()

public String getSqlStatement()

Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.

string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The sqlStatement.

getSqlStatementBytes()

public ByteString getSqlStatementBytes()

Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.

string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for sqlStatement.

getUser()

public String getUser()

Optional. The name of an existing database user to connect to the database. When auto_iam_authn is set to true, this field is ignored and the API caller's IAM user is used.

string user = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The user.

getUserBytes()

public ByteString getUserBytes()

Optional. The name of an existing database user to connect to the database. When auto_iam_authn is set to true, this field is ignored and the API caller's IAM user is used.

string user = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for user.

getUserPasswordCase()

public ExecuteSqlPayload.UserPasswordCase getUserPasswordCase()

Returns
Type	Description
ExecuteSqlPayload.UserPasswordCase

hasAutoIamAuthn()

public boolean hasAutoIamAuthn()

Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database.

bool auto_iam_authn = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the autoIamAuthn field is set.

hasPasswordSecretVersion()

public boolean hasPasswordSecretVersion()

Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}. This field is used together with the user field. The secret resource name will not be stored.

string password_secret_version = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the passwordSecretVersion field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ExecuteSqlPayload.Builder newBuilderForType()

Returns
Type	Description
ExecuteSqlPayload.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ExecuteSqlPayload.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ExecuteSqlPayload.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ExecuteSqlPayload.Builder toBuilder()

Returns
Type	Description
ExecuteSqlPayload.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException