Secure Source Manager V1 API - Class Google::Cloud::SecureSourceManager::V1::BranchRule (v1.1.0)

Reference documentation and code samples for the Secure Source Manager V1 API class Google::Cloud::SecureSourceManager::V1::BranchRule.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_stale_reviews

def allow_stale_reviews() -> ::Boolean
Returns
  • (::Boolean) — Optional. Determines if allow stale reviews or approvals before merging to the branch.

#allow_stale_reviews=

def allow_stale_reviews=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Determines if allow stale reviews or approvals before merging to the branch.
Returns
  • (::Boolean) — Optional. Determines if allow stale reviews or approvals before merging to the branch.

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::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.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::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.
Returns
  • (::Google::Protobuf::Map{::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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#disabled

def disabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. Determines if the branch rule is disabled or not.

#disabled=

def disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Determines if the branch rule is disabled or not.
Returns
  • (::Boolean) — Optional. Determines if the branch rule is disabled or not.

#etag

def etag() -> ::String
Returns
  • (::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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def include_pattern() -> ::String
Returns
  • (::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.

#include_pattern=

def include_pattern=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#minimum_approvals_count

def minimum_approvals_count() -> ::Integer
Returns
  • (::Integer) — Optional. The minimum number of approvals required for the branch rule to be matched.

#minimum_approvals_count=

def minimum_approvals_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The minimum number of approvals required for the branch rule to be matched.
Returns
  • (::Integer) — Optional. The minimum number of approvals required for the branch rule to be matched.

#minimum_reviews_count

def minimum_reviews_count() -> ::Integer
Returns
  • (::Integer) — Optional. The minimum number of reviews required for the branch rule to be matched.

#minimum_reviews_count=

def minimum_reviews_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The minimum number of reviews required for the branch rule to be matched.
Returns
  • (::Integer) — Optional. The minimum number of reviews required for the branch rule to be matched.

#name

def name() -> ::String
Returns
  • (::String) — Optional. A unique identifier for a BranchRule. The name should be of the format: projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Optional. A unique identifier for a BranchRule. The name should be of the format: projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}
Returns
  • (::String) — Optional. A unique identifier for a BranchRule. The name should be of the format: projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}

#require_comments_resolved

def require_comments_resolved() -> ::Boolean
Returns
  • (::Boolean) — Optional. Determines if require comments resolved before merging to the branch.

#require_comments_resolved=

def require_comments_resolved=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Determines if require comments resolved before merging to the branch.
Returns
  • (::Boolean) — Optional. Determines if require comments resolved before merging to the branch.

#require_linear_history

def require_linear_history() -> ::Boolean
Returns
  • (::Boolean) — Optional. Determines if require linear history before merging to the branch.

#require_linear_history=

def require_linear_history=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Determines if require linear history before merging to the branch.
Returns
  • (::Boolean) — Optional. Determines if require linear history before merging to the branch.

#require_pull_request

def require_pull_request() -> ::Boolean
Returns
  • (::Boolean) — Optional. Determines if the branch rule requires a pull request or not.

#require_pull_request=

def require_pull_request=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Determines if the branch rule requires a pull request or not.
Returns
  • (::Boolean) — Optional. Determines if the branch rule requires a pull request or not.

#required_status_checks

def required_status_checks() -> ::Array<::Google::Cloud::SecureSourceManager::V1::BranchRule::Check>
Returns

#required_status_checks=

def required_status_checks=(value) -> ::Array<::Google::Cloud::SecureSourceManager::V1::BranchRule::Check>
Parameter
Returns

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Unique identifier of the repository.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns