BuildPipelineStage

class oci.devops.models.BuildPipelineStage(**kwargs)

Bases: object

A single node in a build pipeline. A stage takes a specific designated action. There are many types of stages such as ‘Build’ and ‘Deliver Artifacts’.

Attributes

BUILD_PIPELINE_STAGE_TYPE_BUILD A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage.
BUILD_PIPELINE_STAGE_TYPE_DELIVER_ARTIFACT A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage.
BUILD_PIPELINE_STAGE_TYPE_TRIGGER_DEPLOYMENT_PIPELINE A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage.
BUILD_PIPELINE_STAGE_TYPE_WAIT A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a BuildPipelineStage.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a BuildPipelineStage.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a BuildPipelineStage.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a BuildPipelineStage.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a BuildPipelineStage.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a BuildPipelineStage.
build_pipeline_id [Required] Gets the build_pipeline_id of this BuildPipelineStage.
build_pipeline_stage_predecessor_collection Gets the build_pipeline_stage_predecessor_collection of this BuildPipelineStage.
build_pipeline_stage_type [Required] Gets the build_pipeline_stage_type of this BuildPipelineStage.
compartment_id [Required] Gets the compartment_id of this BuildPipelineStage.
defined_tags Gets the defined_tags of this BuildPipelineStage.
description Gets the description of this BuildPipelineStage.
display_name Gets the display_name of this BuildPipelineStage.
freeform_tags Gets the freeform_tags of this BuildPipelineStage.
id [Required] Gets the id of this BuildPipelineStage.
lifecycle_details Gets the lifecycle_details of this BuildPipelineStage.
lifecycle_state Gets the lifecycle_state of this BuildPipelineStage.
project_id [Required] Gets the project_id of this BuildPipelineStage.
system_tags Gets the system_tags of this BuildPipelineStage.
time_created Gets the time_created of this BuildPipelineStage.
time_updated Gets the time_updated of this BuildPipelineStage.

Methods

__init__(**kwargs) Initializes a new BuildPipelineStage 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.
BUILD_PIPELINE_STAGE_TYPE_BUILD = 'BUILD'

A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage. This constant has a value of “BUILD”

BUILD_PIPELINE_STAGE_TYPE_DELIVER_ARTIFACT = 'DELIVER_ARTIFACT'

A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage. This constant has a value of “DELIVER_ARTIFACT”

BUILD_PIPELINE_STAGE_TYPE_TRIGGER_DEPLOYMENT_PIPELINE = 'TRIGGER_DEPLOYMENT_PIPELINE'

A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage. This constant has a value of “TRIGGER_DEPLOYMENT_PIPELINE”

BUILD_PIPELINE_STAGE_TYPE_WAIT = 'WAIT'

A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage. This constant has a value of “WAIT”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a BuildPipelineStage. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a BuildPipelineStage. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a BuildPipelineStage. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a BuildPipelineStage. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a BuildPipelineStage. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a BuildPipelineStage. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new BuildPipelineStage 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:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • id (str) – The value to assign to the id property of this BuildPipelineStage.
  • display_name (str) – The value to assign to the display_name property of this BuildPipelineStage.
  • description (str) – The value to assign to the description property of this BuildPipelineStage.
  • project_id (str) – The value to assign to the project_id property of this BuildPipelineStage.
  • build_pipeline_id (str) – The value to assign to the build_pipeline_id property of this BuildPipelineStage.
  • compartment_id (str) – The value to assign to the compartment_id property of this BuildPipelineStage.
  • build_pipeline_stage_type (str) – The value to assign to the build_pipeline_stage_type property of this BuildPipelineStage. Allowed values for this property are: “WAIT”, “BUILD”, “DELIVER_ARTIFACT”, “TRIGGER_DEPLOYMENT_PIPELINE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_created (datetime) – The value to assign to the time_created property of this BuildPipelineStage.
  • time_updated (datetime) – The value to assign to the time_updated property of this BuildPipelineStage.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this BuildPipelineStage. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this BuildPipelineStage.
  • build_pipeline_stage_predecessor_collection (oci.devops.models.BuildPipelineStagePredecessorCollection) – The value to assign to the build_pipeline_stage_predecessor_collection property of this BuildPipelineStage.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BuildPipelineStage.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BuildPipelineStage.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BuildPipelineStage.
build_pipeline_id

[Required] Gets the build_pipeline_id of this BuildPipelineStage. The OCID of the build pipeline.

Returns:The build_pipeline_id of this BuildPipelineStage.
Return type:str
build_pipeline_stage_predecessor_collection

Gets the build_pipeline_stage_predecessor_collection of this BuildPipelineStage.

Returns:The build_pipeline_stage_predecessor_collection of this BuildPipelineStage.
Return type:oci.devops.models.BuildPipelineStagePredecessorCollection
build_pipeline_stage_type

[Required] Gets the build_pipeline_stage_type of this BuildPipelineStage. Defines the stage type, which is one of the following: Build, Deliver Artifacts, Wait, and Trigger Deployment.

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

Returns:The build_pipeline_stage_type of this BuildPipelineStage.
Return type:str
compartment_id

[Required] Gets the compartment_id of this BuildPipelineStage. The OCID of the compartment where the pipeline is created.

Returns:The compartment_id of this BuildPipelineStage.
Return type:str
defined_tags

Gets the defined_tags of this BuildPipelineStage. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this BuildPipelineStage.
Return type:dict(str, dict(str, object))
description

Gets the description of this BuildPipelineStage. Optional description about the build stage.

Returns:The description of this BuildPipelineStage.
Return type:str
display_name

Gets the display_name of this BuildPipelineStage. Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Returns:The display_name of this BuildPipelineStage.
Return type:str
freeform_tags

Gets the freeform_tags of this BuildPipelineStage. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {“bar-key”: “value”}

Returns:The freeform_tags of this BuildPipelineStage.
Return type:dict(str, 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.

id

[Required] Gets the id of this BuildPipelineStage. Unique identifier that is immutable on creation.

Returns:The id of this BuildPipelineStage.
Return type:str
lifecycle_details

Gets the lifecycle_details of this BuildPipelineStage. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:The lifecycle_details of this BuildPipelineStage.
Return type:str
lifecycle_state

Gets the lifecycle_state of this BuildPipelineStage. The current state of the stage.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this BuildPipelineStage.
Return type:str
project_id

[Required] Gets the project_id of this BuildPipelineStage. The OCID of the DevOps project.

Returns:The project_id of this BuildPipelineStage.
Return type:str
system_tags

Gets the system_tags of this BuildPipelineStage. Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:The system_tags of this BuildPipelineStage.
Return type:dict(str, dict(str, object))
time_created

Gets the time_created of this BuildPipelineStage. The time the stage was created. Format defined by RFC3339.

Returns:The time_created of this BuildPipelineStage.
Return type:datetime
time_updated

Gets the time_updated of this BuildPipelineStage. The time the stage was updated. Format defined by RFC3339.

Returns:The time_updated of this BuildPipelineStage.
Return type:datetime