Type

class oci.data_catalog.models.Type(**kwargs)

Bases: object

Full data catalog type definition. Fully defines a type of the data catalog. All types are statically defined in the system and are immutable. It isn’t possible to create new types or update existing types via the API.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Type.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Type.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Type.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Type.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Type.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a Type.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a Type.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Type.
catalog_id Gets the catalog_id of this Type.
custom_properties Gets the custom_properties of this Type.
description Gets the description of this Type.
external_type_name Gets the external_type_name of this Type.
is_approved Gets the is_approved of this Type.
is_internal Gets the is_internal of this Type.
is_tag Gets the is_tag of this Type.
key [Required] Gets the key of this Type.
lifecycle_state Gets the lifecycle_state of this Type.
name Gets the name of this Type.
properties Gets the properties of this Type.
type_category Gets the type_category of this Type.
uri Gets the uri of this Type.

Methods

__init__(**kwargs) Initializes a new Type object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Type. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Type 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 Type.
  • name (str) – The value to assign to the name property of this Type.
  • description (str) – The value to assign to the description property of this Type.
  • catalog_id (str) – The value to assign to the catalog_id property of this Type.
  • properties (dict(str, list[PropertyDefinition])) – The value to assign to the properties property of this Type.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Type. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • is_internal (bool) – The value to assign to the is_internal property of this Type.
  • is_tag (bool) – The value to assign to the is_tag property of this Type.
  • is_approved (bool) – The value to assign to the is_approved property of this Type.
  • type_category (str) – The value to assign to the type_category property of this Type.
  • external_type_name (str) – The value to assign to the external_type_name property of this Type.
  • uri (str) – The value to assign to the uri property of this Type.
  • custom_properties (list[oci.data_catalog.models.CustomPropertySummary]) – The value to assign to the custom_properties property of this Type.
catalog_id

Gets the catalog_id of this Type. The data catalog’s OCID.

Returns:The catalog_id of this Type.
Return type:str
custom_properties

Gets the custom_properties of this Type. Custom properties associated with this Type.

Returns:The custom_properties of this Type.
Return type:list[oci.data_catalog.models.CustomPropertySummary]
description

Gets the description of this Type. Detailed description of the type.

Returns:The description of this Type.
Return type:str
external_type_name

Gets the external_type_name of this Type. Mapping type equivalence in the external system.

Returns:The external_type_name of this Type.
Return type:str
is_approved

Gets the is_approved of this Type. Indicates whether the type is approved for use as a classifying object.

Returns:The is_approved of this Type.
Return type:bool
is_internal

Gets the is_internal of this Type. Indicates whether the type is internal, making it unavailable for use by metadata elements.

Returns:The is_internal of this Type.
Return type:bool
is_tag

Gets the is_tag of this Type. Indicates whether the type can be used for tagging metadata elements.

Returns:The is_tag of this Type.
Return type:bool
key

[Required] Gets the key of this Type. Unique type key that is immutable.

Returns:The key of this Type.
Return type:str
lifecycle_state

Gets the lifecycle_state of this Type. The current state of the type.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this Type.
Return type:str
name

Gets the name of this Type. The immutable name of the type.

Returns:The name of this Type.
Return type:str
properties

Gets the properties of this Type. A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the “default” category. Example: `{

“properties”: {
“default”: {
“attributes:”: [
{
“name”: “host”, “type”: “string”, “isRequired”: true, “isUpdatable”: false

]

}

}

}`

Returns:The properties of this Type.
Return type:dict(str, list[PropertyDefinition])
type_category

Gets the type_category of this Type. Indicates the category this type belongs to. For instance, data assets, connections.

Returns:The type_category of this Type.
Return type:str
uri

Gets the uri of this Type. URI to the type instance in the API.

Returns:The uri of this Type.
Return type:str