Google Cloud Ai Platform V1 Client - Class Event (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Event.

An edge describing the relationship between an Artifact and an Execution in a lineage graph.

Generated from protobuf message google.cloud.aiplatform.v1.Event

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ artifact string

Required. The relative resource name of the Artifact in the Event.

↳ execution string

Output only. The relative resource name of the Execution in the Event.

↳ event_time Google\Protobuf\Timestamp

Output only. Time the Event occurred.

↳ type int

Required. The type of the Event.

↳ labels array|Google\Protobuf\Internal\MapField

The labels with user-defined metadata to annotate Events. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Event (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

getArtifact

Required. The relative resource name of the Artifact in the Event.

Generated from protobuf field string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setArtifact

Required. The relative resource name of the Artifact in the Event.

Generated from protobuf field string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExecution

Output only. The relative resource name of the Execution in the Event.

Generated from protobuf field string execution = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setExecution

Output only. The relative resource name of the Execution in the Event.

Generated from protobuf field string execution = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEventTime

Output only. Time the Event occurred.

Generated from protobuf field .google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEventTime

clearEventTime

setEventTime

Output only. Time the Event occurred.

Generated from protobuf field .google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getType

Required. The type of the Event.

Generated from protobuf field .google.cloud.aiplatform.v1.Event.Type type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

setType

Required. The type of the Event.

Generated from protobuf field .google.cloud.aiplatform.v1.Event.Type type = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLabels

The labels with user-defined metadata to annotate Events.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Event (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Generated from protobuf field map<string, string> labels = 5;

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

The labels with user-defined metadata to annotate Events.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Event (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Generated from protobuf field map<string, string> labels = 5;

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