PullRequestSummary¶
- class oci.devops.models.PullRequestSummary(**kwargs)¶
Bases:
objectSummary of the Pull Request.
Methods:
__init__(**kwargs)Initializes a new PullRequestSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this PullRequestSummary.
[Required] Gets the created_by of this PullRequestSummary.
[Required] Gets the defined_tags of this PullRequestSummary.
Gets the description of this PullRequestSummary.
[Required] Gets the destination_branch of this PullRequestSummary.
[Required] Gets the display_name of this PullRequestSummary.
[Required] Gets the freeform_tags of this PullRequestSummary.
[Required] Gets the id of this PullRequestSummary.
[Required] Gets the lifecycle_details of this PullRequestSummary.
[Required] Gets the lifecycle_state of this PullRequestSummary.
Gets the merge_base_commit_id_at_termination of this PullRequestSummary.
[Required] Gets the repository_id of this PullRequestSummary.
[Required] Gets the source_branch of this PullRequestSummary.
Gets the source_commit_id_at_termination of this PullRequestSummary.
Gets the source_repository_id of this PullRequestSummary.
[Required] Gets the system_tags of this PullRequestSummary.
[Required] Gets the time_created of this PullRequestSummary.
Gets the time_updated of this PullRequestSummary.
[Required] Gets the total_comments of this PullRequestSummary.
[Required] Gets the total_reviewers of this PullRequestSummary.
- __init__(**kwargs)¶
Initializes a new PullRequestSummary 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 PullRequestSummary.
display_name (str) – The value to assign to the display_name property of this PullRequestSummary.
compartment_id (str) – The value to assign to the compartment_id property of this PullRequestSummary.
description (str) – The value to assign to the description property of this PullRequestSummary.
repository_id (str) – The value to assign to the repository_id property of this PullRequestSummary.
source_repository_id (str) – The value to assign to the source_repository_id property of this PullRequestSummary.
source_branch (str) – The value to assign to the source_branch property of this PullRequestSummary.
destination_branch (str) – The value to assign to the destination_branch property of this PullRequestSummary.
source_commit_id_at_termination (str) – The value to assign to the source_commit_id_at_termination property of this PullRequestSummary.
merge_base_commit_id_at_termination (str) – The value to assign to the merge_base_commit_id_at_termination property of this PullRequestSummary.
time_created (datetime) – The value to assign to the time_created property of this PullRequestSummary.
time_updated (datetime) – The value to assign to the time_updated property of this PullRequestSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PullRequestSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this PullRequestSummary.
total_comments (int) – The value to assign to the total_comments property of this PullRequestSummary.
total_reviewers (int) – The value to assign to the total_reviewers property of this PullRequestSummary.
created_by (oci.devops.models.PrincipalDetails) – The value to assign to the created_by property of this PullRequestSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PullRequestSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PullRequestSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PullRequestSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this PullRequestSummary. Compartment Identifier
- Returns
The compartment_id of this PullRequestSummary.
- Return type
str
- property created_by¶
[Required] Gets the created_by of this PullRequestSummary.
- Returns
The created_by of this PullRequestSummary.
- Return type
- property defined_tags¶
[Required] Gets the defined_tags of this PullRequestSummary. 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 PullRequestSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this PullRequestSummary. Details of the pull request. Avoid entering confidential information.
- Returns
The description of this PullRequestSummary.
- Return type
str
- property destination_branch¶
[Required] Gets the destination_branch of this PullRequestSummary. The destination branch against which the changes are to be reviewed.
- Returns
The destination_branch of this PullRequestSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this PullRequestSummary. Pull Request title, can be renamed
- Returns
The display_name of this PullRequestSummary.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this PullRequestSummary. 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 PullRequestSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this PullRequestSummary. Unique identifier that is immutable on creation
- Returns
The id of this PullRequestSummary.
- Return type
str
- property lifecycle_details¶
[Required] Gets the lifecycle_details of this PullRequestSummary. The status of the Pull Request.
- Returns
The lifecycle_details of this PullRequestSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this PullRequestSummary. The current state of the Pull Request.
- Returns
The lifecycle_state of this PullRequestSummary.
- Return type
str
- property merge_base_commit_id_at_termination¶
Gets the merge_base_commit_id_at_termination of this PullRequestSummary. 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 PullRequestSummary.
- Return type
str
- property repository_id¶
[Required] Gets the repository_id of this PullRequestSummary. DevOps Repository Identifier
- Returns
The repository_id of this PullRequestSummary.
- Return type
str
- property source_branch¶
[Required] Gets the source_branch of this PullRequestSummary. The review branch which contains the changes to be reviewed.
- Returns
The source_branch of this PullRequestSummary.
- Return type
str
- property source_commit_id_at_termination¶
Gets the source_commit_id_at_termination of this PullRequestSummary. 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 PullRequestSummary.
- Return type
str
- property source_repository_id¶
Gets the source_repository_id of this PullRequestSummary. 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 PullRequestSummary.
- Return type
str
- property system_tags¶
[Required] Gets the system_tags of this PullRequestSummary. 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 PullRequestSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this PullRequestSummary. The time the the Pull Request was created. An RFC3339 formatted datetime string
- Returns
The time_created of this PullRequestSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this PullRequestSummary. The time the Pull Request was updated. An RFC3339 formatted datetime string
- Returns
The time_updated of this PullRequestSummary.
- Return type
datetime
- property total_comments¶
[Required] Gets the total_comments of this PullRequestSummary. The total number of comments on the pull request.
- Returns
The total_comments of this PullRequestSummary.
- Return type
int
- property total_reviewers¶
[Required] Gets the total_reviewers of this PullRequestSummary. The total number of reviewers on the pull request.
- Returns
The total_reviewers of this PullRequestSummary.
- Return type
int