FunctionDeployStageSummary¶

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

Bases: oci.devops.models.deploy_stage_summary.DeployStageSummary

Specifies the Function stage.

Methods

`__init__`(**kwargs)	Initializes a new FunctionDeployStageSummary 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.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this DeployStageSummary.
`config`	Gets the config of this FunctionDeployStageSummary.
`defined_tags`	Gets the defined_tags of this DeployStageSummary.
`deploy_pipeline_id`	[Required] Gets the deploy_pipeline_id of this DeployStageSummary.
`deploy_stage_predecessor_collection`	Gets the deploy_stage_predecessor_collection of this DeployStageSummary.
`deploy_stage_type`	[Required] Gets the deploy_stage_type of this DeployStageSummary.
`description`	Gets the description of this DeployStageSummary.
`display_name`	Gets the display_name of this DeployStageSummary.
`docker_image_deploy_artifact_id`	[Required] Gets the docker_image_deploy_artifact_id of this FunctionDeployStageSummary.
`freeform_tags`	Gets the freeform_tags of this DeployStageSummary.
`function_deploy_environment_id`	[Required] Gets the function_deploy_environment_id of this FunctionDeployStageSummary.
`function_timeout_in_seconds`	Gets the function_timeout_in_seconds of this FunctionDeployStageSummary.
`id`	[Required] Gets the id of this DeployStageSummary.
`lifecycle_details`	Gets the lifecycle_details of this DeployStageSummary.
`lifecycle_state`	Gets the lifecycle_state of this DeployStageSummary.
`max_memory_in_mbs`	Gets the max_memory_in_mbs of this FunctionDeployStageSummary.
`project_id`	[Required] Gets the project_id of this DeployStageSummary.
`system_tags`	Gets the system_tags of this DeployStageSummary.
`time_created`	Gets the time_created of this DeployStageSummary.
`time_updated`	Gets the time_updated of this DeployStageSummary.

__init__(**kwargs)¶

Initializes a new FunctionDeployStageSummary object with values from keyword arguments. The default value of the deploy_stage_type attribute of this class is DEPLOY_FUNCTION 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 FunctionDeployStageSummary.
description (str) – The value to assign to the description property of this FunctionDeployStageSummary.
display_name (str) – The value to assign to the display_name property of this FunctionDeployStageSummary.
project_id (str) – The value to assign to the project_id property of this FunctionDeployStageSummary.
deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this FunctionDeployStageSummary.
compartment_id (str) – The value to assign to the compartment_id property of this FunctionDeployStageSummary.
deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this FunctionDeployStageSummary.
time_created (datetime) – The value to assign to the time_created property of this FunctionDeployStageSummary.
time_updated (datetime) – The value to assign to the time_updated property of this FunctionDeployStageSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this FunctionDeployStageSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this FunctionDeployStageSummary.
deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this FunctionDeployStageSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this FunctionDeployStageSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this FunctionDeployStageSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this FunctionDeployStageSummary.
function_deploy_environment_id (str) – The value to assign to the function_deploy_environment_id property of this FunctionDeployStageSummary.
docker_image_deploy_artifact_id (str) – The value to assign to the docker_image_deploy_artifact_id property of this FunctionDeployStageSummary.
config (dict(str, str)) – The value to assign to the config property of this FunctionDeployStageSummary.
max_memory_in_mbs (int) – The value to assign to the max_memory_in_mbs property of this FunctionDeployStageSummary.
function_timeout_in_seconds (int) – The value to assign to the function_timeout_in_seconds property of this FunctionDeployStageSummary.

compartment_id¶

[Required] Gets the compartment_id of this DeployStageSummary. The OCID of a compartment.

Returns:	The compartment_id of this DeployStageSummary.
Return type:	str

config¶

Gets the config of this FunctionDeployStageSummary. User provided key and value pair configuration, which is assigned through constants or parameter.

Returns:	The config of this FunctionDeployStageSummary.
Return type:	dict(str, str)

defined_tags¶

Gets the defined_tags of this DeployStageSummary. 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 DeployStageSummary.
Return type:	dict(str, dict(str, object))

deploy_pipeline_id¶

[Required] Gets the deploy_pipeline_id of this DeployStageSummary. The OCID of a pipeline.

Returns:	The deploy_pipeline_id of this DeployStageSummary.
Return type:	str

deploy_stage_predecessor_collection¶

Gets the deploy_stage_predecessor_collection of this DeployStageSummary.

Returns:	The deploy_stage_predecessor_collection of this DeployStageSummary.
Return type:	oci.devops.models.DeployStagePredecessorCollection

deploy_stage_type¶

[Required] Gets the deploy_stage_type of this DeployStageSummary. Deployment stage type.

Returns:	The deploy_stage_type of this DeployStageSummary.
Return type:	str

description¶

Gets the description of this DeployStageSummary. Optional description about the deployment stage.

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

display_name¶

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

Returns:	The display_name of this DeployStageSummary.
Return type:	str

docker_image_deploy_artifact_id¶

[Required] Gets the docker_image_deploy_artifact_id of this FunctionDeployStageSummary. A Docker image artifact OCID.

Returns:	The docker_image_deploy_artifact_id of this FunctionDeployStageSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DeployStageSummary. 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 DeployStageSummary.
Return type:	dict(str, str)

function_deploy_environment_id¶

[Required] Gets the function_deploy_environment_id of this FunctionDeployStageSummary. Function environment OCID.

Returns:	The function_deploy_environment_id of this FunctionDeployStageSummary.
Return type:	str

function_timeout_in_seconds¶

Gets the function_timeout_in_seconds of this FunctionDeployStageSummary. Timeout for execution of the Function. Value in seconds.

Returns:	The function_timeout_in_seconds of this FunctionDeployStageSummary.
Return type:	int

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 DeployStageSummary. Unique identifier that is immutable on creation.

Returns:	The id of this DeployStageSummary.
Return type:	str

lifecycle_details¶

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

lifecycle_state¶

Gets the lifecycle_state of this DeployStageSummary. The current state of the deployment stage.

Returns:	The lifecycle_state of this DeployStageSummary.
Return type:	str

max_memory_in_mbs¶

Gets the max_memory_in_mbs of this FunctionDeployStageSummary. Maximum usable memory for the Function (in MB).

Returns:	The max_memory_in_mbs of this FunctionDeployStageSummary.
Return type:	int

project_id¶

[Required] Gets the project_id of this DeployStageSummary. The OCID of a project.

Returns:	The project_id of this DeployStageSummary.
Return type:	str

system_tags¶

Gets the system_tags of this DeployStageSummary. 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 DeployStageSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this DeployStageSummary. Time the deployment stage was created. Format defined by RFC3339.

Returns:	The time_created of this DeployStageSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this DeployStageSummary. Time the deployment stage was updated. Format defined by RFC3339.

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