Console
    Contact Us Start free

    Google Cloud Sql Admin V1 Client - Class ConnectSettings (0.4.1)

    Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ConnectSettings.

    Connect settings retrieval response.

    Generated from protobuf message google.cloud.sql.v1.ConnectSettings

    Namespace

    Google \ Cloud \ Sql \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ kind
    string

    This is always sql#connectSettings .

    ↳ server_ca_cert
    Google\Cloud\Sql\V1\SslCert

    SSL configuration.

    ↳ ip_addresses
    array< Google\Cloud\Sql\V1\IpMapping >

    The assigned IP addresses for the instance.

    ↳ region
    string

    The cloud region for the instance. For example, us-central1 , europe-west1 . The region cannot be changed after instance creation.

    ↳ database_version
    int

    The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0 , MYSQL_5_7 (default), or MYSQL_5_6 . PostgreSQL instances: POSTGRES_9_6 , POSTGRES_10 , POSTGRES_11 , POSTGRES_12 (default), POSTGRES_13 , or POSTGRES_14 . SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE , SQLSERVER_2017_EXPRESS , SQLSERVER_2017_WEB , SQLSERVER_2019_STANDARD , SQLSERVER_2019_ENTERPRISE , SQLSERVER_2019_EXPRESS , or SQLSERVER_2019_WEB .

    ↳ backend_type
    int

    SECOND_GEN : Cloud SQL database instance. EXTERNAL : A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

    ↳ dns_name
    string

    The dns name of the instance.

    getKind

    This is always sql#connectSettings .

    Returns
    Type
    Description
    string

    setKind

    This is always sql#connectSettings .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getServerCaCert

    SSL configuration.

    Returns
    Type
    Description
    Google\Cloud\Sql\V1\SslCert |null

    hasServerCaCert

    clearServerCaCert

    setServerCaCert

    SSL configuration.

    Parameter
    Name
    Description
    var
    Google\Cloud\Sql\V1\SslCert
    Returns
    Type
    Description
    $this

    getIpAddresses

    The assigned IP addresses for the instance.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setIpAddresses

    The assigned IP addresses for the instance.

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Sql\V1\IpMapping >
    Returns
    Type
    Description
    $this

    getRegion

    The cloud region for the instance. For example, us-central1 , europe-west1 . The region cannot be changed after instance creation.

    Returns
    Type
    Description
    string

    setRegion

    The cloud region for the instance. For example, us-central1 , europe-west1 . The region cannot be changed after instance creation.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDatabaseVersion

    The database engine type and version. The databaseVersion field cannot be changed after instance creation.

    MySQL instances: MYSQL_8_0 , MYSQL_5_7 (default), or MYSQL_5_6 . PostgreSQL instances: POSTGRES_9_6 , POSTGRES_10 , POSTGRES_11 , POSTGRES_12 (default), POSTGRES_13 , or POSTGRES_14 . SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE , SQLSERVER_2017_EXPRESS , SQLSERVER_2017_WEB , SQLSERVER_2019_STANDARD , SQLSERVER_2019_ENTERPRISE , SQLSERVER_2019_EXPRESS , or SQLSERVER_2019_WEB .

    Returns
    Type
    Description
    int

    setDatabaseVersion

    The database engine type and version. The databaseVersion field cannot be changed after instance creation.

    MySQL instances: MYSQL_8_0 , MYSQL_5_7 (default), or MYSQL_5_6 . PostgreSQL instances: POSTGRES_9_6 , POSTGRES_10 , POSTGRES_11 , POSTGRES_12 (default), POSTGRES_13 , or POSTGRES_14 . SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE , SQLSERVER_2017_EXPRESS , SQLSERVER_2017_WEB , SQLSERVER_2019_STANDARD , SQLSERVER_2019_ENTERPRISE , SQLSERVER_2019_EXPRESS , or SQLSERVER_2019_WEB .

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getBackendType

    SECOND_GEN : Cloud SQL database instance.

    EXTERNAL : A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

    Returns
    Type
    Description
    int

    setBackendType

    SECOND_GEN : Cloud SQL database instance.

    EXTERNAL : A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getDnsName

    The dns name of the instance.

    Returns
    Type
    Description
    string

    setDnsName

    The dns name of the instance.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: