JenkinsPipelineConfiguration¶
- class oci.adm.models.JenkinsPipelineConfiguration(**kwargs)¶
Bases:
VerifyConfigurationExtends a Verify configuration with appropriate data to reach and use the build service provided by a Jenkins Pipeline.
Attributes:
A constant which can be used with the build_service_type property of a VerifyConfiguration.
A constant which can be used with the build_service_type property of a VerifyConfiguration.
A constant which can be used with the build_service_type property of a VerifyConfiguration.
A constant which can be used with the build_service_type property of a VerifyConfiguration.
A constant which can be used with the build_service_type property of a VerifyConfiguration.
Gets the additional_parameters of this JenkinsPipelineConfiguration.
[Required] Gets the build_service_type of this VerifyConfiguration.
[Required] Gets the jenkins_url of this JenkinsPipelineConfiguration.
[Required] Gets the job_name of this JenkinsPipelineConfiguration.
[Required] Gets the pat_secret_id of this JenkinsPipelineConfiguration.
[Required] Gets the username of this JenkinsPipelineConfiguration.
Methods:
__init__(**kwargs)Initializes a new JenkinsPipelineConfiguration 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_SERVICE_TYPE_GITHUB_ACTIONS = 'GITHUB_ACTIONS'¶
A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “GITHUB_ACTIONS”
- BUILD_SERVICE_TYPE_GITLAB_PIPELINE = 'GITLAB_PIPELINE'¶
A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “GITLAB_PIPELINE”
- BUILD_SERVICE_TYPE_JENKINS_PIPELINE = 'JENKINS_PIPELINE'¶
A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “JENKINS_PIPELINE”
- BUILD_SERVICE_TYPE_NONE = 'NONE'¶
A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “NONE”
- BUILD_SERVICE_TYPE_OCI_DEVOPS_BUILD = 'OCI_DEVOPS_BUILD'¶
A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “OCI_DEVOPS_BUILD”
- __init__(**kwargs)¶
Initializes a new JenkinsPipelineConfiguration object with values from keyword arguments. The default value of the
build_service_typeattribute of this class isJENKINS_PIPELINEand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
build_service_type (str) – The value to assign to the build_service_type property of this JenkinsPipelineConfiguration. Allowed values for this property are: “OCI_DEVOPS_BUILD”, “GITLAB_PIPELINE”, “GITHUB_ACTIONS”, “JENKINS_PIPELINE”, “NONE”
username (str) – The value to assign to the username property of this JenkinsPipelineConfiguration.
pat_secret_id (str) – The value to assign to the pat_secret_id property of this JenkinsPipelineConfiguration.
jenkins_url (str) – The value to assign to the jenkins_url property of this JenkinsPipelineConfiguration.
job_name (str) – The value to assign to the job_name property of this JenkinsPipelineConfiguration.
additional_parameters (dict(str, str)) – The value to assign to the additional_parameters property of this JenkinsPipelineConfiguration.
- property additional_parameters¶
Gets the additional_parameters of this JenkinsPipelineConfiguration. Additional key-value pairs passed as parameters to the build service when running an experiment.
- Returns
The additional_parameters of this JenkinsPipelineConfiguration.
- Return type
dict(str, str)
- property build_service_type¶
[Required] Gets the build_service_type of this VerifyConfiguration. The type of Build Service.
Allowed values for this property are: “OCI_DEVOPS_BUILD”, “GITLAB_PIPELINE”, “GITHUB_ACTIONS”, “JENKINS_PIPELINE”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The build_service_type of this VerifyConfiguration.
- 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 jenkins_url¶
[Required] Gets the jenkins_url of this JenkinsPipelineConfiguration. The URL that locates the Jenkins pipeline.
- Returns
The jenkins_url of this JenkinsPipelineConfiguration.
- Return type
str
- property job_name¶
[Required] Gets the job_name of this JenkinsPipelineConfiguration. The name of the Jenkins pipeline job that identifies the build pipeline.
- Returns
The job_name of this JenkinsPipelineConfiguration.
- Return type
str
- property pat_secret_id¶
[Required] Gets the pat_secret_id of this JenkinsPipelineConfiguration. The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.
- Returns
The pat_secret_id of this JenkinsPipelineConfiguration.
- Return type
str
- property username¶
[Required] Gets the username of this JenkinsPipelineConfiguration. The username that will be used to authenticate with Jenkins.
- Returns
The username of this JenkinsPipelineConfiguration.
- Return type
str