RepositoryBranchSummary

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

Bases: RepositoryRefSummary

Branch related information.

Methods:

__init__(**kwargs)

Initializes a new RepositoryBranchSummary object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

Attributes:

commit_id

[Required] Gets the commit_id of this RepositoryBranchSummary.

defined_tags

Gets the defined_tags of this RepositoryRefSummary.

freeform_tags

Gets the freeform_tags of this RepositoryRefSummary.

full_ref_name

[Required] Gets the full_ref_name of this RepositoryRefSummary.

latest_commit_author_name

Gets the latest_commit_author_name of this RepositoryBranchSummary.

pull_request_state_counts

Gets the pull_request_state_counts of this RepositoryBranchSummary.

ref_name

[Required] Gets the ref_name of this RepositoryRefSummary.

ref_type

[Required] Gets the ref_type of this RepositoryRefSummary.

repository_id

[Required] Gets the repository_id of this RepositoryRefSummary.

system_tags

Gets the system_tags of this RepositoryRefSummary.

time_created

Gets the time_created of this RepositoryRefSummary.

time_updated

Gets the time_updated of this RepositoryRefSummary.

top_n_pull_requests

Gets the top_n_pull_requests of this RepositoryBranchSummary.

__init__(**kwargs)

Initializes a new RepositoryBranchSummary object with values from keyword arguments. The default value of the ref_type attribute of this class is BRANCH and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • ref_name (str) – The value to assign to the ref_name property of this RepositoryBranchSummary.

  • ref_type (str) – The value to assign to the ref_type property of this RepositoryBranchSummary.

  • full_ref_name (str) – The value to assign to the full_ref_name property of this RepositoryBranchSummary.

  • repository_id (str) – The value to assign to the repository_id property of this RepositoryBranchSummary.

  • time_created (datetime) – The value to assign to the time_created property of this RepositoryBranchSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this RepositoryBranchSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RepositoryBranchSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RepositoryBranchSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RepositoryBranchSummary.

  • commit_id (str) – The value to assign to the commit_id property of this RepositoryBranchSummary.

  • latest_commit_author_name (str) – The value to assign to the latest_commit_author_name property of this RepositoryBranchSummary.

  • top_n_pull_requests (list[oci.devops.models.PullRequestSummary]) – The value to assign to the top_n_pull_requests property of this RepositoryBranchSummary.

  • pull_request_state_counts (dict(str, int)) – The value to assign to the pull_request_state_counts property of this RepositoryBranchSummary.

property commit_id

[Required] Gets the commit_id of this RepositoryBranchSummary. Commit ID pointed to by the new branch.

Returns

The commit_id of this RepositoryBranchSummary.

Return type

str

property defined_tags

Gets the defined_tags of this RepositoryRefSummary. 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 RepositoryRefSummary.

Return type

dict(str, dict(str, object))

property freeform_tags

Gets the freeform_tags of this RepositoryRefSummary. 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 RepositoryRefSummary.

Return type

dict(str, str)

property full_ref_name

[Required] Gets the full_ref_name of this RepositoryRefSummary. Unique full reference name inside a repository.

Returns

The full_ref_name of this RepositoryRefSummary.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property latest_commit_author_name

Gets the latest_commit_author_name of this RepositoryBranchSummary. The author of latest commit

Returns

The latest_commit_author_name of this RepositoryBranchSummary.

Return type

str

property pull_request_state_counts

Gets the pull_request_state_counts of this RepositoryBranchSummary. Counts of pull requests for this branch grouped by their state.

Returns

The pull_request_state_counts of this RepositoryBranchSummary.

Return type

dict(str, int)

property ref_name

[Required] Gets the ref_name of this RepositoryRefSummary. Reference name inside a repository.

Returns

The ref_name of this RepositoryRefSummary.

Return type

str

property ref_type

[Required] Gets the ref_type of this RepositoryRefSummary. The type of reference (BRANCH or TAG).

Returns

The ref_type of this RepositoryRefSummary.

Return type

str

property repository_id

[Required] Gets the repository_id of this RepositoryRefSummary. The OCID of the repository containing the reference.

Returns

The repository_id of this RepositoryRefSummary.

Return type

str

property system_tags

Gets the system_tags of this RepositoryRefSummary. 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 RepositoryRefSummary.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this RepositoryRefSummary. Creation timestamp. Format defined by RFC3339.

Returns

The time_created of this RepositoryRefSummary.

Return type

datetime

property time_updated

Gets the time_updated of this RepositoryRefSummary. The time the ref was updated. Format defined by RFC3339.

Returns

The time_updated of this RepositoryRefSummary.

Return type

datetime

property top_n_pull_requests

Gets the top_n_pull_requests of this RepositoryBranchSummary. Up to 5 pull requests associated with this branch.

Returns

The top_n_pull_requests of this RepositoryBranchSummary.

Return type

list[oci.devops.models.PullRequestSummary]