public interface ExecuteSqlPayloadOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getApplication()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getPartialResultMode()
public abstract 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.v1.ExecuteSqlPayload.PartialResultMode partial_result_mode = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlPayload.PartialResultMode |
The partialResultMode. |
getPartialResultModeValue()
public abstract 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.v1.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 abstract 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}.
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 abstract 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}.
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 abstract 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. |
getSqlStatement()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract ExecuteSqlPayload.UserPasswordCase getUserPasswordCase()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlPayload.UserPasswordCase |
|
hasAutoIamAuthn()
public abstract 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 abstract 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}.
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. |