SchemaSummary¶
- class oci.data_integration.models.SchemaSummary(**kwargs)¶
Bases:
objectThe schema summary object.
Methods:
__init__(**kwargs)Initializes a new SchemaSummary object with values from keyword arguments.
Attributes:
Gets the default_connection of this SchemaSummary.
Gets the description of this SchemaSummary.
Gets the external_key of this SchemaSummary.
Gets the identifier of this SchemaSummary.
Gets the is_has_containers of this SchemaSummary.
Gets the key of this SchemaSummary.
Gets the metadata of this SchemaSummary.
Gets the model_type of this SchemaSummary.
Gets the model_version of this SchemaSummary.
Gets the name of this SchemaSummary.
Gets the object_status of this SchemaSummary.
Gets the object_version of this SchemaSummary.
Gets the parent_ref of this SchemaSummary.
Gets the resource_name of this SchemaSummary.
- __init__(**kwargs)¶
Initializes a new SchemaSummary 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 SchemaSummary.
model_type (str) – The value to assign to the model_type property of this SchemaSummary.
model_version (str) – The value to assign to the model_version property of this SchemaSummary.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this SchemaSummary.
name (str) – The value to assign to the name property of this SchemaSummary.
resource_name (str) – The value to assign to the resource_name property of this SchemaSummary.
description (str) – The value to assign to the description property of this SchemaSummary.
object_version (int) – The value to assign to the object_version property of this SchemaSummary.
external_key (str) – The value to assign to the external_key property of this SchemaSummary.
is_has_containers (bool) – The value to assign to the is_has_containers property of this SchemaSummary.
default_connection (str) – The value to assign to the default_connection property of this SchemaSummary.
object_status (int) – The value to assign to the object_status property of this SchemaSummary.
identifier (str) – The value to assign to the identifier property of this SchemaSummary.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this SchemaSummary.
- property default_connection¶
Gets the default_connection of this SchemaSummary. The default connection key.
- Returns
The default_connection of this SchemaSummary.
- Return type
str
- property description¶
Gets the description of this SchemaSummary. User-defined description for the schema.
- Returns
The description of this SchemaSummary.
- Return type
str
- property external_key¶
Gets the external_key of this SchemaSummary. The external key for the object.
- Returns
The external_key of this SchemaSummary.
- Return type
str
- property identifier¶
Gets the identifier of this SchemaSummary. 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 SchemaSummary.
- Return type
str
- property is_has_containers¶
Gets the is_has_containers of this SchemaSummary. Specifies whether the schema has containers.
- Returns
The is_has_containers of this SchemaSummary.
- Return type
bool
- property key¶
Gets the key of this SchemaSummary. The object key.
- Returns
The key of this SchemaSummary.
- Return type
str
- property metadata¶
Gets the metadata of this SchemaSummary.
- Returns
The metadata of this SchemaSummary.
- Return type
- property model_type¶
Gets the model_type of this SchemaSummary. The object’s type.
- Returns
The model_type of this SchemaSummary.
- Return type
str
- property model_version¶
Gets the model_version of this SchemaSummary. The object’s model version.
- Returns
The model_version of this SchemaSummary.
- Return type
str
- property name¶
Gets the name of this SchemaSummary. 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 SchemaSummary.
- Return type
str
- property object_status¶
Gets the object_status of this SchemaSummary. 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 SchemaSummary.
- Return type
int
- property object_version¶
Gets the object_version of this SchemaSummary. The version of the object that is used to track changes in the object instance.
- Returns
The object_version of this SchemaSummary.
- Return type
int
- property parent_ref¶
Gets the parent_ref of this SchemaSummary.
- Returns
The parent_ref of this SchemaSummary.
- Return type
- property resource_name¶
Gets the resource_name of this SchemaSummary. A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters.
- Returns
The resource_name of this SchemaSummary.
- Return type
str