Show / Hide Table of Contents

Class OracleNosqlConnection

Represents the metadata of an Oracle NoSQL Connection.

Inheritance
object
Connection
OracleNosqlConnection
Inherited Members
Connection.Id
Connection.DisplayName
Connection.Description
Connection.CompartmentId
Connection.FreeformTags
Connection.DefinedTags
Connection.SystemTags
Connection.LifecycleState
Connection.LifecycleDetails
Connection.TimeCreated
Connection.TimeUpdated
Connection.Locks
Connection.VaultId
Connection.KeyId
Connection.IngressIps
Connection.NsgIds
Connection.SubnetId
Connection.RoutingMethod
Connection.DoesUseSecretIds
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class OracleNosqlConnection : Connection

Properties

PrivateKeyFileSecretId

Declaration
[JsonProperty(PropertyName = "privateKeyFileSecretId")]
public string PrivateKeyFileSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.

PrivateKeyPassphraseSecretId

Declaration
[JsonProperty(PropertyName = "privateKeyPassphraseSecretId")]
public string PrivateKeyPassphraseSecretId { get; set; }
Property Value
Type Description
string

The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.

PublicKeyFingerprint

Declaration
[JsonProperty(PropertyName = "publicKeyFingerprint")]
public string PublicKeyFingerprint { get; set; }
Property Value
Type Description
string

The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

Region

Declaration
[JsonProperty(PropertyName = "region")]
public string Region { get; set; }
Property Value
Type Description
string

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

ShouldUseResourcePrincipal

Declaration
[JsonProperty(PropertyName = "shouldUseResourcePrincipal")]
public bool? ShouldUseResourcePrincipal { get; set; }
Property Value
Type Description
bool?

Indicates that the user intents to connect to the instance through resource principal.

TechnologyType

Declaration
[Required(ErrorMessage = "TechnologyType is required.")]
[JsonProperty(PropertyName = "technologyType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OracleNosqlConnection.TechnologyTypeEnum? TechnologyType { get; set; }
Property Value
Type Description
OracleNosqlConnection.TechnologyTypeEnum?

The Oracle NoSQL technology type.

Remarks

Required

TenancyId

Declaration
[JsonProperty(PropertyName = "tenancyId")]
public string TenancyId { get; set; }
Property Value
Type Description
string

The OCID of the related OCI tenancy.

UserId

Declaration
[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }
Property Value
Type Description
string

The OCID of the OCI user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.

In this article
Back to top