Class CreateConnectionDetails

Properties used in connection create operations.

Inheritance

object

CreateConnectionDetails

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 CreateConnectionDetails

Properties

CustomPropertyMembers

Declaration

[JsonProperty(PropertyName = "customPropertyMembers")]
public List<CustomPropertySetUsage> CustomPropertyMembers { get; set; }

Property Value

Type	Description
List<CustomPropertySetUsage>	The list of customized properties along with the values for this object

Description

Declaration

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

Property Value

Type	Description
string	A description of 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 display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

EncProperties

Declaration

[JsonProperty(PropertyName = "encProperties")]
public Dictionary<string, Dictionary<string, string>> EncProperties { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, string>>	A map of maps that contains the encrypted values for sensitive 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. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}

Type

Description

Dictionary<string, Dictionary<string, string>>

A map of maps that contains the encrypted values for sensitive 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. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}

IsDefault

Declaration

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

Property Value

Type	Description
bool?	Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.

Type

Description

bool?

Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.

Properties

Declaration

[Required(ErrorMessage = "Properties is required.")]
[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. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"properties": { "default": { "username": "user1"}}}

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. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"properties": { "default": { "username": "user1"}}}

Remarks

Required

TypeKey

Declaration

[Required(ErrorMessage = "TypeKey is required.")]
[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.

Remarks

Required