Class protos.google.cloud.lifesciences.v2beta.Event (1.0.3)

Represents an Event.

Package

@google-cloud/life-sciences!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.lifesciences.v2beta.IEvent);

Constructs a new Event.

Parameter

Name	Description
properties	`IEvent` Properties to set

Properties

containerKilled

public containerKilled?: (google.cloud.lifesciences.v2beta.IContainerKilledEvent|null);

Event containerKilled.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IContainerKilledEvent\|null)

containerStarted

public containerStarted?: (google.cloud.lifesciences.v2beta.IContainerStartedEvent|null);

Event containerStarted.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IContainerStartedEvent\|null)

containerStopped

public containerStopped?: (google.cloud.lifesciences.v2beta.IContainerStoppedEvent|null);

Event containerStopped.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IContainerStoppedEvent\|null)

delayed

public delayed?: (google.cloud.lifesciences.v2beta.IDelayedEvent|null);

Event delayed.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IDelayedEvent\|null)

description

public description: string;

Event description.

Property Value

Type	Description
string

details

public details?: ("delayed"|"workerAssigned"|"workerReleased"|"pullStarted"|"pullStopped"|"containerStarted"|"containerStopped"|"containerKilled"|"unexpectedExitStatus"|"failed");

Event details.

Property Value

Type	Description
("delayed"\|"workerAssigned"\|"workerReleased"\|"pullStarted"\|"pullStopped"\|"containerStarted"\|"containerStopped"\|"containerKilled"\|"unexpectedExitStatus"\|"failed")

failed

public failed?: (google.cloud.lifesciences.v2beta.IFailedEvent|null);

Event failed.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IFailedEvent\|null)

pullStarted

public pullStarted?: (google.cloud.lifesciences.v2beta.IPullStartedEvent|null);

Event pullStarted.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IPullStartedEvent\|null)

pullStopped

public pullStopped?: (google.cloud.lifesciences.v2beta.IPullStoppedEvent|null);

Event pullStopped.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IPullStoppedEvent\|null)

timestamp

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

Event timestamp.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

unexpectedExitStatus

public unexpectedExitStatus?: (google.cloud.lifesciences.v2beta.IUnexpectedExitStatusEvent|null);

Event unexpectedExitStatus.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IUnexpectedExitStatusEvent\|null)

workerAssigned

public workerAssigned?: (google.cloud.lifesciences.v2beta.IWorkerAssignedEvent|null);

Event workerAssigned.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IWorkerAssignedEvent\|null)

workerReleased

public workerReleased?: (google.cloud.lifesciences.v2beta.IWorkerReleasedEvent|null);

Event workerReleased.

Property Value

Type	Description
(google.cloud.lifesciences.v2beta.IWorkerReleasedEvent\|null)

Methods

create(properties)

public static create(properties?: google.cloud.lifesciences.v2beta.IEvent): google.cloud.lifesciences.v2beta.Event;

Creates a new Event instance using the specified properties.

Parameter

Name	Description
properties	`IEvent` Properties to set

Returns

Type	Description
google.cloud.lifesciences.v2beta.Event	Event instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.lifesciences.v2beta.Event;

Decodes an Event 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.cloud.lifesciences.v2beta.Event	Event

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.lifesciences.v2beta.Event;

Decodes an Event 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.cloud.lifesciences.v2beta.Event	Event

encode(message, writer)

public static encode(message: google.cloud.lifesciences.v2beta.IEvent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Event message. Does not implicitly messages.

Parameters

Name	Description
message	`IEvent` Event 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.lifesciences.v2beta.IEvent, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IEvent` Event 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.lifesciences.v2beta.Event;

Creates an Event 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.cloud.lifesciences.v2beta.Event	Event

toJSON()

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

Converts this Event to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.lifesciences.v2beta.Event` Event
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 Event 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