Class protos.google.devtools.cloudbuild.v1.GitHubEventsConfig (2.4.0)

Represents a GitHubEventsConfig.

Package

@google-cloud/cloudbuild!

Constructors

(constructor)(properties)

constructor(properties?: google.devtools.cloudbuild.v1.IGitHubEventsConfig);

Constructs a new GitHubEventsConfig.

Parameter

Name	Description
properties	`IGitHubEventsConfig` Properties to set

Properties

event

public event?: ("pullRequest"|"push");

GitHubEventsConfig event.

Property Value

Type	Description
("pullRequest"\|"push")

installationId

public installationId: (number|Long|string);

GitHubEventsConfig installationId.

Property Value

Type	Description
(number\|Long\|string)

name

public name: string;

GitHubEventsConfig name.

Property Value

Type	Description
string

owner

public owner: string;

GitHubEventsConfig owner.

Property Value

Type	Description
string

pullRequest

public pullRequest?: (google.devtools.cloudbuild.v1.IPullRequestFilter|null);

GitHubEventsConfig pullRequest.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.IPullRequestFilter\|null)

push

public push?: (google.devtools.cloudbuild.v1.IPushFilter|null);

GitHubEventsConfig push.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.IPushFilter\|null)

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IGitHubEventsConfig): google.devtools.cloudbuild.v1.GitHubEventsConfig;

Creates a new GitHubEventsConfig instance using the specified properties.

Parameter

Name	Description
properties	`IGitHubEventsConfig` Properties to set

Returns

Type	Description
google.devtools.cloudbuild.v1.GitHubEventsConfig	GitHubEventsConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.devtools.cloudbuild.v1.GitHubEventsConfig;

Decodes a GitHubEventsConfig message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.devtools.cloudbuild.v1.GitHubEventsConfig	GitHubEventsConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devtools.cloudbuild.v1.GitHubEventsConfig;

Decodes a GitHubEventsConfig message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.devtools.cloudbuild.v1.GitHubEventsConfig	GitHubEventsConfig

encode(message, writer)

public static encode(message: google.devtools.cloudbuild.v1.IGitHubEventsConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GitHubEventsConfig message. Does not implicitly messages.

Parameters

Name	Description
message	`IGitHubEventsConfig` GitHubEventsConfig 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.devtools.cloudbuild.v1.IGitHubEventsConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GitHubEventsConfig message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IGitHubEventsConfig` GitHubEventsConfig 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.devtools.cloudbuild.v1.GitHubEventsConfig;

Creates a GitHubEventsConfig 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
google.devtools.cloudbuild.v1.GitHubEventsConfig	GitHubEventsConfig

toJSON()

public toJSON(): { [k: string]: any };

Converts this GitHubEventsConfig to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.devtools.cloudbuild.v1.GitHubEventsConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a GitHubEventsConfig message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.devtools.cloudbuild.v1.GitHubEventsConfig` GitHubEventsConfig
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 GitHubEventsConfig message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not