Google Cloud Discovery Engine V1 Client - Class AlloyDbConnectionConfig (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class AlloyDbConnectionConfig.

Configuration for connecting to AlloyDB.

Generated from protobuf message google.cloud.discoveryengine.v1.DataStore.FederatedSearchConfig.AlloyDbConfig.AlloyDbConnectionConfig

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ DataStore \ FederatedSearchConfig \ AlloyDbConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ instance string

Required. The AlloyDB instance to connect to.

↳ database string

Required. The AlloyDB database to connect to.

↳ user string

Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.

↳ password string

Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.

↳ auth_mode int

Optional. Auth mode.

↳ enable_psvs bool

Optional. If true, enable PSVS for AlloyDB.

getInstance

Required. The AlloyDB instance to connect to.

Returns
Type Description
string

setInstance

Required. The AlloyDB instance to connect to.

Parameter
Name Description
var string
Returns
Type Description
$this

getDatabase

Required. The AlloyDB database to connect to.

Returns
Type Description
string

setDatabase

Required. The AlloyDB database to connect to.

Parameter
Name Description
var string
Returns
Type Description
$this

getUser

Required. Database user.

If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.

Returns
Type Description
string

setUser

Required. Database user.

If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.

Parameter
Name Description
var string
Returns
Type Description
$this

getPassword

Required. Database password.

If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.

Returns
Type Description
string

setPassword

Required. Database password.

If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.

Parameter
Name Description
var string
Returns
Type Description
$this

getAuthMode

Optional. Auth mode.

Returns
Type Description
int Enum of type AuthMode.

setAuthMode

Optional. Auth mode.

Parameter
Name Description
var int

Enum of type AuthMode.

Returns
Type Description
$this

getEnablePsvs

Optional. If true, enable PSVS for AlloyDB.

Returns
Type Description
bool

setEnablePsvs

Optional. If true, enable PSVS for AlloyDB.

Parameter
Name Description
var bool
Returns
Type Description
$this