Google Cloud Life Sciences V2beta Client - Class Metadata (0.4.0)

Reference documentation and code samples for the Google Cloud Life Sciences V2beta Client class Metadata.

Carries information about the pipeline execution that is returned in the long running operation's metadata field.

Generated from protobuf message google.cloud.lifesciences.v2beta.Metadata

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ pipeline Google\Cloud\LifeSciences\V2beta\Pipeline

The pipeline this operation represents.

↳ labels array|Google\Protobuf\Internal\MapField

The user-defined labels associated with this operation.

↳ events array<Google\Cloud\LifeSciences\V2beta\Event>

The list of events that have happened so far during the execution of this operation.

↳ create_time Google\Protobuf\Timestamp

The time at which the operation was created by the API.

↳ start_time Google\Protobuf\Timestamp

The first time at which resources were allocated to execute the pipeline.

↳ end_time Google\Protobuf\Timestamp

The time at which execution was completed and resources were cleaned up.

↳ pub_sub_topic string

The name of the Cloud Pub/Sub topic where notifications of operation status changes are sent.

getPipeline

The pipeline this operation represents.

Returns
TypeDescription
Google\Cloud\LifeSciences\V2beta\Pipeline|null

hasPipeline

clearPipeline

setPipeline

The pipeline this operation represents.

Parameter
NameDescription
var Google\Cloud\LifeSciences\V2beta\Pipeline
Returns
TypeDescription
$this

getLabels

The user-defined labels associated with this operation.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

The user-defined labels associated with this operation.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getEvents

The list of events that have happened so far during the execution of this operation.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEvents

The list of events that have happened so far during the execution of this operation.

Parameter
NameDescription
var array<Google\Cloud\LifeSciences\V2beta\Event>
Returns
TypeDescription
$this

getCreateTime

The time at which the operation was created by the API.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time at which the operation was created by the API.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getStartTime

The first time at which resources were allocated to execute the pipeline.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The first time at which resources were allocated to execute the pipeline.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

The time at which execution was completed and resources were cleaned up.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The time at which execution was completed and resources were cleaned up.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getPubSubTopic

The name of the Cloud Pub/Sub topic where notifications of operation status changes are sent.

Returns
TypeDescription
string

setPubSubTopic

The name of the Cloud Pub/Sub topic where notifications of operation status changes are sent.

Parameter
NameDescription
var string
Returns
TypeDescription
$this