Class ConnectionSummary
Summary representation of a connection to a data asset.
Inherited Members
Namespace: Oci.DatacatalogService.Models
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class ConnectionSummary
Properties
DataAssetKey
Declaration
[JsonProperty(PropertyName = "dataAssetKey")]
public string DataAssetKey { get; set; }
Property Value
Type | Description |
---|---|
string | The 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 for this object as defined in the source systems. |
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. |
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 |
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. |
Uri
Declaration
[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }
Property Value
Type | Description |
---|---|
string | URI to the connection instance in the API. |