Cloud SQL Admin API . flags

Instance Methods

close()

Close httplib2 connections.

list(databaseVersion=None, x__xgafv=None)

Lists all available database flags for Cloud SQL instances.

Method Details

close()
Close httplib2 connections.
list(databaseVersion=None, x__xgafv=None)
Lists all available database flags for Cloud SQL instances.

Args:
  databaseVersion: string, Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Flags list response.
  "items": [ # List of flags.
    { # A flag resource.
      "allowedIntValues": [ # Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.
        "A String",
      ],
      "allowedStringValues": [ # For `STRING` flags, a list of strings that the value can be set to.
        "A String",
      ],
      "appliesTo": [ # 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).
        "A String",
      ],
      "inBeta": True or False, # Whether or not the flag is considered in beta.
      "kind": "A String", # This is always `sql#flag`.
      "maxValue": "A String", # For `INTEGER` flags, the maximum allowed value.
      "minValue": "A String", # For `INTEGER` flags, the minimum allowed value.
      "name": "A String", # This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`
      "requiresRestart": True or False, # Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
      "type": "A String", # The type of the flag. Flags are typed to being `BOOLEAN`, `STRING`, `INTEGER` or `NONE`. `NONE` is used for flags which do not take a value, such as `skip_grant_tables`.
    },
  ],
  "kind": "A String", # This is always `sql#flagsList`.
}