Class: Google::Cloud::Sql::V1beta4::ExecuteSqlPayload

Inherits:

Object

• Object
• Google::Cloud::Sql::V1beta4::ExecuteSqlPayload

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb

Overview

The request payload used to execute SQL statements.

Defined Under Namespace

Modules: PartialResultMode

Instance Attribute Summary

• #application ⇒ ::String

  Optional.

• #auto_iam_authn ⇒ ::Boolean

  Optional.

• #database ⇒ ::String

  Optional.

• #partial_result_mode ⇒ ::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::PartialResultMode

  Optional.

• #password_secret_version ⇒ ::String

  Optional.

• #row_limit ⇒ ::Integer

  Optional.

• #sql_statement ⇒ ::String

  Required.

• #user ⇒ ::String

  Optional.

Instance Attribute Details

#application ⇒ ::String

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end

#auto_iam_authn ⇒ ::Boolean

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end

#database ⇒ ::String

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end

#partial_result_mode ⇒ ::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::PartialResultMode

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end

#password_secret_version ⇒ ::String

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end

#row_limit ⇒ ::Integer

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end

#sql_statement ⇒ ::String

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end

#user ⇒ ::String

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb', line 1127

class ExecuteSqlPayload
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls how the API should respond when the SQL execution result exceeds
  # 10 MB.
  module PartialResultMode
    # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
    PARTIAL_RESULT_MODE_UNSPECIFIED = 0

    # Throw an error if the result exceeds 10 MB or if only a partial result
    # can be retrieved. Don't return the result.
    FAIL_PARTIAL_RESULT = 1

    # Return a truncated result and set `partial_result` to true if the result
    # exceeds 10 MB or if only a partial result can be retrieved due to error.
    # Don't throw an error.
    ALLOW_PARTIAL_RESULT = 2
  end
end