Method: projects.locations.supportedDatabaseFlags.list

Stay organized with collections Save and categorize content based on your preferences.

Lists SupportedDatabaseFlags for a given project and location.

HTTP request

GET https://alloydb.googleapis.com/v1beta/{parent=projects/*/locations/*}/supportedDatabaseFlags

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}

Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not not yet support region-specific flags (see b/211502903).

Authorization requires the following IAM permission on the specified resource parent:

  • alloydb.supportedDatabaseFlags.list

Query parameters

Parameters
pageSize

integer

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken

string

A token identifying a page of results the server should return.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Message for response to listing SupportedDatabaseFlags.

JSON representation
{
  "supportedDatabaseFlags": [
    {
      object (SupportedDatabaseFlag)
    }
  ],
  "nextPageToken": string
}
Fields
supportedDatabaseFlags[]

object (SupportedDatabaseFlag)

The list of SupportedDatabaseFlags.

nextPageToken

string

A token identifying a page of results the server should return.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SupportedDatabaseFlag

SupportedDatabaseFlag gives general information about a database flag, like type and allowed values. This is a static value that is defined on the server side, and it cannot be modified by callers. To set the Database flags on a particular Instance, a caller should modify the Instance.database_flags field.

JSON representation
{
  "name": string,
  "flagName": string,
  "valueType": enum (ValueType),
  "acceptsMultipleValues": boolean,
  "supportedDbVersions": [
    enum (DatabaseVersion)
  ],
  "requiresDbRestart": boolean,

  // Union field restrictions can be only one of the following:
  "stringRestrictions": {
    object (StringRestrictions)
  },
  "integerRestrictions": {
    object (IntegerRestrictions)
  }
  // End of list of possible types for union field restrictions.
}
Fields
name

string

The name of the flag resource, following GCP conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.

flagName

string

The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.

valueType

enum (ValueType)

acceptsMultipleValues

boolean

Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.

supportedDbVersions[]

enum (DatabaseVersion)

Major database engine versions for which this flag is supported.

requiresDbRestart

boolean

Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).

Union field restrictions. The restrictions on the flag value per type. restrictions can be only one of the following:
stringRestrictions

object (StringRestrictions)

Restriction on STRING type value.

integerRestrictions

object (IntegerRestrictions)

Restriction on INTEGER type value.

StringRestrictions

Restrictions on STRING type values

JSON representation
{
  "allowedValues": [
    string
  ]
}
Fields
allowedValues[]

string

The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.

IntegerRestrictions

Restrictions on INTEGER type values.

JSON representation
{
  "minValue": string,
  "maxValue": string
}
Fields
minValue

string (Int64Value format)

The minimum value that can be specified, if applicable.

maxValue

string (Int64Value format)

The maximum value that can be specified, if applicable.

ValueType

ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14".

Enums
VALUE_TYPE_UNSPECIFIED This is an unknown flag type.
STRING String type flag.
INTEGER Integer type flag.
FLOAT Float type flag.
NONE Denotes that the flag does not accept any values.