Class protos.google.cloud.deploy.v1.AutomationEvent (3.6.0)

Represents an AutomationEvent.

Package

@google-cloud/deploy

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.deploy.v1.IAutomationEvent);

Constructs a new AutomationEvent.

Parameter
Name Description
properties IAutomationEvent

Properties to set

Properties

automation

public automation: string;

AutomationEvent automation.

message

public message: string;

AutomationEvent message.

pipelineUid

public pipelineUid: string;

AutomationEvent pipelineUid.

type

public type: (google.cloud.deploy.v1.Type|keyof typeof google.cloud.deploy.v1.Type);

AutomationEvent type.

Methods

create(properties)

public static create(properties?: google.cloud.deploy.v1.IAutomationEvent): google.cloud.deploy.v1.AutomationEvent;

Creates a new AutomationEvent instance using the specified properties.

Parameter
Name Description
properties IAutomationEvent

Properties to set

Returns
Type Description
AutomationEvent

AutomationEvent instance

decode(reader, length)

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

Decodes an AutomationEvent 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
AutomationEvent

AutomationEvent

decodeDelimited(reader)

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

Decodes an AutomationEvent message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AutomationEvent

AutomationEvent

encode(message, writer)

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

Encodes the specified AutomationEvent message. Does not implicitly messages.

Parameters
Name Description
message IAutomationEvent

AutomationEvent 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.deploy.v1.IAutomationEvent, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAutomationEvent

AutomationEvent 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.deploy.v1.AutomationEvent;

Creates an AutomationEvent 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
AutomationEvent

AutomationEvent

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AutomationEvent

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AutomationEvent

AutomationEvent

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 an AutomationEvent 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