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

Represents a WebhookConfig.

Package

@google-cloud/cloudbuild!

Constructors

(constructor)(properties)

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

Constructs a new WebhookConfig.

Parameter

Name	Description
properties	`IWebhookConfig` Properties to set

Properties

authMethod

public authMethod?: "secret";

WebhookConfig authMethod.

Property Value

Type	Description
"secret"

secret

public secret?: (string|null);

WebhookConfig secret.

Property Value

Type	Description
(string\|null)

state

public state: (google.devtools.cloudbuild.v1.WebhookConfig.State|keyof typeof google.devtools.cloudbuild.v1.WebhookConfig.State);

WebhookConfig state.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.WebhookConfig.State\|keyof typeof google.devtools.cloudbuild.v1.WebhookConfig.State)

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IWebhookConfig): google.devtools.cloudbuild.v1.WebhookConfig;

Creates a new WebhookConfig instance using the specified properties.

Parameter

Name	Description
properties	`IWebhookConfig` Properties to set

Returns

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

decode(reader, length)

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

Decodes a WebhookConfig 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.WebhookConfig	WebhookConfig

decodeDelimited(reader)

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

Decodes a WebhookConfig 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.WebhookConfig	WebhookConfig

encode(message, writer)

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

Encodes the specified WebhookConfig message. Does not implicitly messages.

Parameters

Name	Description
message	`IWebhookConfig` WebhookConfig 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.IWebhookConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IWebhookConfig` WebhookConfig 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.WebhookConfig;

Creates a WebhookConfig 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.WebhookConfig	WebhookConfig

toJSON()

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

Converts this WebhookConfig to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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