BuildStage¶

class oci.devops.models.BuildStage(**kwargs)¶

Bases: oci.devops.models.build_pipeline_stage.BuildPipelineStage

Specifies the build stage.

Attributes

`BUILD_PIPELINE_STAGE_TYPE_BUILD`	str(object=’’) -> str
`BUILD_PIPELINE_STAGE_TYPE_DELIVER_ARTIFACT`	str(object=’’) -> str
`BUILD_PIPELINE_STAGE_TYPE_TRIGGER_DEPLOYMENT_PIPELINE`	str(object=’’) -> str
`BUILD_PIPELINE_STAGE_TYPE_WAIT`	str(object=’’) -> str
`IMAGE_OL7_X86_64_STANDARD_10`	A constant which can be used with the image property of a BuildStage.
`IMAGE_OL8_X86_64_STANDARD_10`	A constant which can be used with the image property of a BuildStage.
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`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.
`build_runner_shape_config`	Gets the build_runner_shape_config of this BuildStage.
`build_source_collection`	[Required] Gets the build_source_collection of this BuildStage.
`build_spec_file`	Gets the build_spec_file of this BuildStage.
`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.
`image`	[Required] Gets the image of this BuildStage.
`lifecycle_details`	Gets the lifecycle_details of this BuildPipelineStage.
`lifecycle_state`	Gets the lifecycle_state of this BuildPipelineStage.
`primary_build_source`	Gets the primary_build_source of this BuildStage.
`private_access_config`	Gets the private_access_config of this BuildStage.
`project_id`	[Required] Gets the project_id of this BuildPipelineStage.
`stage_execution_timeout_in_seconds`	Gets the stage_execution_timeout_in_seconds of this BuildStage.
`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 BuildStage 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'¶

BUILD_PIPELINE_STAGE_TYPE_DELIVER_ARTIFACT = 'DELIVER_ARTIFACT'¶

BUILD_PIPELINE_STAGE_TYPE_TRIGGER_DEPLOYMENT_PIPELINE = 'TRIGGER_DEPLOYMENT_PIPELINE'¶

BUILD_PIPELINE_STAGE_TYPE_WAIT = 'WAIT'¶

IMAGE_OL7_X86_64_STANDARD_10 = 'OL7_X86_64_STANDARD_10'¶: A constant which can be used with the image property of a BuildStage. This constant has a value of “OL7_X86_64_STANDARD_10”

IMAGE_OL8_X86_64_STANDARD_10 = 'OL8_X86_64_STANDARD_10'¶: A constant which can be used with the image property of a BuildStage. This constant has a value of “OL8_X86_64_STANDARD_10”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

__init__(**kwargs)¶

Initializes a new BuildStage object with values from keyword arguments. The default value of the build_pipeline_stage_type attribute of this class is BUILD and it should not be changed. 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 BuildStage.
display_name (str) – The value to assign to the display_name property of this BuildStage.
description (str) – The value to assign to the description property of this BuildStage.
project_id (str) – The value to assign to the project_id property of this BuildStage.
build_pipeline_id (str) – The value to assign to the build_pipeline_id property of this BuildStage.
compartment_id (str) – The value to assign to the compartment_id property of this BuildStage.
build_pipeline_stage_type (str) – The value to assign to the build_pipeline_stage_type property of this BuildStage. 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 BuildStage.
time_updated (datetime) – The value to assign to the time_updated property of this BuildStage.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BuildStage. 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 BuildStage.
build_pipeline_stage_predecessor_collection (oci.devops.models.BuildPipelineStagePredecessorCollection) – The value to assign to the build_pipeline_stage_predecessor_collection property of this BuildStage.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BuildStage.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BuildStage.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BuildStage.
image (str) – The value to assign to the image property of this BuildStage. Allowed values for this property are: “OL7_X86_64_STANDARD_10”, “OL8_X86_64_STANDARD_10”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
build_spec_file (str) – The value to assign to the build_spec_file property of this BuildStage.
stage_execution_timeout_in_seconds (int) – The value to assign to the stage_execution_timeout_in_seconds property of this BuildStage.
build_source_collection (oci.devops.models.BuildSourceCollection) – The value to assign to the build_source_collection property of this BuildStage.
primary_build_source (str) – The value to assign to the primary_build_source property of this BuildStage.
build_runner_shape_config (oci.devops.models.BuildRunnerShapeConfig) – The value to assign to the build_runner_shape_config property of this BuildStage.
private_access_config (oci.devops.models.NetworkChannel) – The value to assign to the private_access_config property of this BuildStage.

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_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE.

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

build_runner_shape_config¶

Gets the build_runner_shape_config of this BuildStage.

Returns:	The build_runner_shape_config of this BuildStage.
Return type:	oci.devops.models.BuildRunnerShapeConfig

build_source_collection¶

[Required] Gets the build_source_collection of this BuildStage.

Returns:	The build_source_collection of this BuildStage.
Return type:	oci.devops.models.BuildSourceCollection

build_spec_file¶

Gets the build_spec_file of this BuildStage. The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml.

Returns:	The build_spec_file of this BuildStage.
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

image¶

[Required] Gets the image of this BuildStage. Image name for the build environment.

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

Returns:	The image of this BuildStage.
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

primary_build_source¶

Gets the primary_build_source of this BuildStage. Name of the build source where the build_spec.yml file is located. If not specified, then the first entry in the build source collection is chosen as primary build source.

Returns:	The primary_build_source of this BuildStage.
Return type:	str

private_access_config¶

Gets the private_access_config of this BuildStage.

Returns:	The private_access_config of this BuildStage.
Return type:	oci.devops.models.NetworkChannel

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

stage_execution_timeout_in_seconds¶

Gets the stage_execution_timeout_in_seconds of this BuildStage. Timeout for the build stage execution. Specify value in seconds.

Returns:	The stage_execution_timeout_in_seconds of this BuildStage.
Return type:	int

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