DetailedDescription

class oci.data_integration.models.DetailedDescription(**kwargs)

Bases: object

The detailed description of an object.

Attributes:

MODEL_TYPE_DETAILED_DESCRIPTION

A constant which can be used with the model_type property of a DetailedDescription.

detailed_description

Gets the detailed_description of this DetailedDescription.

identifier

Gets the identifier of this DetailedDescription.

key

Gets the key of this DetailedDescription.

logo

Gets the logo of this DetailedDescription.

metadata

Gets the metadata of this DetailedDescription.

model_type

Gets the model_type of this DetailedDescription.

model_version

Gets the model_version of this DetailedDescription.

name

Gets the name of this DetailedDescription.

object_status

Gets the object_status of this DetailedDescription.

object_version

Gets the object_version of this DetailedDescription.

parent_ref

Gets the parent_ref of this DetailedDescription.

Methods:

__init__(**kwargs)

Initializes a new DetailedDescription object with values from keyword arguments.

MODEL_TYPE_DETAILED_DESCRIPTION = 'DETAILED_DESCRIPTION'

A constant which can be used with the model_type property of a DetailedDescription. This constant has a value of “DETAILED_DESCRIPTION”

__init__(**kwargs)

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

Parameters
  • model_type (str) – The value to assign to the model_type property of this DetailedDescription. Allowed values for this property are: “DETAILED_DESCRIPTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • key (str) – The value to assign to the key property of this DetailedDescription.

  • model_version (str) – The value to assign to the model_version property of this DetailedDescription.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this DetailedDescription.

  • name (str) – The value to assign to the name property of this DetailedDescription.

  • object_version (int) – The value to assign to the object_version property of this DetailedDescription.

  • object_status (int) – The value to assign to the object_status property of this DetailedDescription.

  • identifier (str) – The value to assign to the identifier property of this DetailedDescription.

  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this DetailedDescription.

  • logo (str) – The value to assign to the logo property of this DetailedDescription.

  • detailed_description (str) – The value to assign to the detailed_description property of this DetailedDescription.

property detailed_description

Gets the detailed_description of this DetailedDescription. Base64 encoded rich text description of the object.

Returns

The detailed_description of this DetailedDescription.

Return type

str

property identifier

Gets the identifier of this DetailedDescription. 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 DetailedDescription.

Return type

str

property key

Gets the key of this DetailedDescription. Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create.

Returns

The key of this DetailedDescription.

Return type

str

Gets the logo of this DetailedDescription. Base64 encoded image to represent logo of the object.

Returns

The logo of this DetailedDescription.

Return type

str

property metadata

Gets the metadata of this DetailedDescription.

Returns

The metadata of this DetailedDescription.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

Gets the model_type of this DetailedDescription. The type of the published object.

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

Returns

The model_type of this DetailedDescription.

Return type

str

property model_version

Gets the model_version of this DetailedDescription. The object’s model version.

Returns

The model_version of this DetailedDescription.

Return type

str

property name

Gets the name of this DetailedDescription. 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 DetailedDescription.

Return type

str

property object_status

Gets the object_status of this DetailedDescription. 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 DetailedDescription.

Return type

int

property object_version

Gets the object_version of this DetailedDescription. The version of the object that is used to track changes in the object instance.

Returns

The object_version of this DetailedDescription.

Return type

int

property parent_ref

Gets the parent_ref of this DetailedDescription.

Returns

The parent_ref of this DetailedDescription.

Return type

oci.data_integration.models.ParentReference