Class Annotation.Builder (3.8.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

Implements

AnnotationOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Annotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Annotation.Builder
Overrides

build()

public Annotation build()
Returns
TypeDescription
Annotation

buildPartial()

public Annotation buildPartial()
Returns
TypeDescription
Annotation

clear()

public Annotation.Builder clear()
Returns
TypeDescription
Annotation.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
Annotation.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Annotation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Annotation.Builder
Overrides

clearLabels()

public Annotation.Builder clearLabels()
Returns
TypeDescription
Annotation.Builder

clearName()

public Annotation.Builder clearName()

Output only. Resource name of the Annotation.

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

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Annotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Annotation.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
Annotation.Builder

clone()

public Annotation.Builder clone()
Returns
TypeDescription
Annotation.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Annotation getDefaultInstanceForType()
Returns
TypeDescription
Annotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for etag.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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];

Returns
TypeDescription
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. 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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(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
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Output only. Resource name of the Annotation.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the Annotation.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ValueOrBuilder

getPayloadSchemaUri()

public String getPayloadSchemaUri()

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
TypeDescription
String

The payloadSchemaUri.

getPayloadSchemaUriBytes()

public ByteString getPayloadSchemaUriBytes()

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueUserActionReference
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
Annotation.Builder

mergeFrom(Annotation other)

public Annotation.Builder mergeFrom(Annotation other)
Parameter
NameDescription
otherAnnotation
Returns
TypeDescription
Annotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Annotation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Annotation.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Annotation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Annotation.Builder
Overrides

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
NameDescription
valueValue
Returns
TypeDescription
Annotation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Annotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Annotation.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
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. 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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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. 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];

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Annotation.Builder

removeLabels(String key)

public Annotation.Builder removeLabels(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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueUserActionReference
Returns
TypeDescription
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
NameDescription
builderForValueUserActionReference.Builder
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueString

The etag to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Annotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Annotation.Builder
Overrides

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueValue
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Annotation.Builder

setPayloadSchemaUri(String value)

public Annotation.Builder setPayloadSchemaUri(String value)

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];

Parameter
NameDescription
valueString

The payloadSchemaUri to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

setPayloadSchemaUriBytes(ByteString value)

public Annotation.Builder setPayloadSchemaUriBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for payloadSchemaUri to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Annotation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Annotation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Annotation.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Annotation.Builder