# Class BranchRule (0.6.0)

0.6.0 (latest) 0.5.0 0.4.0 0.3.0 0.2.0 0.1.17

    BranchRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metadata of a BranchRule. BranchRule is the protection rule
to enforce pre-defined rules on designated branches within a
repository.

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `name` | `str` Identifier. A unique identifier for a BranchRule. The name should be of the format: `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}` |
| `uid` | `str` Output only. Unique identifier of the repository. |
| `create_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. Create timestamp. |
| `update_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. Update timestamp. |
| `annotations` | `MutableMapping[str, str]` Optional. User annotations. These attributes can only be set and used by the user. See https://google.aip.dev/128#annotations for more details such as format and size limitations. |
| `etag` | `str` Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
| `include_pattern` | `str` Optional. The pattern of the branch that can match to this BranchRule. Specified as regex. .\\\* for all branches. Examples: main, (main\|release.\\\*). Current MVP phase only support `.*` for wildcard. |
| `disabled` | `bool` Optional. Determines if the branch rule is disabled or not. |
| `require_pull_request` | `bool` Optional. Determines if the branch rule requires a pull request or not. |
| `minimum_reviews_count` | `int` Optional. The minimum number of reviews required for the branch rule to be matched. |
| `minimum_approvals_count` | `int` Optional. The minimum number of approvals required for the branch rule to be matched. |
| `require_code_owner_approval` | `bool` Optional. Determines if code owners must approve before merging to the branch. |
| `require_comments_resolved` | `bool` Optional. Determines if require comments resolved before merging to the branch. |
| `allow_stale_reviews` | `bool` Optional. Determines if allow stale reviews or approvals before merging to the branch. |
| `require_linear_history` | `bool` Optional. Determines if require linear history before merging to the branch. |
| `required_status_checks` | `MutableSequence[https://docs.cloud.google.com/python/docs/reference/securesourcemanager/latest/google.cloud.securesourcemanager_v1.types.BranchRule.Check]` Optional. List of required status checks before merging to the branch. |

## Classes

### AnnotationsEntry

    AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `kwargs` | `dict` Keys and values corresponding to the fields of the message. |
| `mapping` | ``Union[dict, `.Message`]`` A dictionary or message to be used to determine the values for this message. |
| `ignore_unknown_fields` | `Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters. |

### Check

    Check(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Check is a type for status check.