Cloud SQL Admin V1BETA4 API - Class Google::Cloud::Sql::V1beta4::ExecuteSqlPayload (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1BETA4 API class Google::Cloud::Sql::V1beta4::ExecuteSqlPayload.

The request payload used to execute SQL statements.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#application

def application() -> ::String

Returns

• (::String) — 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.

#application=

def application=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#auto_iam_authn

def auto_iam_authn() -> ::Boolean

Returns

• (::Boolean) — 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.

  Note: The following fields are mutually exclusive: auto_iam_authn, password_secret_version. If a field in that set is populated, all other fields in the set will automatically be cleared.

#auto_iam_authn=

def auto_iam_authn=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

  Note: The following fields are mutually exclusive: auto_iam_authn, password_secret_version. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Boolean) — 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.

  Note: The following fields are mutually exclusive: auto_iam_authn, password_secret_version. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database

def database() -> ::String

Returns

• (::String) — Optional. Name of the database on which the statement will be executed.

#database=

def database=(value) -> ::String

Parameter

• value (::String) — Optional. Name of the database on which the statement will be executed.

Returns

• (::String) — Optional. Name of the database on which the statement will be executed.

#partial_result_mode

def partial_result_mode() -> ::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::PartialResultMode

Returns

• (::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::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.

#partial_result_mode=

def partial_result_mode=(value) -> ::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::PartialResultMode

Parameter

• value (::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::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.

Returns

• (::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::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.

#password_secret_version

def password_secret_version() -> ::String

Returns

• (::String) — 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.

  Note: The following fields are mutually exclusive: password_secret_version, auto_iam_authn. If a field in that set is populated, all other fields in the set will automatically be cleared.

#password_secret_version=

def password_secret_version=(value) -> ::String

Parameter

• value (::String) — 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.

  Note: The following fields are mutually exclusive: password_secret_version, auto_iam_authn. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — 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.

  Note: The following fields are mutually exclusive: password_secret_version, auto_iam_authn. If a field in that set is populated, all other fields in the set will automatically be cleared.

#row_limit

def row_limit() -> ::Integer

Returns

• (::Integer) — Optional. The maximum number of rows returned per SQL statement.

#row_limit=

def row_limit=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. The maximum number of rows returned per SQL statement.

Returns

• (::Integer) — Optional. The maximum number of rows returned per SQL statement.

#sql_statement

def sql_statement() -> ::String

Returns

• (::String) — Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.

#sql_statement=

def sql_statement=(value) -> ::String

Parameter

• value (::String) — Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.

Returns

• (::String) — Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.

#user

def user() -> ::String

Returns

• (::String) — 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.

#user=

def user=(value) -> ::String

Parameter

• value (::String) — 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

• (::String) — 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.