com.google.api.services.sqladmin.model

Class ExecuteSqlPayload

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.sqladmin.model.ExecuteSqlPayload

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ExecuteSqlPayload
extends com.google.api.client.json.GenericJson

The request payload used to execute SQL statements.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExecuteSqlPayload()

Method Summary

Modifier and Type	Method and Description
ExecuteSqlPayload	clone()
Boolean	getAutoIamAuthn() Optional.
String	getDatabase() Optional.
String	getPartialResultMode() Optional.
Long	getRowLimit() Optional.
String	getSqlStatement() Required.
String	getUser() Optional.
ExecuteSqlPayload	set(String fieldName, Object value)
ExecuteSqlPayload	setAutoIamAuthn(Boolean autoIamAuthn) Optional.
ExecuteSqlPayload	setDatabase(String database) Optional.
ExecuteSqlPayload	setPartialResultMode(String partialResultMode) Optional.
ExecuteSqlPayload	setRowLimit(Long rowLimit) Optional.
ExecuteSqlPayload	setSqlStatement(String sqlStatement) Required.
ExecuteSqlPayload	setUser(String user) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ExecuteSqlPayload

public ExecuteSqlPayload()

Method Detail

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.

Returns:

value or null for none

setAutoIamAuthn

public ExecuteSqlPayload setAutoIamAuthn(Boolean autoIamAuthn)

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.

Parameters:

autoIamAuthn - autoIamAuthn or null for none

getDatabase

public String getDatabase()

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

Returns:

value or null for none

setDatabase

public ExecuteSqlPayload setDatabase(String database)

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

Parameters:

database - database or null for none

getPartialResultMode

public String 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.

Returns:

value or null for none

setPartialResultMode

public ExecuteSqlPayload setPartialResultMode(String partialResultMode)

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.

Parameters:

partialResultMode - partialResultMode or null for none

getRowLimit

public Long getRowLimit()

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

Returns:

value or null for none

setRowLimit

public ExecuteSqlPayload setRowLimit(Long rowLimit)

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

Parameters:

rowLimit - rowLimit or null for none

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.

Returns:

value or null for none

setSqlStatement

public ExecuteSqlPayload setSqlStatement(String sqlStatement)

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

Parameters:

sqlStatement - sqlStatement or null for none

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.

Returns:

value or null for none

setUser

public ExecuteSqlPayload setUser(String user)

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.

Parameters:

user - user or null for none

set

public ExecuteSqlPayload set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExecuteSqlPayload clone()

Overrides:

clone in class com.google.api.client.json.GenericJson