CompositeState¶

class oci.data_integration.models.CompositeState(**kwargs)¶

Bases: object

The composite state object provides information on the state of a task or schedule.

Attributes

`COMPOSITE_STATE_AGGREGATOR_TASK`	A constant which can be used with the composite_state_aggregator property of a CompositeState.
`COMPOSITE_STATE_AGGREGATOR_TASK_OPERATOR`	A constant which can be used with the composite_state_aggregator property of a CompositeState.
`COMPOSITE_STATE_AGGREGATOR_TASK_SCHEDULE`	A constant which can be used with the composite_state_aggregator property of a CompositeState.
`all_states_map`	Gets the all_states_map of this CompositeState.
`composite_state_aggregator`	Gets the composite_state_aggregator of this CompositeState.
`description`	Gets the description of this CompositeState.
`identifier`	Gets the identifier of this CompositeState.
`key`	Gets the key of this CompositeState.
`metadata`	Gets the metadata of this CompositeState.
`model_type`	Gets the model_type of this CompositeState.
`model_version`	Gets the model_version of this CompositeState.
`name`	Gets the name of this CompositeState.
`object_status`	Gets the object_status of this CompositeState.
`object_version`	Gets the object_version of this CompositeState.
`parent_ref`	Gets the parent_ref of this CompositeState.
`registry_metadata`	Gets the registry_metadata of this CompositeState.

Methods

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

COMPOSITE_STATE_AGGREGATOR_TASK = 'TASK'¶: A constant which can be used with the composite_state_aggregator property of a CompositeState. This constant has a value of “TASK”

COMPOSITE_STATE_AGGREGATOR_TASK_OPERATOR = 'TASK_OPERATOR'¶: A constant which can be used with the composite_state_aggregator property of a CompositeState. This constant has a value of “TASK_OPERATOR”

COMPOSITE_STATE_AGGREGATOR_TASK_SCHEDULE = 'TASK_SCHEDULE'¶: A constant which can be used with the composite_state_aggregator property of a CompositeState. This constant has a value of “TASK_SCHEDULE”

__init__(**kwargs)¶

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

Parameters:

composite_state_aggregator (str) – The value to assign to the composite_state_aggregator property of this CompositeState. Allowed values for this property are: “TASK_SCHEDULE”, “TASK”, “TASK_OPERATOR”, ‘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 CompositeState.
model_type (str) – The value to assign to the model_type property of this CompositeState.
model_version (str) – The value to assign to the model_version property of this CompositeState.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this CompositeState.
name (str) – The value to assign to the name property of this CompositeState.
identifier (str) – The value to assign to the identifier property of this CompositeState.
description (str) – The value to assign to the description property of this CompositeState.
object_version (int) – The value to assign to the object_version property of this CompositeState.
object_status (int) – The value to assign to the object_status property of this CompositeState.
all_states_map (dict(str, State)) – The value to assign to the all_states_map property of this CompositeState.
registry_metadata (oci.data_integration.models.RegistryMetadata) – The value to assign to the registry_metadata property of this CompositeState.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this CompositeState.

all_states_map¶

Gets the all_states_map of this CompositeState. Map that stores all the States for a given Task or Schedule

Returns:	The all_states_map of this CompositeState.
Return type:	dict(str, State)

composite_state_aggregator¶

Gets the composite_state_aggregator of this CompositeState. The type of the Composite State Aggregator.

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

Returns:	The composite_state_aggregator of this CompositeState.
Return type:	str

description¶

Gets the description of this CompositeState. Detailed description for the object.

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

identifier¶

Gets the identifier of this CompositeState. 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 CompositeState.
Return type:	str

key¶

Gets the key of this CompositeState. Generated key that can be used in API calls to identify Composite State.

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

metadata¶

Gets the metadata of this CompositeState.

Returns:	The metadata of this CompositeState.
Return type:	oci.data_integration.models.ObjectMetadata

model_type¶

Gets the model_type of this CompositeState. The type of the object.

Returns:	The model_type of this CompositeState.
Return type:	str

model_version¶

Gets the model_version of this CompositeState. The model version of an object.

Returns:	The model_version of this CompositeState.
Return type:	str

name¶

Gets the name of this CompositeState. 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 CompositeState.
Return type:	str

object_status¶

Gets the object_status of this CompositeState. 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 CompositeState.
Return type:	int

object_version¶

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

Returns:	The object_version of this CompositeState.
Return type:	int

parent_ref¶

Gets the parent_ref of this CompositeState.

Returns:	The parent_ref of this CompositeState.
Return type:	oci.data_integration.models.ParentReference

registry_metadata¶

Gets the registry_metadata of this CompositeState.

Returns:	The registry_metadata of this CompositeState.
Return type:	oci.data_integration.models.RegistryMetadata