DataStream v1 API - Class MongodbProfile (2.13.0) 

public sealed class MongodbProfile : IMessage<MongodbProfile>, IEquatable<MongodbProfile>, IDeepCloneable<MongodbProfile>, IBufferMessage, IMessage

Reference documentation and code samples for the DataStream v1 API class MongodbProfile.

Profile for connecting to a MongoDB source.

Inheritance

object > MongodbProfile

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

MongodbProfile()

public MongodbProfile()

MongodbProfile(MongodbProfile)

public MongodbProfile(MongodbProfile other)
Parameter
Name Description
other MongodbProfile

Properties

AdditionalOptions

public MapField<string, string> AdditionalOptions { get; }

Optional. Specifies additional options for the MongoDB connection.

The options should be sent as key-value pairs, for example: additional_options = {"serverSelectionTimeoutMS": "10000", "directConnection": "true"}.

Keys are case-sensitive and should match the official MongoDB connection string options: https://www.mongodb.com/docs/manual/reference/connection-string-options/

The server will not modify the values provided by the user.

Property Value
Type Description
MapFieldstringstring

HostAddresses

public RepeatedField<HostAddress> HostAddresses { get; }

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.

Property Value
Type Description
RepeatedFieldHostAddress

MongodbConnectionFormatCase

public MongodbProfile.MongodbConnectionFormatOneofCase MongodbConnectionFormatCase { get; }
Property Value
Type Description
MongodbProfileMongodbConnectionFormatOneofCase

Password

public string Password { get; set; }

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

Property Value
Type Description
string

ReplicaSet

public string ReplicaSet { get; set; }

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.

Property Value
Type Description
string

SecretManagerStoredPassword

public string SecretManagerStoredPassword { get; set; }

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

Property Value
Type Description
string

SrvConnectionFormat

public SrvConnectionFormat SrvConnectionFormat { get; set; }

Srv connection format.

Property Value
Type Description
SrvConnectionFormat

SslConfig

public MongodbSslConfig SslConfig { get; set; }

Optional. SSL configuration for the MongoDB connection.

Property Value
Type Description
MongodbSslConfig

StandardConnectionFormat

public StandardConnectionFormat StandardConnectionFormat { get; set; }

Standard connection format.

Property Value
Type Description
StandardConnectionFormat

Username

public string Username { get; set; }

Required. Username for the MongoDB connection.

Property Value
Type Description
string