DataObjectColumnMetadata¶

class oci.opsi.models.DataObjectColumnMetadata(**kwargs)¶

Bases: object

Metadata of a column in a data object resultset.

Attributes

`CATEGORY_DIMENSION`	A constant which can be used with the category property of a DataObjectColumnMetadata.
`CATEGORY_METRIC`	A constant which can be used with the category property of a DataObjectColumnMetadata.
`CATEGORY_TIME_DIMENSION`	A constant which can be used with the category property of a DataObjectColumnMetadata.
`CATEGORY_UNKNOWN`	A constant which can be used with the category property of a DataObjectColumnMetadata.
`DATA_TYPE_NAME_NUMBER`	A constant which can be used with the data_type_name property of a DataObjectColumnMetadata.
`DATA_TYPE_NAME_OTHER`	A constant which can be used with the data_type_name property of a DataObjectColumnMetadata.
`DATA_TYPE_NAME_TIMESTAMP`	A constant which can be used with the data_type_name property of a DataObjectColumnMetadata.
`DATA_TYPE_NAME_VARCHAR2`	A constant which can be used with the data_type_name property of a DataObjectColumnMetadata.
`category`	Gets the category of this DataObjectColumnMetadata.
`data_type`	Gets the data_type of this DataObjectColumnMetadata.
`data_type_name`	Gets the data_type_name of this DataObjectColumnMetadata.
`description`	Gets the description of this DataObjectColumnMetadata.
`display_name`	Gets the display_name of this DataObjectColumnMetadata.
`group_name`	Gets the group_name of this DataObjectColumnMetadata.
`name`	[Required] Gets the name of this DataObjectColumnMetadata.
`unit_details`	Gets the unit_details of this DataObjectColumnMetadata.

Methods

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

CATEGORY_DIMENSION = 'DIMENSION'¶: A constant which can be used with the category property of a DataObjectColumnMetadata. This constant has a value of “DIMENSION”

CATEGORY_METRIC = 'METRIC'¶: A constant which can be used with the category property of a DataObjectColumnMetadata. This constant has a value of “METRIC”

CATEGORY_TIME_DIMENSION = 'TIME_DIMENSION'¶: A constant which can be used with the category property of a DataObjectColumnMetadata. This constant has a value of “TIME_DIMENSION”

CATEGORY_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the category property of a DataObjectColumnMetadata. This constant has a value of “UNKNOWN”

DATA_TYPE_NAME_NUMBER = 'NUMBER'¶: A constant which can be used with the data_type_name property of a DataObjectColumnMetadata. This constant has a value of “NUMBER”

DATA_TYPE_NAME_OTHER = 'OTHER'¶: A constant which can be used with the data_type_name property of a DataObjectColumnMetadata. This constant has a value of “OTHER”

DATA_TYPE_NAME_TIMESTAMP = 'TIMESTAMP'¶: A constant which can be used with the data_type_name property of a DataObjectColumnMetadata. This constant has a value of “TIMESTAMP”

DATA_TYPE_NAME_VARCHAR2 = 'VARCHAR2'¶: A constant which can be used with the data_type_name property of a DataObjectColumnMetadata. This constant has a value of “VARCHAR2”

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this DataObjectColumnMetadata.
category (str) – The value to assign to the category property of this DataObjectColumnMetadata. Allowed values for this property are: “DIMENSION”, “METRIC”, “TIME_DIMENSION”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
data_type (str) – The value to assign to the data_type property of this DataObjectColumnMetadata.
data_type_name (str) – The value to assign to the data_type_name property of this DataObjectColumnMetadata. Allowed values for this property are: “NUMBER”, “TIMESTAMP”, “VARCHAR2”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this DataObjectColumnMetadata.
description (str) – The value to assign to the description property of this DataObjectColumnMetadata.
group_name (str) – The value to assign to the group_name property of this DataObjectColumnMetadata.
unit_details (oci.opsi.models.DataObjectColumnUnit) – The value to assign to the unit_details property of this DataObjectColumnMetadata.

category¶

Gets the category of this DataObjectColumnMetadata. Category of the column.

Allowed values for this property are: “DIMENSION”, “METRIC”, “TIME_DIMENSION”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The category of this DataObjectColumnMetadata.
Return type:	str

data_type¶

Gets the data_type of this DataObjectColumnMetadata. Type of a data object column.

Returns:	The data_type of this DataObjectColumnMetadata.
Return type:	str

data_type_name¶

Gets the data_type_name of this DataObjectColumnMetadata. Type name of a data object column.

Allowed values for this property are: “NUMBER”, “TIMESTAMP”, “VARCHAR2”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The data_type_name of this DataObjectColumnMetadata.
Return type:	str

description¶

Gets the description of this DataObjectColumnMetadata. Description of the column.

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

display_name¶

Gets the display_name of this DataObjectColumnMetadata. Display name of the column.

Returns:	The display_name of this DataObjectColumnMetadata.
Return type:	str

group_name¶

Gets the group_name of this DataObjectColumnMetadata. Group name of the column.

Returns:	The group_name of this DataObjectColumnMetadata.
Return type:	str

name¶

[Required] Gets the name of this DataObjectColumnMetadata. Name of the column.

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

unit_details¶

Gets the unit_details of this DataObjectColumnMetadata.

Returns:	The unit_details of this DataObjectColumnMetadata.
Return type:	oci.opsi.models.DataObjectColumnUnit