TypeSummary¶

class oci.data_catalog.models.TypeSummary(**kwargs)¶

Bases: object

Summary data catalog type information. 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 TypeSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a TypeSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a TypeSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a TypeSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a TypeSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a TypeSummary.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a TypeSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a TypeSummary.
`catalog_id`	Gets the catalog_id of this TypeSummary.
`description`	Gets the description of this TypeSummary.
`key`	[Required] Gets the key of this TypeSummary.
`lifecycle_state`	Gets the lifecycle_state of this TypeSummary.
`name`	Gets the name of this TypeSummary.
`parent_type_key`	Gets the parent_type_key of this TypeSummary.
`parent_type_name`	Gets the parent_type_name of this TypeSummary.
`type_category`	Gets the type_category of this TypeSummary.
`uri`	Gets the uri of this TypeSummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a TypeSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new TypeSummary 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 TypeSummary.
name (str) – The value to assign to the name property of this TypeSummary.
description (str) – The value to assign to the description property of this TypeSummary.
catalog_id (str) – The value to assign to the catalog_id property of this TypeSummary.
type_category (str) – The value to assign to the type_category property of this TypeSummary.
uri (str) – The value to assign to the uri property of this TypeSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TypeSummary. 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’.
parent_type_key (str) – The value to assign to the parent_type_key property of this TypeSummary.
parent_type_name (str) – The value to assign to the parent_type_name property of this TypeSummary.

catalog_id¶

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

Returns:	The catalog_id of this TypeSummary.
Return type:	str

description¶

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

Returns:	The description of this TypeSummary.
Return type:	str

key¶

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

Returns:	The key of this TypeSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this TypeSummary. State of the folder.

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 TypeSummary.
Return type:	str

name¶

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

Returns:	The name of this TypeSummary.
Return type:	str

parent_type_key¶

Gets the parent_type_key of this TypeSummary. Unique key of the parent type.

Returns:	The parent_type_key of this TypeSummary.
Return type:	str

parent_type_name¶

Gets the parent_type_name of this TypeSummary. Name of the parent type.

Returns:	The parent_type_name of this TypeSummary.
Return type:	str

type_category¶

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

Returns:	The type_category of this TypeSummary.
Return type:	str

uri¶

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

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