Represents a BranchRule.
Implements
Package
@google-cloud/securesourcemanagerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.securesourcemanager.v1.IBranchRule);Constructs a new BranchRule.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBranchRule
Properties to set |
Properties
allowStaleReviews
public allowStaleReviews: boolean;BranchRule allowStaleReviews.
annotations
public annotations: { [k: string]: string };BranchRule annotations.
createTime
public createTime?: (google.protobuf.ITimestamp|null);BranchRule createTime.
disabled
public disabled: boolean;BranchRule disabled.
etag
public etag: string;BranchRule etag.
includePattern
public includePattern: string;BranchRule includePattern.
minimumApprovalsCount
public minimumApprovalsCount: number;BranchRule minimumApprovalsCount.
minimumReviewsCount
public minimumReviewsCount: number;BranchRule minimumReviewsCount.
name
public name: string;BranchRule name.
requireCodeOwnerApproval
public requireCodeOwnerApproval: boolean;BranchRule requireCodeOwnerApproval.
requireCommentsResolved
public requireCommentsResolved: boolean;BranchRule requireCommentsResolved.
requiredStatusChecks
public requiredStatusChecks: google.cloud.securesourcemanager.v1.BranchRule.ICheck[];BranchRule requiredStatusChecks.
requireLinearHistory
public requireLinearHistory: boolean;BranchRule requireLinearHistory.
requirePullRequest
public requirePullRequest: boolean;BranchRule requirePullRequest.
uid
public uid: string;BranchRule uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);BranchRule updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.securesourcemanager.v1.IBranchRule): google.cloud.securesourcemanager.v1.BranchRule;Creates a new BranchRule instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBranchRule
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BranchRule |
BranchRule instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.securesourcemanager.v1.BranchRule;Decodes a BranchRule message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BranchRule |
BranchRule |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.securesourcemanager.v1.BranchRule;Decodes a BranchRule message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BranchRule |
BranchRule |
encode(message, writer)
public static encode(message: google.cloud.securesourcemanager.v1.IBranchRule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BranchRule message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBranchRule
BranchRule message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.securesourcemanager.v1.IBranchRule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BranchRule message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBranchRule
BranchRule message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.securesourcemanager.v1.BranchRule;Creates a BranchRule message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
BranchRule |
BranchRule |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BranchRule
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this BranchRule to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.securesourcemanager.v1.BranchRule, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BranchRule message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BranchRule
BranchRule |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a BranchRule message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|