SummarizeRepositoryAnalyticsDetails

class oci.devops.models.SummarizeRepositoryAnalyticsDetails(**kwargs)

Bases: object

Details of the user configured settings for viewing the metrics at repository level.

Attributes:

AGGREGATION_DURATION_DAILY

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails.

AGGREGATION_DURATION_MONTHLY

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails.

AGGREGATION_DURATION_WEEKLY

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails.

AGGREGATION_DURATION_YEARLY

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails.

GROUP_BY_AUTHOR

A constant which can be used with the group_by property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_COMMITS

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_LINES_ADDED

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_LINES_DELETED

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_APPROVED

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_COMMENTS

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_CREATED

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_DECLINED

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_MERGED

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_REVIEWED

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_REVIEW_DURATION_IN_DAYS

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

REPOSITORY_METRICS_PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails.

aggregation_duration

Gets the aggregation_duration of this SummarizeRepositoryAnalyticsDetails.

author_email

Gets the author_email of this SummarizeRepositoryAnalyticsDetails.

end_time

Gets the end_time of this SummarizeRepositoryAnalyticsDetails.

group_by

Gets the group_by of this SummarizeRepositoryAnalyticsDetails.

repository_metrics

[Required] Gets the repository_metrics of this SummarizeRepositoryAnalyticsDetails.

start_time

[Required] Gets the start_time of this SummarizeRepositoryAnalyticsDetails.

Methods:

__init__(**kwargs)

Initializes a new SummarizeRepositoryAnalyticsDetails object with values from keyword arguments.

AGGREGATION_DURATION_DAILY = 'DAILY'

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails. This constant has a value of “DAILY”

AGGREGATION_DURATION_MONTHLY = 'MONTHLY'

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails. This constant has a value of “MONTHLY”

AGGREGATION_DURATION_WEEKLY = 'WEEKLY'

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails. This constant has a value of “WEEKLY”

AGGREGATION_DURATION_YEARLY = 'YEARLY'

A constant which can be used with the aggregation_duration property of a SummarizeRepositoryAnalyticsDetails. This constant has a value of “YEARLY”

GROUP_BY_AUTHOR = 'AUTHOR'

A constant which can be used with the group_by property of a SummarizeRepositoryAnalyticsDetails. This constant has a value of “AUTHOR”

REPOSITORY_METRICS_COMMITS = 'COMMITS'

A constant which can be used with the repository_metrics property of a SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. This constant has a value of “PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS”

__init__(**kwargs)

Initializes a new SummarizeRepositoryAnalyticsDetails 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 SummarizeRepositoryAnalyticsDetails.

  • repository_metrics (list[str]) – The value to assign to the repository_metrics property of this SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails. Allowed values for this property are: “DAILY”, “WEEKLY”, “MONTHLY”, “YEARLY”

  • start_time (datetime) – The value to assign to the start_time property of this SummarizeRepositoryAnalyticsDetails.

  • end_time (datetime) – The value to assign to the end_time property of this SummarizeRepositoryAnalyticsDetails.

  • group_by (str) – The value to assign to the group_by property of this SummarizeRepositoryAnalyticsDetails. Allowed values for this property are: “AUTHOR”

property aggregation_duration

Gets the aggregation_duration of this SummarizeRepositoryAnalyticsDetails. Metrics aggregated for the defined period.

Allowed values for this property are: “DAILY”, “WEEKLY”, “MONTHLY”, “YEARLY”

Returns

The aggregation_duration of this SummarizeRepositoryAnalyticsDetails.

Return type

str

property author_email

Gets the author_email of this SummarizeRepositoryAnalyticsDetails. Email address of the author.

Returns

The author_email of this SummarizeRepositoryAnalyticsDetails.

Return type

str

property end_time

Gets the end_time of this SummarizeRepositoryAnalyticsDetails. The end of the metric data query time range.

Returns

The end_time of this SummarizeRepositoryAnalyticsDetails.

Return type

datetime

property group_by

Gets the group_by of this SummarizeRepositoryAnalyticsDetails. Attribute by which metric data has to be grouped

Allowed values for this property are: “AUTHOR”

Returns

The group_by of this SummarizeRepositoryAnalyticsDetails.

Return type

str

property repository_metrics

[Required] Gets the repository_metrics of this SummarizeRepositoryAnalyticsDetails. 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 SummarizeRepositoryAnalyticsDetails.

Return type

list[str]

property start_time

[Required] Gets the start_time of this SummarizeRepositoryAnalyticsDetails. The beginning of the metric data query time range.

Returns

The start_time of this SummarizeRepositoryAnalyticsDetails.

Return type

datetime