ConnectionSummary

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

Bases: object

The connection summary object.

Methods

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

Attributes

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

Initializes a new ConnectionSummary 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 ConnectionSummary.
  • model_version (str) – The value to assign to the model_version property of this ConnectionSummary.
  • model_type (str) – The value to assign to the model_type property of this ConnectionSummary.
  • name (str) – The value to assign to the name property of this ConnectionSummary.
  • description (str) – The value to assign to the description property of this ConnectionSummary.
  • object_version (int) – The value to assign to the object_version property of this ConnectionSummary.
  • object_status (int) – The value to assign to the object_status property of this ConnectionSummary.
  • identifier (str) – The value to assign to the identifier property of this ConnectionSummary.
  • primary_schema (oci.data_connectivity.models.Schema) – The value to assign to the primary_schema property of this ConnectionSummary.
  • connection_properties (list[oci.data_connectivity.models.ConnectionProperty]) – The value to assign to the connection_properties property of this ConnectionSummary.
  • properties (dict(str, object)) – The value to assign to the properties property of this ConnectionSummary.
  • type (str) – The value to assign to the type property of this ConnectionSummary.
  • is_default (bool) – The value to assign to the is_default property of this ConnectionSummary.
  • metadata (oci.data_connectivity.models.ObjectMetadata) – The value to assign to the metadata property of this ConnectionSummary.
  • registry_metadata (oci.data_connectivity.models.RegistryMetadata) – The value to assign to the registry_metadata property of this ConnectionSummary.
connection_properties

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

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

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

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

[Required] Gets the identifier of this ConnectionSummary. 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 ConnectionSummary.
Return type:str
is_default

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

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

[Required] Gets the key of this ConnectionSummary. 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 ConnectionSummary.
Return type:str
metadata

Gets the metadata of this ConnectionSummary.

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

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

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

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

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

[Required] Gets the name of this ConnectionSummary. 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 ConnectionSummary.
Return type:str
object_status

Gets the object_status of this ConnectionSummary. 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 ConnectionSummary.
Return type:int
object_version

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

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

Gets the primary_schema of this ConnectionSummary.

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

Gets the properties of this ConnectionSummary. All the properties for the connection in a key-value map format.

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

Gets the registry_metadata of this ConnectionSummary.

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

Gets the type of this ConnectionSummary. Specific Connection Type

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