ScmConfiguration¶

class oci.adm.models.ScmConfiguration(**kwargs)¶

Bases: object

A configuration for the Source Code Management tool/platform used by a remediation recipe.

Attributes

`SCM_TYPE_EXTERNAL_SCM`	A constant which can be used with the scm_type property of a ScmConfiguration.
`SCM_TYPE_OCI_CODE_REPOSITORY`	A constant which can be used with the scm_type property of a ScmConfiguration.
`branch`	[Required] Gets the branch of this ScmConfiguration.
`build_file_location`	Gets the build_file_location of this ScmConfiguration.
`is_automerge_enabled`	[Required] Gets the is_automerge_enabled of this ScmConfiguration.
`scm_type`	[Required] Gets the scm_type of this ScmConfiguration.

Methods

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

SCM_TYPE_EXTERNAL_SCM = 'EXTERNAL_SCM'¶: A constant which can be used with the scm_type property of a ScmConfiguration. This constant has a value of “EXTERNAL_SCM”

SCM_TYPE_OCI_CODE_REPOSITORY = 'OCI_CODE_REPOSITORY'¶: A constant which can be used with the scm_type property of a ScmConfiguration. This constant has a value of “OCI_CODE_REPOSITORY”

__init__(**kwargs)¶

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

scm_type (str) – The value to assign to the scm_type property of this ScmConfiguration. Allowed values for this property are: “OCI_CODE_REPOSITORY”, “EXTERNAL_SCM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
branch (str) – The value to assign to the branch property of this ScmConfiguration.
build_file_location (str) – The value to assign to the build_file_location property of this ScmConfiguration.
is_automerge_enabled (bool) – The value to assign to the is_automerge_enabled property of this ScmConfiguration.

branch¶

[Required] Gets the branch of this ScmConfiguration. The branch used by ADM to patch vulnerabilities.

Returns:	The branch of this ScmConfiguration.
Return type:	str

build_file_location¶

Gets the build_file_location of this ScmConfiguration. The location of the build file relative to the root of the repository. Only Maven build files (POM) are currently supported. If this property is not specified, ADM will use the build file located at the root of the repository.

Returns:	The build_file_location of this ScmConfiguration.
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.

is_automerge_enabled¶

[Required] Gets the is_automerge_enabled of this ScmConfiguration. If true, the Pull Request (PR) will be merged after the verify stage completes successfully If false, the PR with the proposed changes must be reviewed and manually merged.

Returns:	The is_automerge_enabled of this ScmConfiguration.
Return type:	bool

scm_type¶

[Required] Gets the scm_type of this ScmConfiguration. The type of Source Code Management.

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

Returns:	The scm_type of this ScmConfiguration.
Return type:	str