Interface BranchRuleOrBuilder (0.24.0)

Version 0.24.0

• 0.25.0 (latest)
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface BranchRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAllowStaleReviews()

public abstract boolean getAllowStaleReviews()

Optional. Determines if allow stale reviews or approvals before merging to the branch.

bool allow_stale_reviews = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The allowStaleReviews.

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Create timestamp.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create timestamp.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDisabled()

public abstract boolean getDisabled()

Optional. Determines if the branch rule is disabled or not.

bool disabled = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The disabled.

getEtag()

public abstract String getEtag()

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.

string etag = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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.

string etag = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for etag.

getIncludePattern()

public abstract String getIncludePattern()

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.

string include_pattern = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The includePattern.

getIncludePatternBytes()

public abstract ByteString getIncludePatternBytes()

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.

string include_pattern = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for includePattern.

getMinimumApprovalsCount()

public abstract int getMinimumApprovalsCount()

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

int32 minimum_approvals_count = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The minimumApprovalsCount.

getMinimumReviewsCount()

public abstract int getMinimumReviewsCount()

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

int32 minimum_reviews_count = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The minimumReviewsCount.

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for name.

getRequireCommentsResolved()

public abstract boolean getRequireCommentsResolved()

Optional. Determines if require comments resolved before merging to the branch.

bool require_comments_resolved = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The requireCommentsResolved.

getRequireLinearHistory()

public abstract boolean getRequireLinearHistory()

Optional. Determines if require linear history before merging to the branch.

bool require_linear_history = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The requireLinearHistory.

getRequirePullRequest()

public abstract boolean getRequirePullRequest()

Optional. Determines if the branch rule requires a pull request or not.

bool require_pull_request = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The requirePullRequest.

getRequiredStatusChecks(int index)

public abstract BranchRule.Check getRequiredStatusChecks(int index)

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

repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
BranchRule.Check

getRequiredStatusChecksCount()

public abstract int getRequiredStatusChecksCount()

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

repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getRequiredStatusChecksList()

public abstract List<BranchRule.Check> getRequiredStatusChecksList()

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

repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Check>

getRequiredStatusChecksOrBuilder(int index)

public abstract BranchRule.CheckOrBuilder getRequiredStatusChecksOrBuilder(int index)

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

repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
BranchRule.CheckOrBuilder

getRequiredStatusChecksOrBuilderList()

public abstract List<? extends BranchRule.CheckOrBuilder> getRequiredStatusChecksOrBuilderList()

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

repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.securesourcemanager.v1.BranchRule.CheckOrBuilder>

getUid()

public abstract String getUid()

Output only. Unique identifier of the repository.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Unique identifier of the repository.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Update timestamp.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update timestamp.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Create timestamp.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Update timestamp.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.