PublishedObjectSummary¶
-
class
oci.data_integration.models.PublishedObjectSummary(**kwargs)¶ Bases:
objectThe published obect summary.
Attributes
MODEL_TYPE_DATA_LOADER_TASKA constant which can be used with the model_type property of a PublishedObjectSummary. MODEL_TYPE_INTEGRATION_TASKA constant which can be used with the model_type property of a PublishedObjectSummary. MODEL_TYPE_OCI_DATAFLOW_TASKA constant which can be used with the model_type property of a PublishedObjectSummary. MODEL_TYPE_PIPELINE_TASKA constant which can be used with the model_type property of a PublishedObjectSummary. MODEL_TYPE_REST_TASKA constant which can be used with the model_type property of a PublishedObjectSummary. MODEL_TYPE_SQL_TASKA constant which can be used with the model_type property of a PublishedObjectSummary. descriptionGets the description of this PublishedObjectSummary. identifierGets the identifier of this PublishedObjectSummary. keyGets the key of this PublishedObjectSummary. metadataGets the metadata of this PublishedObjectSummary. model_type[Required] Gets the model_type of this PublishedObjectSummary. model_versionGets the model_version of this PublishedObjectSummary. nameGets the name of this PublishedObjectSummary. object_statusGets the object_status of this PublishedObjectSummary. object_versionGets the object_version of this PublishedObjectSummary. parent_refGets the parent_ref of this PublishedObjectSummary. Methods
__init__(**kwargs)Initializes a new PublishedObjectSummary object with values from keyword arguments. get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype. -
MODEL_TYPE_DATA_LOADER_TASK= 'DATA_LOADER_TASK'¶ A constant which can be used with the model_type property of a PublishedObjectSummary. This constant has a value of “DATA_LOADER_TASK”
-
MODEL_TYPE_INTEGRATION_TASK= 'INTEGRATION_TASK'¶ A constant which can be used with the model_type property of a PublishedObjectSummary. This constant has a value of “INTEGRATION_TASK”
-
MODEL_TYPE_OCI_DATAFLOW_TASK= 'OCI_DATAFLOW_TASK'¶ A constant which can be used with the model_type property of a PublishedObjectSummary. This constant has a value of “OCI_DATAFLOW_TASK”
-
MODEL_TYPE_PIPELINE_TASK= 'PIPELINE_TASK'¶ A constant which can be used with the model_type property of a PublishedObjectSummary. This constant has a value of “PIPELINE_TASK”
-
MODEL_TYPE_REST_TASK= 'REST_TASK'¶ A constant which can be used with the model_type property of a PublishedObjectSummary. This constant has a value of “REST_TASK”
-
MODEL_TYPE_SQL_TASK= 'SQL_TASK'¶ A constant which can be used with the model_type property of a PublishedObjectSummary. This constant has a value of “SQL_TASK”
-
__init__(**kwargs)¶ Initializes a new PublishedObjectSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
PublishedObjectFromPipelineTaskSummaryPublishedObjectSummaryFromIntegrationTaskPublishedObjectSummaryFromDataLoaderTask
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 PublishedObjectSummary. Allowed values for this property are: “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “PIPELINE_TASK”, “SQL_TASK”, “OCI_DATAFLOW_TASK”, “REST_TASK”, ‘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 PublishedObjectSummary.
- model_version (str) – The value to assign to the model_version property of this PublishedObjectSummary.
- parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this PublishedObjectSummary.
- name (str) – The value to assign to the name property of this PublishedObjectSummary.
- description (str) – The value to assign to the description property of this PublishedObjectSummary.
- object_version (int) – The value to assign to the object_version property of this PublishedObjectSummary.
- object_status (int) – The value to assign to the object_status property of this PublishedObjectSummary.
- identifier (str) – The value to assign to the identifier property of this PublishedObjectSummary.
- metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this PublishedObjectSummary.
-
description¶ Gets the description of this PublishedObjectSummary. Detailed description for the object.
Returns: The description of this PublishedObjectSummary. Return type: str
-
static
get_subtype(object_dictionary)¶ Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
identifier¶ Gets the identifier of this PublishedObjectSummary. 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 PublishedObjectSummary. Return type: str
-
key¶ Gets the key of this PublishedObjectSummary. 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 PublishedObjectSummary. Return type: str
-
metadata¶ Gets the metadata of this PublishedObjectSummary.
Returns: The metadata of this PublishedObjectSummary. Return type: oci.data_integration.models.ObjectMetadata
-
model_type¶ [Required] Gets the model_type of this PublishedObjectSummary. The type of the published object.
Allowed values for this property are: “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “PIPELINE_TASK”, “SQL_TASK”, “OCI_DATAFLOW_TASK”, “REST_TASK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The model_type of this PublishedObjectSummary. Return type: str
-
model_version¶ Gets the model_version of this PublishedObjectSummary. The object’s model version.
Returns: The model_version of this PublishedObjectSummary. Return type: str
-
name¶ Gets the name of this PublishedObjectSummary. 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 PublishedObjectSummary. Return type: str
-
object_status¶ Gets the object_status of this PublishedObjectSummary. 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 PublishedObjectSummary. Return type: int
-
object_version¶ Gets the object_version of this PublishedObjectSummary. The version of the object that is used to track changes in the object instance.
Returns: The object_version of this PublishedObjectSummary. Return type: int
-
parent_ref¶ Gets the parent_ref of this PublishedObjectSummary.
Returns: The parent_ref of this PublishedObjectSummary. Return type: oci.data_integration.models.ParentReference
-