Show / Hide Table of Contents

Class Connection

Detailed representation of a connection to a data asset, minus any sensitive properties.

Inheritance
object
Connection
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatacatalogService.Models
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class Connection

Properties

CreatedById

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

OCID of the user who created the connection.

CustomPropertyMembers

Declaration
[JsonProperty(PropertyName = "customPropertyMembers")]
public List<CustomPropertyGetUsage> CustomPropertyMembers { get; set; }
Property Value
Type Description
List<CustomPropertyGetUsage>

The list of customized properties along with the values for this object

DataAssetKey

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

Unique key of the parent data asset.

Description

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

A description of the connection.

DisplayName

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

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExternalKey

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

Unique external key of this object from the source system.

IsDefault

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

Indicates whether this connection is the default connection.

Key

Declaration
[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type Description
string

Unique connection key that is immutable.

Remarks

Required

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current state of the connection.

Properties

Declaration
[JsonProperty(PropertyName = "properties")]
public Dictionary<string, Dictionary<string, string>> Properties { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, string>>

A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. Example: {"properties": { "default": { "username": "user1"}}}

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeStatusUpdated

Declaration
[JsonProperty(PropertyName = "timeStatusUpdated")]
public DateTime? TimeStatusUpdated { get; set; }
Property Value
Type Description
DateTime?

Time that the connections status was last updated. An RFC3339 formatted datetime string.

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The last time that any change was made to the connection. An RFC3339 formatted datetime string.

TypeKey

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

The key of the object type. Type key's can be found via the '/types' endpoint.

UpdatedById

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

OCID of the user who modified the connection.

Uri

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

URI to the connection instance in the API.

In this article
Back to top