PullRequest¶

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

Bases: object

Pull Request containing the diff between a review branch and a destination branch

Attributes

`LIFECYCLE_DETAILS_CLOSED`	A constant which can be used with the lifecycle_details property of a PullRequest.
`LIFECYCLE_DETAILS_CONFLICT`	A constant which can be used with the lifecycle_details property of a PullRequest.
`LIFECYCLE_DETAILS_MERGED`	A constant which can be used with the lifecycle_details property of a PullRequest.
`LIFECYCLE_DETAILS_MERGING`	A constant which can be used with the lifecycle_details property of a PullRequest.
`LIFECYCLE_DETAILS_OPEN`	A constant which can be used with the lifecycle_details property of a PullRequest.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a PullRequest.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a PullRequest.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a PullRequest.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a PullRequest.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a PullRequest.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a PullRequest.
`compartment_id`	[Required] Gets the compartment_id of this PullRequest.
`created_by`	[Required] Gets the created_by of this PullRequest.
`defined_tags`	[Required] Gets the defined_tags of this PullRequest.
`description`	Gets the description of this PullRequest.
`destination_branch`	[Required] Gets the destination_branch of this PullRequest.
`display_name`	[Required] Gets the display_name of this PullRequest.
`freeform_tags`	[Required] Gets the freeform_tags of this PullRequest.
`id`	[Required] Gets the id of this PullRequest.
`lifecycle_details`	[Required] Gets the lifecycle_details of this PullRequest.
`lifecycle_state`	[Required] Gets the lifecycle_state of this PullRequest.
`merge_base_commit_id_at_termination`	Gets the merge_base_commit_id_at_termination of this PullRequest.
`merge_checks`	Gets the merge_checks of this PullRequest.
`merged_by`	Gets the merged_by of this PullRequest.
`merged_commit_id`	Gets the merged_commit_id of this PullRequest.
`repository_id`	[Required] Gets the repository_id of this PullRequest.
`reviewers`	Gets the reviewers of this PullRequest.
`source_branch`	[Required] Gets the source_branch of this PullRequest.
`source_commit_id_at_termination`	Gets the source_commit_id_at_termination of this PullRequest.
`source_repository_id`	Gets the source_repository_id of this PullRequest.
`system_tags`	[Required] Gets the system_tags of this PullRequest.
`time_created`	[Required] Gets the time_created of this PullRequest.
`time_updated`	Gets the time_updated of this PullRequest.
`total_comments`	[Required] Gets the total_comments of this PullRequest.
`total_reviewers`	[Required] Gets the total_reviewers of this PullRequest.

Methods

__init__(**kwargs) Initializes a new PullRequest object with values from keyword arguments.

LIFECYCLE_DETAILS_CLOSED = 'CLOSED'¶: A constant which can be used with the lifecycle_details property of a PullRequest. This constant has a value of “CLOSED”

LIFECYCLE_DETAILS_CONFLICT = 'CONFLICT'¶: A constant which can be used with the lifecycle_details property of a PullRequest. This constant has a value of “CONFLICT”

LIFECYCLE_DETAILS_MERGED = 'MERGED'¶: A constant which can be used with the lifecycle_details property of a PullRequest. This constant has a value of “MERGED”

LIFECYCLE_DETAILS_MERGING = 'MERGING'¶: A constant which can be used with the lifecycle_details property of a PullRequest. This constant has a value of “MERGING”

LIFECYCLE_DETAILS_OPEN = 'OPEN'¶: A constant which can be used with the lifecycle_details property of a PullRequest. This constant has a value of “OPEN”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a PullRequest. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a PullRequest. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a PullRequest. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a PullRequest. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a PullRequest. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a PullRequest. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new PullRequest object with values from keyword arguments. 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 PullRequest.
display_name (str) – The value to assign to the display_name property of this PullRequest.
description (str) – The value to assign to the description property of this PullRequest.
compartment_id (str) – The value to assign to the compartment_id property of this PullRequest.
repository_id (str) – The value to assign to the repository_id property of this PullRequest.
source_branch (str) – The value to assign to the source_branch property of this PullRequest.
destination_branch (str) – The value to assign to the destination_branch property of this PullRequest.
source_commit_id_at_termination (str) – The value to assign to the source_commit_id_at_termination property of this PullRequest.
merge_base_commit_id_at_termination (str) – The value to assign to the merge_base_commit_id_at_termination property of this PullRequest.
time_created (datetime) – The value to assign to the time_created property of this PullRequest.
time_updated (datetime) – The value to assign to the time_updated property of this PullRequest.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PullRequest. 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 PullRequest. Allowed values for this property are: “OPEN”, “CONFLICT”, “CLOSED”, “MERGING”, “MERGED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
reviewers (list[oci.devops.models.Reviewer]) – The value to assign to the reviewers property of this PullRequest.
merged_commit_id (str) – The value to assign to the merged_commit_id property of this PullRequest.
merge_checks (oci.devops.models.MergeCheckCollection) – The value to assign to the merge_checks property of this PullRequest.
created_by (oci.devops.models.PrincipalDetails) – The value to assign to the created_by property of this PullRequest.
merged_by (oci.devops.models.PrincipalDetails) – The value to assign to the merged_by property of this PullRequest.
source_repository_id (str) – The value to assign to the source_repository_id property of this PullRequest.
total_comments (int) – The value to assign to the total_comments property of this PullRequest.
total_reviewers (int) – The value to assign to the total_reviewers property of this PullRequest.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PullRequest.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PullRequest.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PullRequest.

