Class: Google::Apis::SqladminV1::ExecuteSqlPayload

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb

Overview

The request payload used to execute SQL statements.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExecuteSqlPayload

Returns a new instance of ExecuteSqlPayload.



1968
1969
1970
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1968

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#application ⇒ 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. Corresponds to the JSON property application

Returns:

  • (String) 


1917
1918
1919
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1917

def application
  @application
end

#auto_iam_authn ⇒ Boolean Also known as: auto_iam_authn?

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. Corresponds to the JSON property autoIamAuthn

Returns:

  • (Boolean) 


1924
1925
1926
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1924

def auto_iam_authn
  @auto_iam_authn
end

#database ⇒ String

Optional. Name of the database on which the statement will be executed. Corresponds to the JSON property database

Returns:

  • (String) 


1930
1931
1932
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1930

def database
  @database
end

#partial_result_mode ⇒ String

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. Corresponds to the JSON property partialResultMode

Returns:

  • (String) 


1937
1938
1939
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1937

def partial_result_mode
  @partial_result_mode
end

#password_secret_version ⇒ 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`. Used together with theuserfield. The secret resource name will not be stored. Corresponds to the JSON propertypasswordSecretVersion`

Returns:

  • (String) 


1948
1949
1950
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1948

def password_secret_version
  @password_secret_version
end

#row_limit ⇒ Fixnum

Optional. The maximum number of rows returned per SQL statement. Corresponds to the JSON property rowLimit

Returns:

  • (Fixnum) 


1953
1954
1955
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1953

def row_limit
  @row_limit
end

#sql_statement ⇒ String

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

Returns:

  • (String) 


1959
1960
1961
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1959

def sql_statement
  @sql_statement
end

#user ⇒ 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. Corresponds to the JSON property user

Returns:

  • (String) 


1966
1967
1968
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1966

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1973

def update!(**args)
  @application = args[:application] if args.key?(:application)
  @auto_iam_authn = args[:auto_iam_authn] if args.key?(:auto_iam_authn)
  @database = args[:database] if args.key?(:database)
  @partial_result_mode = args[:partial_result_mode] if args.key?(:partial_result_mode)
  @password_secret_version = args[:password_secret_version] if args.key?(:password_secret_version)
  @row_limit = args[:row_limit] if args.key?(:row_limit)
  @sql_statement = args[:sql_statement] if args.key?(:sql_statement)
  @user = args[:user] if args.key?(:user)
end