Console
    Contact Us Start free

    Google Cloud AlloyDB for PostgreSQL V1 Client - Class SupportedDatabaseFlag (1.4.0)

    Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class 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.

    Generated from protobuf message google.cloud.alloydb.v1.SupportedDatabaseFlag

    Namespace

    Google \ Cloud \ AlloyDb \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ string_restrictions
    SupportedDatabaseFlag\StringRestrictions

    Restriction on STRING type value.

    ↳ integer_restrictions
    SupportedDatabaseFlag\IntegerRestrictions

    Restriction on INTEGER type value.

    ↳ recommended_string_value
    string

    The recommended value for a STRING flag.

    ↳ recommended_integer_value
    Google\Protobuf\Int64Value

    The recommended value for an INTEGER flag.

    ↳ name
    string

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

    ↳ flag_name
    string

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

    ↳ value_type
    int
    ↳ accepts_multiple_values
    bool

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

    ↳ supported_db_versions
    array

    Major database engine versions for which this flag is supported.

    ↳ requires_db_restart
    bool

    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).

    ↳ scope
    int

    The scope of the flag.

    getStringRestrictions

    Restriction on STRING type value.

    Returns
    Type
    Description
    SupportedDatabaseFlag\StringRestrictions |null

    hasStringRestrictions

    setStringRestrictions

    Restriction on STRING type value.

    Parameter
    Name
    Description
    var
    SupportedDatabaseFlag\StringRestrictions
    Returns
    Type
    Description
    $this

    getIntegerRestrictions

    Restriction on INTEGER type value.

    Returns
    Type
    Description
    SupportedDatabaseFlag\IntegerRestrictions |null

    hasIntegerRestrictions

    setIntegerRestrictions

    Restriction on INTEGER type value.

    Parameter
    Name
    Description
    var
    SupportedDatabaseFlag\IntegerRestrictions
    Returns
    Type
    Description
    $this

    getRecommendedStringValue

    The recommended value for a STRING flag.

    Returns
    Type
    Description
    string

    hasRecommendedStringValue

    setRecommendedStringValue

    The recommended value for a STRING flag.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRecommendedIntegerValue

    The recommended value for an INTEGER flag.

    Returns
    Type
    Description
    Google\Protobuf\Int64Value |null

    hasRecommendedIntegerValue

    getRecommendedIntegerValueUnwrapped

    Returns the unboxed value from getRecommendedIntegerValue()

    The recommended value for an INTEGER flag.

    Returns
    Type
    Description
    int|string|null

    setRecommendedIntegerValue

    The recommended value for an INTEGER flag.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Int64Value
    Returns
    Type
    Description
    $this

    setRecommendedIntegerValueUnwrapped

    Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

    The recommended value for an INTEGER flag.

    Parameter
    Name
    Description
    var
    int|string|null
    Returns
    Type
    Description
    $this

    getName

    The name of the flag resource, following Google Cloud conventions, e.g.:

    • projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    Returns
    Type
    Description
    string

    setName

    The name of the flag resource, following Google Cloud conventions, e.g.:

    • projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFlagName

    The name of the database flag, e.g. "max_allowed_packets".

    The is a possibly key for the Instance.database_flags map field.

    Returns
    Type
    Description
    string

    setFlagName

    The name of the database flag, e.g. "max_allowed_packets".

    The is a possibly key for the Instance.database_flags map field.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getValueType

    Generated from protobuf field .google.cloud.alloydb.v1.SupportedDatabaseFlag.ValueType value_type = 3;

    Returns
    Type
    Description
    int

    setValueType

    Generated from protobuf field .google.cloud.alloydb.v1.SupportedDatabaseFlag.ValueType value_type = 3;

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getAcceptsMultipleValues

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

    Returns
    Type
    Description
    bool

    setAcceptsMultipleValues

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

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getSupportedDbVersions

    Major database engine versions for which this flag is supported.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSupportedDbVersions

    Major database engine versions for which this flag is supported.

    Parameter
    Name
    Description
    var
    int[]
    Returns
    Type
    Description
    $this

    getRequiresDbRestart

    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).

    Returns
    Type
    Description
    bool

    setRequiresDbRestart

    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).

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getScope

    The scope of the flag.

    Returns
    Type
    Description
    int

    setScope

    The scope of the flag.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getRestrictions

    Returns
    Type
    Description
    string

    getRecommendedValue

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: