SummarizeProjectRepositoryAnalyticsDetails¶
-
class
oci.devops.models.SummarizeProjectRepositoryAnalyticsDetails(**kwargs)¶ Bases:
objectDetails of the user configured settings for viewing the metrics at project level.
Attributes
AGGREGATION_DURATION_DAILYA constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. AGGREGATION_DURATION_MONTHLYA constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. AGGREGATION_DURATION_WEEKLYA constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. AGGREGATION_DURATION_YEARLYA constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. GROUP_BY_AUTHORA constant which can be used with the group_by property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_COMMITSA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_LINES_ADDEDA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_LINES_DELETEDA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_APPROVEDA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_COMMENTSA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_CREATEDA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_DECLINEDA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_MERGEDA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_REVIEWEDA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_REVIEW_DURATION_IN_DAYSA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. REPOSITORY_METRICS_PULL_REQUEST_REVIEW_START_DURATION_IN_DAYSA constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. aggregation_durationGets the aggregation_duration of this SummarizeProjectRepositoryAnalyticsDetails. author_emailGets the author_email of this SummarizeProjectRepositoryAnalyticsDetails. end_timeGets the end_time of this SummarizeProjectRepositoryAnalyticsDetails. group_byGets the group_by of this SummarizeProjectRepositoryAnalyticsDetails. repository_metrics[Required] Gets the repository_metrics of this SummarizeProjectRepositoryAnalyticsDetails. start_time[Required] Gets the start_time of this SummarizeProjectRepositoryAnalyticsDetails. Methods
__init__(**kwargs)Initializes a new SummarizeProjectRepositoryAnalyticsDetails object with values from keyword arguments. -
AGGREGATION_DURATION_DAILY= 'DAILY'¶ A constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “DAILY”
-
AGGREGATION_DURATION_MONTHLY= 'MONTHLY'¶ A constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “MONTHLY”
-
AGGREGATION_DURATION_WEEKLY= 'WEEKLY'¶ A constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “WEEKLY”
-
AGGREGATION_DURATION_YEARLY= 'YEARLY'¶ A constant which can be used with the aggregation_duration property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “YEARLY”
-
GROUP_BY_AUTHOR= 'AUTHOR'¶ A constant which can be used with the group_by property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “AUTHOR”
-
REPOSITORY_METRICS_COMMITS= 'COMMITS'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “COMMITS”
-
REPOSITORY_METRICS_LINES_ADDED= 'LINES_ADDED'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “LINES_ADDED”
-
REPOSITORY_METRICS_LINES_DELETED= 'LINES_DELETED'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “LINES_DELETED”
-
REPOSITORY_METRICS_PULL_REQUEST_APPROVED= 'PULL_REQUEST_APPROVED'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_APPROVED”
-
REPOSITORY_METRICS_PULL_REQUEST_COMMENTS= 'PULL_REQUEST_COMMENTS'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_COMMENTS”
-
REPOSITORY_METRICS_PULL_REQUEST_CREATED= 'PULL_REQUEST_CREATED'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_CREATED”
-
REPOSITORY_METRICS_PULL_REQUEST_DECLINED= 'PULL_REQUEST_DECLINED'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_DECLINED”
-
REPOSITORY_METRICS_PULL_REQUEST_MERGED= 'PULL_REQUEST_MERGED'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_MERGED”
-
REPOSITORY_METRICS_PULL_REQUEST_REVIEWED= 'PULL_REQUEST_REVIEWED'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_REVIEWED”
-
REPOSITORY_METRICS_PULL_REQUEST_REVIEW_DURATION_IN_DAYS= 'PULL_REQUEST_REVIEW_DURATION_IN_DAYS'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_REVIEW_DURATION_IN_DAYS”
-
REPOSITORY_METRICS_PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS= 'PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS'¶ A constant which can be used with the repository_metrics property of a SummarizeProjectRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS”
-
__init__(**kwargs)¶ Initializes a new SummarizeProjectRepositoryAnalyticsDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - author_email (str) – The value to assign to the author_email property of this SummarizeProjectRepositoryAnalyticsDetails.
- repository_metrics (list[str]) – The value to assign to the repository_metrics property of this SummarizeProjectRepositoryAnalyticsDetails. Allowed values for items in this list are: “COMMITS”, “LINES_ADDED”, “LINES_DELETED”, “PULL_REQUEST_CREATED”, “PULL_REQUEST_MERGED”, “PULL_REQUEST_DECLINED”, “PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS”, “PULL_REQUEST_REVIEW_DURATION_IN_DAYS”, “PULL_REQUEST_APPROVED”, “PULL_REQUEST_REVIEWED”, “PULL_REQUEST_COMMENTS”
- aggregation_duration (str) – The value to assign to the aggregation_duration property of this SummarizeProjectRepositoryAnalyticsDetails. Allowed values for this property are: “DAILY”, “WEEKLY”, “MONTHLY”, “YEARLY”
- start_time (datetime) – The value to assign to the start_time property of this SummarizeProjectRepositoryAnalyticsDetails.
- end_time (datetime) – The value to assign to the end_time property of this SummarizeProjectRepositoryAnalyticsDetails.
- group_by (str) – The value to assign to the group_by property of this SummarizeProjectRepositoryAnalyticsDetails. Allowed values for this property are: “AUTHOR”
-
aggregation_duration¶ Gets the aggregation_duration of this SummarizeProjectRepositoryAnalyticsDetails. Metrics aggregated for the defined period.
Allowed values for this property are: “DAILY”, “WEEKLY”, “MONTHLY”, “YEARLY”
Returns: The aggregation_duration of this SummarizeProjectRepositoryAnalyticsDetails. Return type: str
Gets the author_email of this SummarizeProjectRepositoryAnalyticsDetails. Email address of the author.
Returns: The author_email of this SummarizeProjectRepositoryAnalyticsDetails. Return type: str
-
end_time¶ Gets the end_time of this SummarizeProjectRepositoryAnalyticsDetails. The end of the metric data query time range.
Returns: The end_time of this SummarizeProjectRepositoryAnalyticsDetails. Return type: datetime
-
group_by¶ Gets the group_by of this SummarizeProjectRepositoryAnalyticsDetails. Attribute by which metric data has to be grouped
Allowed values for this property are: “AUTHOR”
Returns: The group_by of this SummarizeProjectRepositoryAnalyticsDetails. Return type: str
-
repository_metrics¶ [Required] Gets the repository_metrics of this SummarizeProjectRepositoryAnalyticsDetails. The name of the metric to be filtered.
Allowed values for items in this list are: “COMMITS”, “LINES_ADDED”, “LINES_DELETED”, “PULL_REQUEST_CREATED”, “PULL_REQUEST_MERGED”, “PULL_REQUEST_DECLINED”, “PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS”, “PULL_REQUEST_REVIEW_DURATION_IN_DAYS”, “PULL_REQUEST_APPROVED”, “PULL_REQUEST_REVIEWED”, “PULL_REQUEST_COMMENTS”
Returns: The repository_metrics of this SummarizeProjectRepositoryAnalyticsDetails. Return type: list[str]
-
start_time¶ [Required] Gets the start_time of this SummarizeProjectRepositoryAnalyticsDetails. The beginning of the metric data query time range.
Returns: The start_time of this SummarizeProjectRepositoryAnalyticsDetails. Return type: datetime
-