StepBasedUserActionDetails

class oci.fleet_apps_management.models.StepBasedUserActionDetails(**kwargs)

Bases: UserActionDetails

Details for a user action to be performed on a step.

Attributes:

ACTION_ABORT

A constant which can be used with the action property of a UserActionDetails.

ACTION_IGNORE

A constant which can be used with the action property of a UserActionDetails.

ACTION_RESUME

A constant which can be used with the action property of a UserActionDetails.

ACTION_RETRY

A constant which can be used with the action property of a UserActionDetails.

LEVEL_ACTION_GROUP

A constant which can be used with the level property of a UserActionDetails.

LEVEL_STEP_NAME

A constant which can be used with the level property of a UserActionDetails.

action

[Required] Gets the action of this UserActionDetails.

action_group_id

[Required] Gets the action_group_id of this StepBasedUserActionDetails.

level

[Required] Gets the level of this UserActionDetails.

resource_id

[Required] Gets the resource_id of this StepBasedUserActionDetails.

step_name

[Required] Gets the step_name of this StepBasedUserActionDetails.

target_id

Gets the target_id of this StepBasedUserActionDetails.

Methods:

__init__(**kwargs)

Initializes a new StepBasedUserActionDetails 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.

ACTION_ABORT = 'ABORT'

A constant which can be used with the action property of a UserActionDetails. This constant has a value of “ABORT”

ACTION_IGNORE = 'IGNORE'

A constant which can be used with the action property of a UserActionDetails. This constant has a value of “IGNORE”

ACTION_RESUME = 'RESUME'

A constant which can be used with the action property of a UserActionDetails. This constant has a value of “RESUME”

ACTION_RETRY = 'RETRY'

A constant which can be used with the action property of a UserActionDetails. This constant has a value of “RETRY”

LEVEL_ACTION_GROUP = 'ACTION_GROUP'

A constant which can be used with the level property of a UserActionDetails. This constant has a value of “ACTION_GROUP”

LEVEL_STEP_NAME = 'STEP_NAME'

A constant which can be used with the level property of a UserActionDetails. This constant has a value of “STEP_NAME”

__init__(**kwargs)

Initializes a new StepBasedUserActionDetails object with values from keyword arguments. The default value of the level attribute of this class is STEP_NAME and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • level (str) – The value to assign to the level property of this StepBasedUserActionDetails. Allowed values for this property are: “ACTION_GROUP”, “STEP_NAME”

  • action (str) – The value to assign to the action property of this StepBasedUserActionDetails. Allowed values for this property are: “RETRY”, “RESUME”, “IGNORE”, “ABORT”

  • action_group_id (str) – The value to assign to the action_group_id property of this StepBasedUserActionDetails.

  • resource_id (str) – The value to assign to the resource_id property of this StepBasedUserActionDetails.

  • target_id (str) – The value to assign to the target_id property of this StepBasedUserActionDetails.

  • step_name (str) – The value to assign to the step_name property of this StepBasedUserActionDetails.

property action

[Required] Gets the action of this UserActionDetails. Action to be Performed.

Allowed values for this property are: “RETRY”, “RESUME”, “IGNORE”, “ABORT”

Returns

The action of this UserActionDetails.

Return type

str

property action_group_id

[Required] Gets the action_group_id of this StepBasedUserActionDetails. Unique identifier for the action group.

Returns

The action_group_id of this StepBasedUserActionDetails.

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.

property level

[Required] Gets the level of this UserActionDetails. User action based On.

Allowed values for this property are: “ACTION_GROUP”, “STEP_NAME”

Returns

The level of this UserActionDetails.

Return type

str

property resource_id

[Required] Gets the resource_id of this StepBasedUserActionDetails. Resource OCID

Returns

The resource_id of this StepBasedUserActionDetails.

Return type

str

property step_name

[Required] Gets the step_name of this StepBasedUserActionDetails. Name of the step on which user action needs to be performed.

Returns

The step_name of this StepBasedUserActionDetails.

Return type

str

property target_id

Gets the target_id of this StepBasedUserActionDetails. Target associated with the execution.

Returns

The target_id of this StepBasedUserActionDetails.

Return type

str