Class OracleAiDataPlatformConnection
Represents the metadata of an Oracle AI Data Platform Connection.
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class OracleAiDataPlatformConnection : Connection
Properties
ConnectionUrl
Declaration
[Required(ErrorMessage = "ConnectionUrl is required.")]
[JsonProperty(PropertyName = "connectionUrl")]
public string ConnectionUrl { get; set; }
Property Value
Type | Description |
---|---|
string | Connection URL. It must start with 'jdbc:spark://' |
Remarks
Required
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? | Specifies that the user intends to authenticate to the instance using a resource principal. Default: false |
TechnologyType
Declaration
[Required(ErrorMessage = "TechnologyType is required.")]
[JsonProperty(PropertyName = "technologyType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OracleAiDataPlatformConnection.TechnologyTypeEnum? TechnologyType { get; set; }
Property Value
Type | Description |
---|---|
OracleAiDataPlatformConnection.TechnologyTypeEnum? | The Oracle AI Data Platform 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 Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. |