Class DatabaseConnectionStringProfile

The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.

Inheritance

object

DatabaseConnectionStringProfile

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabaseService.Models

Assembly: OCI.DotNetSDK.Database.dll

Syntax

public class DatabaseConnectionStringProfile

Properties

ConsumerGroup

Declaration

[JsonProperty(PropertyName = "consumerGroup")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseConnectionStringProfile.ConsumerGroupEnum? ConsumerGroup { get; set; }

Property Value

Type	Description
DatabaseConnectionStringProfile.ConsumerGroupEnum?	Consumer group used by the connection.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name for the connection.

Remarks

Required

HostFormat

Declaration

[Required(ErrorMessage = "HostFormat is required.")]
[JsonProperty(PropertyName = "hostFormat")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseConnectionStringProfile.HostFormatEnum? HostFormat { get; set; }

Property Value

Type	Description
DatabaseConnectionStringProfile.HostFormatEnum?	Host format used in connection string.

Remarks

Required

IsRegional

Declaration

[JsonProperty(PropertyName = "isRegional")]
public bool? IsRegional { get; set; }

Property Value

Type	Description
bool?	True for a regional connection string, applicable to cross-region DG only.

Protocol

Declaration

[Required(ErrorMessage = "Protocol is required.")]
[JsonProperty(PropertyName = "protocol")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseConnectionStringProfile.ProtocolEnum? Protocol { get; set; }

Property Value

Type	Description
DatabaseConnectionStringProfile.ProtocolEnum?	Protocol used by the connection.

Remarks

Required

SessionMode

Declaration

[Required(ErrorMessage = "SessionMode is required.")]
[JsonProperty(PropertyName = "sessionMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseConnectionStringProfile.SessionModeEnum? SessionMode { get; set; }

Property Value

Type	Description
DatabaseConnectionStringProfile.SessionModeEnum?	Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session.

Remarks

Required

SyntaxFormat

Declaration

[Required(ErrorMessage = "SyntaxFormat is required.")]
[JsonProperty(PropertyName = "syntaxFormat")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseConnectionStringProfile.SyntaxFormatEnum? SyntaxFormat { get; set; }

Property Value

Type	Description
DatabaseConnectionStringProfile.SyntaxFormatEnum?	Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. Autonomous Database Serverless instances always use the long format.

Remarks

Required

TlsAuthentication

Declaration

[JsonProperty(PropertyName = "tlsAuthentication")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseConnectionStringProfile.TlsAuthenticationEnum? TlsAuthentication { get; set; }

Property Value

Type	Description
DatabaseConnectionStringProfile.TlsAuthenticationEnum?	Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication.

Value

Declaration

[Required(ErrorMessage = "Value is required.")]
[JsonProperty(PropertyName = "value")]
public string Value { get; set; }

Property Value

Type	Description
string	Connection string value.

Remarks

Required