DatabaseObject

class oci.generative_ai_data.models.DatabaseObject(**kwargs)

Bases: object

The type of database object

Attributes

TYPE_ANNOTATION A constant which can be used with the type property of a DatabaseObject.
TYPE_COMMENT A constant which can be used with the type property of a DatabaseObject.
TYPE_TABLE A constant which can be used with the type property of a DatabaseObject.
TYPE_VIEW A constant which can be used with the type property of a DatabaseObject.
description Gets the description of this DatabaseObject.
name [Required] Gets the name of this DatabaseObject.
type [Required] Gets the type of this DatabaseObject.

Methods

__init__(**kwargs) Initializes a new DatabaseObject object with values from keyword arguments.
TYPE_ANNOTATION = 'ANNOTATION'

A constant which can be used with the type property of a DatabaseObject. This constant has a value of “ANNOTATION”

TYPE_COMMENT = 'COMMENT'

A constant which can be used with the type property of a DatabaseObject. This constant has a value of “COMMENT”

TYPE_TABLE = 'TABLE'

A constant which can be used with the type property of a DatabaseObject. This constant has a value of “TABLE”

TYPE_VIEW = 'VIEW'

A constant which can be used with the type property of a DatabaseObject. This constant has a value of “VIEW”

__init__(**kwargs)

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

Parameters:
  • description (str) – The value to assign to the description property of this DatabaseObject.
  • type (str) – The value to assign to the type property of this DatabaseObject. Allowed values for this property are: “VIEW”, “TABLE”, “ANNOTATION”, “COMMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • name (str) – The value to assign to the name property of this DatabaseObject.
description

Gets the description of this DatabaseObject. An optional description of the DatabaseObject.

Returns:The description of this DatabaseObject.
Return type:str
name

[Required] Gets the name of this DatabaseObject. The fully qualified name of the database object.

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

[Required] Gets the type of this DatabaseObject. The type of the database object (e.g., table, view, procedure).

Allowed values for this property are: “VIEW”, “TABLE”, “ANNOTATION”, “COMMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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