CreateConnectionDetails

class oci.data_connectivity.models.CreateConnectionDetails(**kwargs)

Bases: object

Properties used in connection create operations.

Methods

__init__(**kwargs) Initializes a new CreateConnectionDetails object with values from keyword arguments.

Attributes

connection_properties Gets the connection_properties of this CreateConnectionDetails.
description Gets the description of this CreateConnectionDetails.
identifier [Required] Gets the identifier of this CreateConnectionDetails.
is_default Gets the is_default of this CreateConnectionDetails.
key Gets the key of this CreateConnectionDetails.
metadata Gets the metadata of this CreateConnectionDetails.
model_type Gets the model_type of this CreateConnectionDetails.
model_version Gets the model_version of this CreateConnectionDetails.
name [Required] Gets the name of this CreateConnectionDetails.
object_status Gets the object_status of this CreateConnectionDetails.
object_version Gets the object_version of this CreateConnectionDetails.
primary_schema Gets the primary_schema of this CreateConnectionDetails.
properties [Required] Gets the properties of this CreateConnectionDetails.
registry_metadata Gets the registry_metadata of this CreateConnectionDetails.
type [Required] Gets the type of this CreateConnectionDetails.
__init__(**kwargs)

Initializes a new CreateConnectionDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • key (str) – The value to assign to the key property of this CreateConnectionDetails.
  • model_version (str) – The value to assign to the model_version property of this CreateConnectionDetails.
  • model_type (str) – The value to assign to the model_type property of this CreateConnectionDetails.
  • name (str) – The value to assign to the name property of this CreateConnectionDetails.
  • description (str) – The value to assign to the description property of this CreateConnectionDetails.
  • object_version (int) – The value to assign to the object_version property of this CreateConnectionDetails.
  • object_status (int) – The value to assign to the object_status property of this CreateConnectionDetails.
  • identifier (str) – The value to assign to the identifier property of this CreateConnectionDetails.
  • primary_schema (oci.data_connectivity.models.Schema) – The value to assign to the primary_schema property of this CreateConnectionDetails.
  • connection_properties (list[oci.data_connectivity.models.ConnectionProperty]) – The value to assign to the connection_properties property of this CreateConnectionDetails.
  • properties (dict(str, object)) – The value to assign to the properties property of this CreateConnectionDetails.
  • type (str) – The value to assign to the type property of this CreateConnectionDetails.
  • is_default (bool) – The value to assign to the is_default property of this CreateConnectionDetails.
  • metadata (oci.data_connectivity.models.ObjectMetadata) – The value to assign to the metadata property of this CreateConnectionDetails.
  • registry_metadata (oci.data_connectivity.models.RegistryMetadata) – The value to assign to the registry_metadata property of this CreateConnectionDetails.
connection_properties

Gets the connection_properties of this CreateConnectionDetails. The properties for the connection.

Returns:The connection_properties of this CreateConnectionDetails.
Return type:list[oci.data_connectivity.models.ConnectionProperty]
description

Gets the description of this CreateConnectionDetails. User-defined description for the connection.

Returns:The description of this CreateConnectionDetails.
Return type:str
identifier

[Required] Gets the identifier of this CreateConnectionDetails. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:The identifier of this CreateConnectionDetails.
Return type:str
is_default

Gets the is_default of this CreateConnectionDetails. The default property for the connection.

Returns:The is_default of this CreateConnectionDetails.
Return type:bool
key

Gets the key of this CreateConnectionDetails. Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create.

Returns:The key of this CreateConnectionDetails.
Return type:str
metadata

Gets the metadata of this CreateConnectionDetails.

Returns:The metadata of this CreateConnectionDetails.
Return type:oci.data_connectivity.models.ObjectMetadata
model_type

Gets the model_type of this CreateConnectionDetails. The type of the object.

Returns:The model_type of this CreateConnectionDetails.
Return type:str
model_version

Gets the model_version of this CreateConnectionDetails. The model version of an object.

Returns:The model_version of this CreateConnectionDetails.
Return type:str
name

[Required] Gets the name of this CreateConnectionDetails. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:The name of this CreateConnectionDetails.
Return type:str
object_status

Gets the object_status of this CreateConnectionDetails. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:The object_status of this CreateConnectionDetails.
Return type:int
object_version

Gets the object_version of this CreateConnectionDetails. The version of the object that is used to track changes in the object instance.

Returns:The object_version of this CreateConnectionDetails.
Return type:int
primary_schema

Gets the primary_schema of this CreateConnectionDetails.

Returns:The primary_schema of this CreateConnectionDetails.
Return type:oci.data_connectivity.models.Schema
properties

[Required] Gets the properties of this CreateConnectionDetails. All the properties for the connection in a key-value map format.

Returns:The properties of this CreateConnectionDetails.
Return type:dict(str, object)
registry_metadata

Gets the registry_metadata of this CreateConnectionDetails.

Returns:The registry_metadata of this CreateConnectionDetails.
Return type:oci.data_connectivity.models.RegistryMetadata
type

[Required] Gets the type of this CreateConnectionDetails. Specific Connection Type

Returns:The type of this CreateConnectionDetails.
Return type:str