Class protos.google.cloud.eventarc.v1.Trigger (4.0.1)

Represents a Trigger.

Package

@google-cloud/eventarc

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.eventarc.v1.ITrigger);

Constructs a new Trigger.

Parameter
Name Description
properties ITrigger

Properties to set

Properties

channel

public channel: string;

Trigger channel.

conditions

public conditions: { [k: string]: google.cloud.eventarc.v1.IStateCondition };

Trigger conditions.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Trigger createTime.

destination

public destination?: (google.cloud.eventarc.v1.IDestination|null);

Trigger destination.

etag

public etag: string;

Trigger etag.

eventDataContentType

public eventDataContentType: string;

Trigger eventDataContentType.

eventFilters

public eventFilters: google.cloud.eventarc.v1.IEventFilter[];

Trigger eventFilters.

labels

public labels: { [k: string]: string };

Trigger labels.

name

public name: string;

Trigger name.

satisfiesPzs

public satisfiesPzs: boolean;

Trigger satisfiesPzs.

serviceAccount

public serviceAccount: string;

Trigger serviceAccount.

transport

public transport?: (google.cloud.eventarc.v1.ITransport|null);

Trigger transport.

uid

public uid: string;

Trigger uid.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Trigger updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.eventarc.v1.ITrigger): google.cloud.eventarc.v1.Trigger;

Creates a new Trigger instance using the specified properties.

Parameter
Name Description
properties ITrigger

Properties to set

Returns
Type Description
Trigger

Trigger instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.eventarc.v1.Trigger;

Decodes a Trigger 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
Trigger

Trigger

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.eventarc.v1.Trigger;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Trigger

Trigger

encode(message, writer)

public static encode(message: google.cloud.eventarc.v1.ITrigger, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Trigger message. Does not implicitly messages.

Parameters
Name Description
message ITrigger

Trigger 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.eventarc.v1.ITrigger, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITrigger

Trigger 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.eventarc.v1.Trigger;

Creates a Trigger 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
Trigger

Trigger

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Trigger

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 Trigger to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Trigger

Trigger

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 Trigger 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