Package com.google.cloud.aiplatform.v1

Class Annotation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Annotation.Builder>
com.google.cloud.aiplatform.v1.Annotation.Builder
All Implemented Interfaces:
AnnotationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Annotation
public static final class Annotation.Builder extends com.google.protobuf.GeneratedMessage.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.v1.Annotation

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Annotation.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Annotation.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Annotation.Builder>

    • clear

      public Annotation.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Annotation.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Annotation.Builder>

    • getDefaultInstanceForType

      public Annotation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Annotation build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Annotation buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Annotation.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Annotation.Builder>

    • mergeFrom

      public Annotation.Builder mergeFrom(Annotation other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Annotation.Builder>

    • mergeFrom

      public Annotation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Annotation.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Output only. Resource name of the Annotation.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface AnnotationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of the Annotation.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface AnnotationOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Annotation.Builder setName(String value)
       Output only. Resource name of the Annotation.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Annotation.Builder clearName()
       Output only. Resource name of the Annotation.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Annotation.Builder setNameBytes(com.google.protobuf.ByteString value)
       Output only. Resource name of the Annotation.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getPayloadSchemaUri

      public String getPayloadSchemaUri()
       Required. Google Cloud Storage URI points to a YAML file describing
 [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
 defined as an [OpenAPI 3.0.2 Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].
      string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayloadSchemaUri in interface AnnotationOrBuilder
      Returns:
      The payloadSchemaUri.

    • getPayloadSchemaUriBytes

      public com.google.protobuf.ByteString getPayloadSchemaUriBytes()
       Required. Google Cloud Storage URI points to a YAML file describing
 [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
 defined as an [OpenAPI 3.0.2 Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].
      string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayloadSchemaUriBytes in interface AnnotationOrBuilder
      Returns:
      The bytes for payloadSchemaUri.

    • setPayloadSchemaUri

      public Annotation.Builder setPayloadSchemaUri(String value)
       Required. Google Cloud Storage URI points to a YAML file describing
 [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
 defined as an [OpenAPI 3.0.2 Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].
      string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The payloadSchemaUri to set.
      Returns:
      This builder for chaining.

    • clearPayloadSchemaUri

      public Annotation.Builder clearPayloadSchemaUri()
       Required. Google Cloud Storage URI points to a YAML file describing
 [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
 defined as an [OpenAPI 3.0.2 Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].
      string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setPayloadSchemaUriBytes

      public Annotation.Builder setPayloadSchemaUriBytes(com.google.protobuf.ByteString value)
       Required. Google Cloud Storage URI points to a YAML file describing
 [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
 defined as an [OpenAPI 3.0.2 Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].
      string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for payloadSchemaUri to set.
      Returns:
      This builder for chaining.

    • hasPayload

      public boolean hasPayload()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasPayload in interface AnnotationOrBuilder
      Returns:
      Whether the payload field is set.

    • getPayload

      public com.google.protobuf.Value getPayload()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayload in interface AnnotationOrBuilder
      Returns:
      The payload.

    • setPayload

      public Annotation.Builder setPayload(com.google.protobuf.Value value)
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

    • setPayload

      public Annotation.Builder setPayload(com.google.protobuf.Value.Builder builderForValue)
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

    • mergePayload

      public Annotation.Builder mergePayload(com.google.protobuf.Value value)
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

    • clearPayload

      public Annotation.Builder clearPayload()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

    • getPayloadBuilder

      public com.google.protobuf.Value.Builder getPayloadBuilder()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

    • getPayloadOrBuilder

      public com.google.protobuf.ValueOrBuilder getPayloadOrBuilder()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayloadOrBuilder in interface AnnotationOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface AnnotationOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface AnnotationOrBuilder
      Returns:
      The createTime.

    • setCreateTime

      public Annotation.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCreateTime

      public Annotation.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCreateTime

      public Annotation.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface AnnotationOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface AnnotationOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface AnnotationOrBuilder
      Returns:
      The updateTime.

    • setUpdateTime

      public Annotation.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setUpdateTime

      public Annotation.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeUpdateTime

      public Annotation.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface AnnotationOrBuilder

    • 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];
      Specified by:
      getEtag in interface AnnotationOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.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];
      Specified by:
      getEtagBytes in interface AnnotationOrBuilder
      Returns:
      The bytes for etag.

    • setEtag

      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];
      Parameters:
      value - The etag to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setEtagBytes

      public Annotation.Builder setEtagBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for etag to set.
      Returns:
      This builder for chaining.

    • hasAnnotationSource

      public boolean hasAnnotationSource()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasAnnotationSource in interface AnnotationOrBuilder
      Returns:
      Whether the annotationSource field is set.

    • getAnnotationSource

      public UserActionReference getAnnotationSource()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAnnotationSource in interface AnnotationOrBuilder
      Returns:
      The annotationSource.

    • setAnnotationSource

      public Annotation.Builder setAnnotationSource(UserActionReference value)
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setAnnotationSource

      public Annotation.Builder setAnnotationSource(UserActionReference.Builder builderForValue)
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeAnnotationSource

      public Annotation.Builder mergeAnnotationSource(UserActionReference value)
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearAnnotationSource

      public Annotation.Builder clearAnnotationSource()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getAnnotationSourceBuilder

      public UserActionReference.Builder getAnnotationSourceBuilder()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getAnnotationSourceOrBuilder

      public UserActionReferenceOrBuilder getAnnotationSourceOrBuilder()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAnnotationSourceOrBuilder in interface AnnotationOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: AnnotationOrBuilder
       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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface AnnotationOrBuilder

    • containsLabels

      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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface AnnotationOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface AnnotationOrBuilder

    • 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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface AnnotationOrBuilder

    • getLabelsOrDefault

      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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface AnnotationOrBuilder

    • getLabelsOrThrow

      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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface AnnotationOrBuilder

    • clearLabels

      public Annotation.Builder clearLabels()

    • removeLabels

      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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • putAllLabels

      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][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
 title.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];