com.google.cloud.securesourcemanager.v1

Interface BranchRuleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

BranchRule, BranchRule.Builder

public interface BranchRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAnnotations(String key) Optional.
boolean	getAllowStaleReviews() Optional.
Map<String,String>	getAnnotations() Deprecated.
int	getAnnotationsCount() Optional.
Map<String,String>	getAnnotationsMap() Optional.
String	getAnnotationsOrDefault(String key, String defaultValue) Optional.
String	getAnnotationsOrThrow(String key) Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
boolean	getDisabled() Optional.
String	getEtag() Optional.
com.google.protobuf.ByteString	getEtagBytes() Optional.
String	getIncludePattern() Optional.
com.google.protobuf.ByteString	getIncludePatternBytes() Optional.
int	getMinimumApprovalsCount() Optional.
int	getMinimumReviewsCount() Optional.
String	getName() Optional.
com.google.protobuf.ByteString	getNameBytes() Optional.
boolean	getRequireCommentsResolved() Optional.
BranchRule.Check	getRequiredStatusChecks(int index) Optional.
int	getRequiredStatusChecksCount() Optional.
List<BranchRule.Check>	getRequiredStatusChecksList() Optional.
BranchRule.CheckOrBuilder	getRequiredStatusChecksOrBuilder(int index) Optional.
List<? extends BranchRule.CheckOrBuilder>	getRequiredStatusChecksOrBuilderList() Optional.
boolean	getRequireLinearHistory() Optional.
boolean	getRequirePullRequest() Optional.
String	getUid() Output only.
com.google.protobuf.ByteString	getUidBytes() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getUid

String getUid()

 Output only. Unique identifier of the repository.
 

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

Returns:

The uid.

getUidBytes

com.google.protobuf.ByteString getUidBytes()

 Output only. Unique identifier of the repository.
 

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

Returns:

The bytes for uid.

hasCreateTime

boolean hasCreateTime()

 Output only. Create timestamp.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Create timestamp.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Create timestamp.
 

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

hasUpdateTime

boolean hasUpdateTime()

 Output only. Update timestamp.
 

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

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Update timestamp.
 

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Update timestamp.
 

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

getAnnotationsCount

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];

containsAnnotations

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];

getAnnotations

@Deprecated
Map<String,String> getAnnotations()

Deprecated.

Use getAnnotationsMap() instead.

getAnnotationsMap

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];

getAnnotationsOrDefault

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];

getAnnotationsOrThrow

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];

getEtag

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:

The etag.

getEtagBytes

com.google.protobuf.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:

The bytes for etag.

getIncludePattern

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:

The includePattern.

getIncludePatternBytes

com.google.protobuf.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:

The bytes for includePattern.

getDisabled

boolean getDisabled()

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

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

Returns:

The disabled.

getRequirePullRequest

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:

The requirePullRequest.

getMinimumReviewsCount

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:

The minimumReviewsCount.

getMinimumApprovalsCount

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:

The minimumApprovalsCount.

getRequireCommentsResolved

boolean getRequireCommentsResolved()

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

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

Returns:

The requireCommentsResolved.

getAllowStaleReviews

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:

The allowStaleReviews.

getRequireLinearHistory

boolean getRequireLinearHistory()

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

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

Returns:

The requireLinearHistory.

getRequiredStatusChecksList

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];

getRequiredStatusChecks

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];

getRequiredStatusChecksCount

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];

getRequiredStatusChecksOrBuilderList

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];

getRequiredStatusChecksOrBuilder

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];