compartment_id¶

[Required] Gets the compartment_id of this PullRequest. Compartment Identifier

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

created_by¶

[Required] Gets the created_by of this PullRequest.

Returns:	The created_by of this PullRequest.
Return type:	oci.devops.models.PrincipalDetails

defined_tags¶

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

description¶

Gets the description of this PullRequest. Details of the pull request. Avoid entering confidential information.

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

destination_branch¶

[Required] Gets the destination_branch of this PullRequest. The destination branch against which the changes are to be reviewed. Example: “main”.

Returns:	The destination_branch of this PullRequest.
Return type:	str

display_name¶

[Required] Gets the display_name of this PullRequest. PullRequest title, can be renamed

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

freeform_tags¶

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

id¶

[Required] Gets the id of this PullRequest. Unique identifier that is immutable on creation

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

lifecycle_details¶

[Required] Gets the lifecycle_details of this PullRequest. The status of the Pull Request.

Allowed values for this property are: “OPEN”, “CONFLICT”, “CLOSED”, “MERGING”, “MERGED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_details of this PullRequest.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this PullRequest. The current state of the PullRequest.

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 PullRequest.
Return type:	str

merge_base_commit_id_at_termination¶

Gets the merge_base_commit_id_at_termination of this PullRequest. The merge base commit ID when the Pull Request status was last changed to merged or closed

Returns:	The merge_base_commit_id_at_termination of this PullRequest.
Return type:	str

merge_checks¶

Gets the merge_checks of this PullRequest.

Returns:	The merge_checks of this PullRequest.
Return type:	oci.devops.models.MergeCheckCollection

merged_by¶

Gets the merged_by of this PullRequest.

Returns:	The merged_by of this PullRequest.
Return type:	oci.devops.models.PrincipalDetails

merged_commit_id¶

Gets the merged_commit_id of this PullRequest. The commit ID when the Pull Request was merged.

Returns:	The merged_commit_id of this PullRequest.
Return type:	str

repository_id¶

[Required] Gets the repository_id of this PullRequest. DevOps Repository Identifier tells which repository this pull request belongs to

Returns:	The repository_id of this PullRequest.
Return type:	str

reviewers¶

Gets the reviewers of this PullRequest. List of Reviewers.

Returns:	The reviewers of this PullRequest.
Return type:	list[oci.devops.models.Reviewer]

source_branch¶

[Required] Gets the source_branch of this PullRequest. The source branch which contains the changes to be reviewed. Example: “feature/JIRA-123”

Returns:	The source_branch of this PullRequest.
Return type:	str

source_commit_id_at_termination¶

Gets the source_commit_id_at_termination of this PullRequest. The source branch commit ID when the Pull Request status was last changed to merged or closed

Returns:	The source_commit_id_at_termination of this PullRequest.
Return type:	str

source_repository_id¶

Gets the source_repository_id of this PullRequest. The OCID of the forked repository that will act as the source of the changes to be included in the pull request against the parent repository.

Returns:	The source_repository_id of this PullRequest.
Return type:	str

system_tags¶

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

time_created¶

[Required] Gets the time_created of this PullRequest. The time the PullRequest was created. An RFC3339 formatted datetime string

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

time_updated¶

Gets the time_updated of this PullRequest. The time the PullRequest was updated. An RFC3339 formatted datetime string

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

total_comments¶

[Required] Gets the total_comments of this PullRequest. The total number of comments on the pull request.

Returns:	The total_comments of this PullRequest.
Return type:	int

total_reviewers¶

[Required] Gets the total_reviewers of this PullRequest. The total number of reviewers on the pull request.

Returns:	The total_reviewers of this PullRequest.
Return type:	int