Class Annotation.Builder (3.54.0)

public static final class Annotation.Builder extends GeneratedMessageV3.Builder<Annotation.Builder> implements AnnotationOrBuilder

Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.

Protobuf type google.cloud.aiplatform.v1beta1.Annotation

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Annotation.Builder

Implements

AnnotationOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Annotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Annotation build()

Returns
Type	Description
`Annotation`

buildPartial()

public Annotation buildPartial()

Returns
Type	Description
`Annotation`

clear()

public Annotation.Builder clear()

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAnnotationSource()

public Annotation.Builder clearAnnotationSource()

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Annotation.Builder`

clearCreateTime()

public Annotation.Builder clearCreateTime()

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Annotation.Builder`

clearEtag()

public Annotation.Builder clearEtag()

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Annotation.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public Annotation.Builder clearLabels()

Returns
Type	Description
`Annotation.Builder`

clearName()

public Annotation.Builder clearName()

Output only. Resource name of the Annotation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Annotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPayload()

public Annotation.Builder clearPayload()

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Annotation.Builder`

clearPayloadSchemaUri()

public Annotation.Builder clearPayloadSchemaUri()

Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata.

string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

clearUpdateTime()

public Annotation.Builder clearUpdateTime()

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Annotation.Builder`

clone()

public Annotation.Builder clone()

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public boolean containsLabels(String key)

Optional. The labels with user-defined metadata to organize your Annotations.

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 Annotation(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. Following system labels exist for each Annotation:

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAnnotationSource()

public UserActionReference getAnnotationSource()

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`UserActionReference`	The annotationSource.

getAnnotationSourceBuilder()

public UserActionReference.Builder getAnnotationSourceBuilder()

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`UserActionReference.Builder`

getAnnotationSourceOrBuilder()

public UserActionReferenceOrBuilder getAnnotationSourceOrBuilder()

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`UserActionReferenceOrBuilder`

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Builder`

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDefaultInstanceForType()

public Annotation getDefaultInstanceForType()

Returns
Type	Description
`Annotation`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEtag()

public String getEtag()

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

Optional. The labels with user-defined metadata to organize your Annotations.

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. The labels with user-defined metadata to organize your Annotations.

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels with user-defined metadata to organize your Annotations.

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. The labels with user-defined metadata to organize your Annotations.

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

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>`

getName()

public String getName()

Output only. Resource name of the Annotation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the Annotation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for name.

getPayload()

public Value getPayload()

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Value`	The payload.

getPayloadBuilder()

public Value.Builder getPayloadBuilder()

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Builder`

getPayloadOrBuilder()

public ValueOrBuilder getPayloadOrBuilder()

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ValueOrBuilder`

getPayloadSchemaUri()

public String getPayloadSchemaUri()

string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The payloadSchemaUri.

getPayloadSchemaUriBytes()

public ByteString getPayloadSchemaUriBytes()

string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for payloadSchemaUri.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Builder`

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

hasAnnotationSource()

public boolean hasAnnotationSource()

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the annotationSource field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasPayload()

public boolean hasPayload()

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the payload field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

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

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAnnotationSource(UserActionReference value)

public Annotation.Builder mergeAnnotationSource(UserActionReference value)

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`UserActionReference`

Returns
Type	Description
`Annotation.Builder`

mergeCreateTime(Timestamp value)

public Annotation.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Annotation.Builder`

mergeFrom(Annotation other)

public Annotation.Builder mergeFrom(Annotation other)

Parameter
Name	Description
`other`	`Annotation`

Returns
Type	Description
`Annotation.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Annotation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Annotation.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Annotation.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Annotation.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergePayload(Value value)

public Annotation.Builder mergePayload(Value value)

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Value`

Returns
Type	Description
`Annotation.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Annotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Annotation.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Annotation.Builder`

putAllLabels(Map<String,String> values)

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

Optional. The labels with user-defined metadata to organize your Annotations.

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`Annotation.Builder`

putLabels(String key, String value)

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

Optional. The labels with user-defined metadata to organize your Annotations.

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`Annotation.Builder`

removeLabels(String key)

public Annotation.Builder removeLabels(String key)

Optional. The labels with user-defined metadata to organize your Annotations.

"aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
"aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Annotation.Builder`

setAnnotationSource(UserActionReference value)

public Annotation.Builder setAnnotationSource(UserActionReference value)

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`UserActionReference`

Returns
Type	Description
`Annotation.Builder`

setAnnotationSource(UserActionReference.Builder builderForValue)

public Annotation.Builder setAnnotationSource(UserActionReference.Builder builderForValue)

Output only. The source of the Annotation.

.google.cloud.aiplatform.v1beta1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`UserActionReference.Builder`

Returns
Type	Description
`Annotation.Builder`

setCreateTime(Timestamp value)

public Annotation.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Annotation.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public Annotation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Annotation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Annotation.Builder`

setEtag(String value)

public Annotation.Builder setEtag(String value)

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The etag to set.

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

setEtagBytes(ByteString value)

public Annotation.Builder setEtagBytes(ByteString value)

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for etag to set.

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Annotation.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Annotation.Builder setName(String value)

Output only. Resource name of the Annotation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Annotation.Builder setNameBytes(ByteString value)

Output only. Resource name of the Annotation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

setPayload(Value value)

public Annotation.Builder setPayload(Value value)

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Value`

Returns
Type	Description
`Annotation.Builder`

setPayload(Value.Builder builderForValue)

public Annotation.Builder setPayload(Value.Builder builderForValue)

Required. The schema of the payload can be found in payload_schema.

.google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Annotation.Builder`

setPayloadSchemaUri(String value)

public Annotation.Builder setPayloadSchemaUri(String value)

string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The payloadSchemaUri to set.

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

setPayloadSchemaUriBytes(ByteString value)

public Annotation.Builder setPayloadSchemaUriBytes(ByteString value)

string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for payloadSchemaUri to set.

Returns
Type	Description
`Annotation.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Annotation.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Annotation.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Annotation.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Annotation.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public Annotation.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Annotation was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Annotation.Builder`