Google Cloud Datastream V1 Client - Class MongodbProfile (2.4.0)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class MongodbProfile.

MongoDB profile.

Generated from protobuf message google.cloud.datastream.v1.MongodbProfile

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ host_addresses
array< HostAddress >

Required. List of host addresses for a MongoDB cluster. For SRV connection format, this list must contain exactly one DNS host without a port. For Standard connection format, this list must contain all the required hosts in the cluster with their respective ports.

↳ replica_set
string

Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. For SRV connection format, this field must be empty. For Standard connection format, this field must be specified.

↳ username
string

Required. Username for the MongoDB connection.

↳ password
string

Optional. Password for the MongoDB connection. Mutually exclusive with the secret_manager_stored_password field.

↳ secret_manager_stored_password
string

Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the password field.

↳ ssl_config
MongodbSslConfig

Optional. SSL configuration for the MongoDB connection.

↳ srv_connection_format
SrvConnectionFormat

Srv connection format.

↳ standard_connection_format
StandardConnectionFormat

Standard connection format.

getHostAddresses

Required. List of host addresses for a MongoDB cluster.

For SRV connection format, this list must contain exactly one DNS host without a port. For Standard connection format, this list must contain all the required hosts in the cluster with their respective ports.

Returns
Type
Description

setHostAddresses

Required. List of host addresses for a MongoDB cluster.

For SRV connection format, this list must contain exactly one DNS host without a port. For Standard connection format, this list must contain all the required hosts in the cluster with their respective ports.

Parameter
Name
Description
var
array< HostAddress >
Returns
Type
Description
$this

getReplicaSet

Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. For SRV connection format, this field must be empty.

For Standard connection format, this field must be specified.

Returns
Type
Description
string

setReplicaSet

Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. For SRV connection format, this field must be empty.

For Standard connection format, this field must be specified.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUsername

Required. Username for the MongoDB connection.

Returns
Type
Description
string

setUsername

Required. Username for the MongoDB connection.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPassword

Optional. Password for the MongoDB connection. Mutually exclusive with the secret_manager_stored_password field.

Returns
Type
Description
string

setPassword

Optional. Password for the MongoDB connection. Mutually exclusive with the secret_manager_stored_password field.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSecretManagerStoredPassword

Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the password field.

Returns
Type
Description
string

setSecretManagerStoredPassword

Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the password field.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSslConfig

Optional. SSL configuration for the MongoDB connection.

Returns
Type
Description

hasSslConfig

clearSslConfig

setSslConfig

Optional. SSL configuration for the MongoDB connection.

Parameter
Name
Description
Returns
Type
Description
$this

getSrvConnectionFormat

Srv connection format.

Returns
Type
Description

hasSrvConnectionFormat

setSrvConnectionFormat

Srv connection format.

Parameter
Name
Description
Returns
Type
Description
$this

getStandardConnectionFormat

Standard connection format.

Returns
Type
Description

hasStandardConnectionFormat

setStandardConnectionFormat

Standard connection format.

Parameter
Name
Description
Returns
Type
Description
$this

getMongodbConnectionFormat

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