Class: Google::Apis::SqladminV1beta4::ExecuteSqlPayload

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1beta4/classes.rb,
lib/google/apis/sqladmin_v1beta4/representations.rb,
lib/google/apis/sqladmin_v1beta4/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.



1958
1959
1960
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1958

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) 


1907
1908
1909
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1907

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) 


1914
1915
1916
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1914

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) 


1920
1921
1922
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1920

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) 


1927
1928
1929
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1927

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`. This field is used together with theuserfield. The secret resource name will not be stored. Corresponds to the JSON propertypasswordSecretVersion`

Returns:

  • (String) 


1938
1939
1940
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1938

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) 


1943
1944
1945
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1943

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) 


1949
1950
1951
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1949

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) 


1956
1957
1958
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1956

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1963

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