Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::Flag (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::Flag.

A flag resource.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#allowed_int_values

def allowed_int_values() -> ::Array<::Integer>

Returns

(::Array<::Integer>) — Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.

#allowed_int_values=

def allowed_int_values=(value) -> ::Array<::Integer>

Parameter

value (::Array<::Integer>) — Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.

Returns

(::Array<::Integer>) — Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.

#allowed_string_values

def allowed_string_values() -> ::Array<::String>

Returns

(::Array<::String>) — For STRING flags, a list of strings that the value can be set to.

#allowed_string_values=

def allowed_string_values=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — For STRING flags, a list of strings that the value can be set to.

Returns

(::Array<::String>) — For STRING flags, a list of strings that the value can be set to.

#applies_to

def applies_to() -> ::Array<::Google::Cloud::Sql::V1::SqlDatabaseVersion>

Returns

(::Array<::Google::Cloud::Sql::V1::SqlDatabaseVersion>) — The database version this flag applies to. Can be MySQL instances: MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_5_7, or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12. SQL Server instances: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB. See the complete list.

#applies_to=

def applies_to=(value) -> ::Array<::Google::Cloud::Sql::V1::SqlDatabaseVersion>

Parameter

value (::Array<::Google::Cloud::Sql::V1::SqlDatabaseVersion>) — The database version this flag applies to. Can be MySQL instances: MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_5_7, or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12. SQL Server instances: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB. See the complete list.

Returns

(::Array<::Google::Cloud::Sql::V1::SqlDatabaseVersion>) — The database version this flag applies to. Can be MySQL instances: MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_5_7, or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12. SQL Server instances: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB. See the complete list.

#flag_scope

def flag_scope() -> ::Google::Cloud::Sql::V1::SqlFlagScope

Returns

(::Google::Cloud::Sql::V1::SqlFlagScope) — Scope of flag.

#flag_scope=

def flag_scope=(value) -> ::Google::Cloud::Sql::V1::SqlFlagScope

Parameter

value (::Google::Cloud::Sql::V1::SqlFlagScope) — Scope of flag.

Returns

(::Google::Cloud::Sql::V1::SqlFlagScope) — Scope of flag.

#in_beta

def in_beta() -> ::Google::Protobuf::BoolValue

Returns

(::Google::Protobuf::BoolValue) — Whether or not the flag is considered in beta.

#in_beta=

def in_beta=(value) -> ::Google::Protobuf::BoolValue

Parameter

value (::Google::Protobuf::BoolValue) — Whether or not the flag is considered in beta.

Returns

(::Google::Protobuf::BoolValue) — Whether or not the flag is considered in beta.

#kind

def kind() -> ::String

Returns

(::String) — This is always sql#flag.

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — This is always sql#flag.

Returns

(::String) — This is always sql#flag.

#max_value

def max_value() -> ::Google::Protobuf::Int64Value

Returns

(::Google::Protobuf::Int64Value) — For INTEGER flags, the maximum allowed value.

#max_value=

def max_value=(value) -> ::Google::Protobuf::Int64Value

Parameter

value (::Google::Protobuf::Int64Value) — For INTEGER flags, the maximum allowed value.

Returns

(::Google::Protobuf::Int64Value) — For INTEGER flags, the maximum allowed value.

#min_value

def min_value() -> ::Google::Protobuf::Int64Value

Returns

(::Google::Protobuf::Int64Value) — For INTEGER flags, the minimum allowed value.

#min_value=

def min_value=(value) -> ::Google::Protobuf::Int64Value

Parameter

value (::Google::Protobuf::Int64Value) — For INTEGER flags, the minimum allowed value.

Returns

(::Google::Protobuf::Int64Value) — For INTEGER flags, the minimum allowed value.

#name

def name() -> ::String

Returns

(::String) — This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

#name=

def name=(value) -> ::String

Parameter

value (::String) — This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

Returns

(::String) — This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

#recommended_int_value

def recommended_int_value() -> ::Google::Protobuf::Int64Value

Returns

(::Google::Protobuf::Int64Value) — Recommended int value in integer format for UI display.

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

#recommended_int_value=

def recommended_int_value=(value) -> ::Google::Protobuf::Int64Value

Parameter

value (::Google::Protobuf::Int64Value) — Recommended int value in integer format for UI display.

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

Returns

(::Google::Protobuf::Int64Value) — Recommended int value in integer format for UI display.

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

#recommended_string_value

def recommended_string_value() -> ::String

Returns

(::String) — Recommended string value in string format for UI display.

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

#recommended_string_value=

def recommended_string_value=(value) -> ::String

Parameter

value (::String) — Recommended string value in string format for UI display.

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

Returns

(::String) — Recommended string value in string format for UI display.

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

#requires_restart

def requires_restart() -> ::Google::Protobuf::BoolValue

Returns

(::Google::Protobuf::BoolValue) — Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

#requires_restart=

def requires_restart=(value) -> ::Google::Protobuf::BoolValue

Parameter

value (::Google::Protobuf::BoolValue) — Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

Returns

(::Google::Protobuf::BoolValue) — Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

#type

def type() -> ::Google::Cloud::Sql::V1::SqlFlagType

Returns

(::Google::Cloud::Sql::V1::SqlFlagType) — The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags that do not take a value, such as skip_grant_tables.

#type=

def type=(value) -> ::Google::Cloud::Sql::V1::SqlFlagType

Parameter

value (::Google::Cloud::Sql::V1::SqlFlagType) — The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags that do not take a value, such as skip_grant_tables.

Returns

(::Google::Cloud::Sql::V1::SqlFlagType) — The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags that do not take a value, such as skip_grant_tables.