google-cloud-sql-v1 0.a → 0.1.0

data/proto_docs/google/cloud/sql/v1/cloud_sql_flags.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Sql
+      module V1
+        # Flags list request.
+        # @!attribute [rw] database_version
+        #   @return [::String]
+        #     Database type and version you want to retrieve flags for. By default, this
+        #     method returns flags for all database types and versions.
+        # @!attribute [rw] flag_scope
+        #   @return [::Google::Cloud::Sql::V1::SqlFlagScope]
+        #     Optional. Specify the scope of flags to be returned by SqlFlagsListService.
+        #     Return list of database flags if unspecified.
+        class SqlFlagsListRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Flags list response.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#flagsList`.
+        # @!attribute [rw] items
+        #   @return [::Array<::Google::Cloud::Sql::V1::Flag>]
+        #     List of flags.
+        class FlagsListResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A flag resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     This is the name of the flag. Flag names always use underscores, not
+        #     hyphens, for example: `max_allowed_packet`
+        # @!attribute [rw] type
+        #   @return [::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`.
+        # @!attribute [rw] applies_to
+        #   @return [::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](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
+        # @!attribute [rw] allowed_string_values
+        #   @return [::Array<::String>]
+        #     For `STRING` flags, a list of strings that the value can be set to.
+        # @!attribute [rw] min_value
+        #   @return [::Google::Protobuf::Int64Value]
+        #     For `INTEGER` flags, the minimum allowed value.
+        # @!attribute [rw] max_value
+        #   @return [::Google::Protobuf::Int64Value]
+        #     For `INTEGER` flags, the maximum allowed value.
+        # @!attribute [rw] requires_restart
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Indicates whether changing this flag will trigger a database restart. Only
+        #     applicable to Second Generation instances.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#flag`.
+        # @!attribute [rw] in_beta
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether or not the flag is considered in beta.
+        # @!attribute [rw] allowed_int_values
+        #   @return [::Array<::Integer>]
+        #     Use this field if only certain integers are accepted. Can be combined
+        #     with min_value and max_value to add additional values.
+        # @!attribute [rw] flag_scope
+        #   @return [::Google::Cloud::Sql::V1::SqlFlagScope]
+        #     Scope of flag.
+        # @!attribute [rw] recommended_string_value
+        #   @return [::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.
+        # @!attribute [rw] recommended_int_value
+        #   @return [::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.
+        class Flag
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        module SqlFlagType
+          # This is an unknown flag type.
+          SQL_FLAG_TYPE_UNSPECIFIED = 0
+
+          # Boolean type flag.
+          BOOLEAN = 1
+
+          # String type flag.
+          STRING = 2
+
+          # Integer type flag.
+          INTEGER = 3
+
+          # Flag type used for a server startup option.
+          NONE = 4
+
+          # Type introduced specially for MySQL TimeZone offset. Accept a string value
+          # with the format [-12:59, 13:00].
+          MYSQL_TIMEZONE_OFFSET = 5
+
+          # Float type flag.
+          FLOAT = 6
+
+          # Comma-separated list of the strings in a SqlFlagType enum.
+          REPEATED_STRING = 7
+        end
+
+        # Scopes of a flag describe where the flag is used.
+        module SqlFlagScope
+          # Assume database flags if unspecified
+          SQL_FLAG_SCOPE_UNSPECIFIED = 0
+
+          # database flags
+          SQL_FLAG_SCOPE_DATABASE = 1
+
+          # connection pool configuration flags
+          SQL_FLAG_SCOPE_CONNECTION_POOL = 2
+        end
+      end
+    end
+  end
+end