PullRequestComment¶

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

Bases: object

User comments created by reviewers during the pull request review.

Attributes

`CONTEXT_STATUS_NEEDS_PROCESSING`	A constant which can be used with the context_status property of a PullRequestComment.
`CONTEXT_STATUS_PROCESSED`	A constant which can be used with the context_status property of a PullRequestComment.
`FILE_TYPE_DESTINATION`	A constant which can be used with the file_type property of a PullRequestComment.
`FILE_TYPE_SOURCE`	A constant which can be used with the file_type property of a PullRequestComment.
`STATUS_ACTIVE`	A constant which can be used with the status property of a PullRequestComment.
`STATUS_OUTDATED`	A constant which can be used with the status property of a PullRequestComment.
`comment_context`	Gets the comment_context of this PullRequestComment.
`commit_id`	Gets the commit_id of this PullRequestComment.
`context_status`	Gets the context_status of this PullRequestComment.
`created_by`	[Required] Gets the created_by of this PullRequestComment.
`data`	[Required] Gets the data of this PullRequestComment.
`file_path`	Gets the file_path of this PullRequestComment.
`file_type`	Gets the file_type of this PullRequestComment.
`id`	[Required] Gets the id of this PullRequestComment.
`likes`	Gets the likes of this PullRequestComment.
`line_number`	Gets the line_number of this PullRequestComment.
`parent_id`	Gets the parent_id of this PullRequestComment.
`pull_request_id`	[Required] Gets the pull_request_id of this PullRequestComment.
`status`	[Required] Gets the status of this PullRequestComment.
`time_created`	[Required] Gets the time_created of this PullRequestComment.
`time_updated`	Gets the time_updated of this PullRequestComment.
`updated_by`	Gets the updated_by of this PullRequestComment.

Methods

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

CONTEXT_STATUS_NEEDS_PROCESSING = 'NEEDS_PROCESSING'¶: A constant which can be used with the context_status property of a PullRequestComment. This constant has a value of “NEEDS_PROCESSING”

CONTEXT_STATUS_PROCESSED = 'PROCESSED'¶: A constant which can be used with the context_status property of a PullRequestComment. This constant has a value of “PROCESSED”

FILE_TYPE_DESTINATION = 'DESTINATION'¶: A constant which can be used with the file_type property of a PullRequestComment. This constant has a value of “DESTINATION”

FILE_TYPE_SOURCE = 'SOURCE'¶: A constant which can be used with the file_type property of a PullRequestComment. This constant has a value of “SOURCE”

STATUS_ACTIVE = 'ACTIVE'¶: A constant which can be used with the status property of a PullRequestComment. This constant has a value of “ACTIVE”

STATUS_OUTDATED = 'OUTDATED'¶: A constant which can be used with the status property of a PullRequestComment. This constant has a value of “OUTDATED”

__init__(**kwargs)¶

Initializes a new PullRequestComment 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 PullRequestComment.
pull_request_id (str) – The value to assign to the pull_request_id property of this PullRequestComment.
data (str) – The value to assign to the data property of this PullRequestComment.
parent_id (str) – The value to assign to the parent_id property of this PullRequestComment.
file_path (str) – The value to assign to the file_path property of this PullRequestComment.
commit_id (str) – The value to assign to the commit_id property of this PullRequestComment.
file_type (str) – The value to assign to the file_type property of this PullRequestComment. Allowed values for this property are: “SOURCE”, “DESTINATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
line_number (int) – The value to assign to the line_number property of this PullRequestComment.
likes (oci.devops.models.PullRequestCommentLikeCollection) – The value to assign to the likes property of this PullRequestComment.
status (str) – The value to assign to the status property of this PullRequestComment. Allowed values for this property are: “ACTIVE”, “OUTDATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this PullRequestComment.
created_by (oci.devops.models.PrincipalDetails) – The value to assign to the created_by property of this PullRequestComment.
time_updated (datetime) – The value to assign to the time_updated property of this PullRequestComment.
updated_by (oci.devops.models.PrincipalDetails) – The value to assign to the updated_by property of this PullRequestComment.
context_status (str) – The value to assign to the context_status property of this PullRequestComment. Allowed values for this property are: “PROCESSED”, “NEEDS_PROCESSING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
comment_context (list[oci.devops.models.DiffLineDetails]) – The value to assign to the comment_context property of this PullRequestComment.

comment_context¶

Gets the comment_context of this PullRequestComment. 4 line snippet to be displayed as context for inline comments

Returns:	The comment_context of this PullRequestComment.
Return type:	list[oci.devops.models.DiffLineDetails]

commit_id¶

Gets the commit_id of this PullRequestComment. Commit SHA

Returns:	The commit_id of this PullRequestComment.
Return type:	str

context_status¶

Gets the context_status of this PullRequestComment. Shows the status of an inline comments context

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

Returns:	The context_status of this PullRequestComment.
Return type:	str

created_by¶

[Required] Gets the created_by of this PullRequestComment.

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

data¶

[Required] Gets the data of this PullRequestComment. Content of the Comment.

Returns:	The data of this PullRequestComment.
Return type:	str

file_path¶

Gets the file_path of this PullRequestComment. File path in the commit

Returns:	The file_path of this PullRequestComment.
Return type:	str

file_type¶

Gets the file_type of this PullRequestComment. File path in the target commit

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

Returns:	The file_type of this PullRequestComment.
Return type:	str

id¶

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

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

likes¶

Gets the likes of this PullRequestComment.

Returns:	The likes of this PullRequestComment.
Return type:	oci.devops.models.PullRequestCommentLikeCollection

line_number¶

Gets the line_number of this PullRequestComment. Line number in the file

Returns:	The line_number of this PullRequestComment.
Return type:	int

parent_id¶

Gets the parent_id of this PullRequestComment. ID of parent Comment

Returns:	The parent_id of this PullRequestComment.
Return type:	str

pull_request_id¶

[Required] Gets the pull_request_id of this PullRequestComment. OCID of the pull request that this comment belongs to

Returns:	The pull_request_id of this PullRequestComment.
Return type:	str

status¶

[Required] Gets the status of this PullRequestComment. Status of the Comment

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

Returns:	The status of this PullRequestComment.
Return type:	str

time_created¶

[Required] Gets the time_created of this PullRequestComment. Creation timestamp. Format defined by RFC3339.

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

time_updated¶

Gets the time_updated of this PullRequestComment. Latest update timestamp. Format defined by RFC3339.

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

updated_by¶

Gets the updated_by of this PullRequestComment.

Returns:	The updated_by of this PullRequestComment.
Return type:	oci.devops.models.PrincipalDetails