Struct BranchRule 

#[non_exhaustive]
pub struct BranchRule {

    pub name: String,
    pub uid: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub annotations: HashMap<String, String>,
    pub etag: String,
    pub include_pattern: String,
    pub disabled: bool,
    pub require_pull_request: bool,
    pub minimum_reviews_count: i32,
    pub minimum_approvals_count: i32,
    pub require_code_owner_approval: bool,
    pub require_comments_resolved: bool,
    pub allow_stale_reviews: bool,
    pub require_linear_history: bool,
    pub required_status_checks: Vec<Check>,
    /* private fields */
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Identifier. A unique identifier for a BranchRule. The name should be of the format: projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}

uid: String

Output only. Unique identifier of the repository.

create_time: Option<Timestamp>

Output only. Create timestamp.

update_time: Option<Timestamp>

Output only. Update timestamp.

annotations: HashMap<String, String>

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: String

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: String

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: i32

Optional. The minimum number of reviews required for the branch rule to be matched.

minimum_approvals_count: i32

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: Vec<Check>

Optional. List of required status checks before merging to the branch.

Implementations

impl BranchRule

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = BranchRule::new().set_name(format!("projects/{project_id}/locations/{location_id}/repositories/{repository_id}/branchRules/{branch_rule_id}"));

pub fn set_uid<T: Into<String>>(self, v: T) -> Self

Sets the value of uid.

Example

let x = BranchRule::new().set_uid("example");

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = BranchRule::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = BranchRule::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = BranchRule::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = BranchRule::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = BranchRule::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = BranchRule::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_annotations<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of annotations.

Example

let x = BranchRule::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

Example

let x = BranchRule::new().set_etag("example");

pub fn set_include_pattern<T: Into<String>>(self, v: T) -> Self

Sets the value of include_pattern.

Example

let x = BranchRule::new().set_include_pattern("example");

pub fn set_disabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of disabled.

Example

let x = BranchRule::new().set_disabled(true);

pub fn set_require_pull_request<T: Into<bool>>(self, v: T) -> Self

Sets the value of require_pull_request.

Example

let x = BranchRule::new().set_require_pull_request(true);

pub fn set_minimum_reviews_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of minimum_reviews_count.

Example

let x = BranchRule::new().set_minimum_reviews_count(42);

pub fn set_minimum_approvals_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of minimum_approvals_count.

Example

let x = BranchRule::new().set_minimum_approvals_count(42);

pub fn set_require_code_owner_approval<T: Into<bool>>(self, v: T) -> Self

Sets the value of require_code_owner_approval.

Example

let x = BranchRule::new().set_require_code_owner_approval(true);

pub fn set_require_comments_resolved<T: Into<bool>>(self, v: T) -> Self

Sets the value of require_comments_resolved.

Example

let x = BranchRule::new().set_require_comments_resolved(true);

pub fn set_allow_stale_reviews<T: Into<bool>>(self, v: T) -> Self

Sets the value of allow_stale_reviews.

Example

let x = BranchRule::new().set_allow_stale_reviews(true);

pub fn set_require_linear_history<T: Into<bool>>(self, v: T) -> Self

Sets the value of require_linear_history.

Example

let x = BranchRule::new().set_require_linear_history(true);

pub fn set_required_status_checks<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Check>,

Sets the value of required_status_checks.

Example

use google_cloud_securesourcemanager_v1::model::branch_rule::Check;
let x = BranchRule::new()
    .set_required_status_checks([
        Check::default()/* use setters */,
        Check::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for BranchRule

fn clone(&self) -> BranchRule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BranchRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BranchRule

fn default() -> BranchRule

Returns the “default value” for a type.

impl Message for BranchRule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BranchRule

fn eq(&self, other: &BranchRule) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BranchRule