Class Event.Builder (3.56.0)

public static final class Event.Builder extends GeneratedMessageV3.Builder<Event.Builder> implements EventOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.Event

Implements

EventOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Event.Builder
Overrides

build()

public Event build()
Returns
Type Description
Event

buildPartial()

public Event buildPartial()
Returns
Type Description
Event

clear()

public Event.Builder clear()
Returns
Type Description
Event.Builder
Overrides

clearArtifact()

public Event.Builder clearArtifact()

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

string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Event.Builder

This builder for chaining.

clearEventTime()

public Event.Builder clearEventTime()

Output only. Time the Event occurred.

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

Returns
Type Description
Event.Builder

clearExecution()

public Event.Builder clearExecution()

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

string execution = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Event.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Event.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Event.Builder
Overrides

clearLabels()

public Event.Builder clearLabels()
Returns
Type Description
Event.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Event.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Event.Builder
Overrides

clearType()

public Event.Builder clearType()

Required. The type of the Event.

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

Returns
Type Description
Event.Builder

This builder for chaining.

clone()

public Event.Builder clone()
Returns
Type Description
Event.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

getArtifact()

public String getArtifact()

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

string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The artifact.

getArtifactBytes()

public ByteString getArtifactBytes()

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

string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for artifact.

getDefaultInstanceForType()

public Event getDefaultInstanceForType()
Returns
Type Description
Event

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEventTime()

public Timestamp getEventTime()

Output only. Time the Event occurred.

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

Returns
Type Description
Timestamp

The eventTime.

getEventTimeBuilder()

public Timestamp.Builder getEventTimeBuilder()

Output only. Time the Event occurred.

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

Returns
Type Description
Builder

getEventTimeOrBuilder()

public TimestampOrBuilder getEventTimeOrBuilder()

Output only. Time the Event occurred.

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

Returns
Type Description
TimestampOrBuilder

getExecution()

public String getExecution()

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

string execution = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The execution.

getExecutionBytes()

public ByteString getExecutionBytes()

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

string execution = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for execution.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 5;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 5;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getType()

public Event.Type getType()

Required. The type of the Event.

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

Returns
Type Description
Event.Type

The type.

getTypeValue()

public int getTypeValue()

Required. The type of the Event.

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

Returns
Type Description
int

The enum numeric value on the wire for type.

hasEventTime()

public boolean hasEventTime()

Output only. Time the Event occurred.

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

Returns
Type Description
boolean

Whether the eventTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEventTime(Timestamp value)

public Event.Builder mergeEventTime(Timestamp value)

Output only. Time the Event occurred.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Event.Builder

mergeFrom(Event other)

public Event.Builder mergeFrom(Event other)
Parameter
Name Description
other Event
Returns
Type Description
Event.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Event.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Event.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Event.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Event.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Event.Builder
Overrides

putAllLabels(Map<String,String> values)

public Event.Builder putAllLabels(Map<String,String> values)

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.

map<string, string> labels = 5;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Event.Builder

putLabels(String key, String value)

public Event.Builder putLabels(String key, String value)

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.

map<string, string> labels = 5;

Parameters
Name Description
key String
value String
Returns
Type Description
Event.Builder

removeLabels(String key)

public Event.Builder removeLabels(String key)

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.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
Event.Builder

setArtifact(String value)

public Event.Builder setArtifact(String value)

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

string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The artifact to set.

Returns
Type Description
Event.Builder

This builder for chaining.

setArtifactBytes(ByteString value)

public Event.Builder setArtifactBytes(ByteString value)

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

string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for artifact to set.

Returns
Type Description
Event.Builder

This builder for chaining.

setEventTime(Timestamp value)

public Event.Builder setEventTime(Timestamp value)

Output only. Time the Event occurred.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Event.Builder

setEventTime(Timestamp.Builder builderForValue)

public Event.Builder setEventTime(Timestamp.Builder builderForValue)

Output only. Time the Event occurred.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Event.Builder

setExecution(String value)

public Event.Builder setExecution(String value)

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

string execution = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The execution to set.

Returns
Type Description
Event.Builder

This builder for chaining.

setExecutionBytes(ByteString value)

public Event.Builder setExecutionBytes(ByteString value)

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

string execution = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for execution to set.

Returns
Type Description
Event.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Event.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Event.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Event.Builder
Overrides

setType(Event.Type value)

public Event.Builder setType(Event.Type value)

Required. The type of the Event.

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

Parameter
Name Description
value Event.Type

The type to set.

Returns
Type Description
Event.Builder

This builder for chaining.

setTypeValue(int value)

public Event.Builder setTypeValue(int value)

Required. The type of the Event.

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
Event.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Event.Builder
Overrides