CreateInvokeFunctionDeployStageDetails

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

Bases: CreateDeployStageDetails

Specifies Invoke Function stage.

Methods:

__init__(**kwargs)

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

defined_tags

Gets the defined_tags of this CreateDeployStageDetails.

deploy_artifact_id

Gets the deploy_artifact_id of this CreateInvokeFunctionDeployStageDetails.

deploy_pipeline_id

[Required] Gets the deploy_pipeline_id of this CreateDeployStageDetails.

deploy_stage_predecessor_collection

[Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.

deploy_stage_type

[Required] Gets the deploy_stage_type of this CreateDeployStageDetails.

description

Gets the description of this CreateDeployStageDetails.

display_name

Gets the display_name of this CreateDeployStageDetails.

freeform_tags

Gets the freeform_tags of this CreateDeployStageDetails.

function_deploy_environment_id

[Required] Gets the function_deploy_environment_id of this CreateInvokeFunctionDeployStageDetails.

is_async

[Required] Gets the is_async of this CreateInvokeFunctionDeployStageDetails.

is_validation_enabled

[Required] Gets the is_validation_enabled of this CreateInvokeFunctionDeployStageDetails.

__init__(**kwargs)

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

Parameters
  • description (str) – The value to assign to the description property of this CreateInvokeFunctionDeployStageDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateInvokeFunctionDeployStageDetails.

  • deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this CreateInvokeFunctionDeployStageDetails.

  • deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this CreateInvokeFunctionDeployStageDetails.

  • deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this CreateInvokeFunctionDeployStageDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateInvokeFunctionDeployStageDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateInvokeFunctionDeployStageDetails.

  • function_deploy_environment_id (str) – The value to assign to the function_deploy_environment_id property of this CreateInvokeFunctionDeployStageDetails.

  • deploy_artifact_id (str) – The value to assign to the deploy_artifact_id property of this CreateInvokeFunctionDeployStageDetails.

  • is_async (bool) – The value to assign to the is_async property of this CreateInvokeFunctionDeployStageDetails.

  • is_validation_enabled (bool) – The value to assign to the is_validation_enabled property of this CreateInvokeFunctionDeployStageDetails.

property defined_tags

Gets the defined_tags of this CreateDeployStageDetails. 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 CreateDeployStageDetails.

Return type

dict(str, dict(str, object))

property deploy_artifact_id

Gets the deploy_artifact_id of this CreateInvokeFunctionDeployStageDetails. Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage’s execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

Returns

The deploy_artifact_id of this CreateInvokeFunctionDeployStageDetails.

Return type

str

property deploy_pipeline_id

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

Returns

The deploy_pipeline_id of this CreateDeployStageDetails.

Return type

str

property deploy_stage_predecessor_collection

[Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.

Returns

The deploy_stage_predecessor_collection of this CreateDeployStageDetails.

Return type

oci.devops.models.DeployStagePredecessorCollection

property deploy_stage_type

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

Returns

The deploy_stage_type of this CreateDeployStageDetails.

Return type

str

property description

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

Returns

The description of this CreateDeployStageDetails.

Return type

str

property display_name

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

Returns

The display_name of this CreateDeployStageDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDeployStageDetails. 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 CreateDeployStageDetails.

Return type

dict(str, str)

property function_deploy_environment_id

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

Returns

The function_deploy_environment_id of this CreateInvokeFunctionDeployStageDetails.

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 is_async

[Required] Gets the is_async of this CreateInvokeFunctionDeployStageDetails. A boolean flag specifies whether this stage executes asynchronously.

Returns

The is_async of this CreateInvokeFunctionDeployStageDetails.

Return type

bool

property is_validation_enabled

[Required] Gets the is_validation_enabled of this CreateInvokeFunctionDeployStageDetails. A boolean flag specifies whether the invoked function should be validated.

Returns

The is_validation_enabled of this CreateInvokeFunctionDeployStageDetails.

Return type

bool