public final class Annotation extends GeneratedMessageV3 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
Fields
public static final int ANNOTATION_SOURCE_FIELD_NUMBER
Field Value
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int ETAG_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int PAYLOAD_FIELD_NUMBER
Field Value
public static final int PAYLOAD_SCHEMA_URI_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Methods
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];
public boolean equals(Object obj)
Parameter
Returns
Overrides
public UserActionReference getAnnotationSource()
Output only. The source of the Annotation.
.google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UserActionReferenceOrBuilder getAnnotationSourceOrBuilder()
Output only. The source of the Annotation.
.google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Timestamp getCreateTime()
Output only. Timestamp when this Annotation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Annotation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public static Annotation getDefaultInstance()
Returns
public Annotation getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
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];
| Type | Description |
| String | The etag.
|
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];
public Map<String,String> getLabels()
Returns
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];
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];
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];
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];
Output only. Resource name of the Annotation.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. Resource name of the Annotation.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Parser<Annotation> getParserForType()
Returns
Overrides
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];
| Type | Description |
| Value | The payload.
|
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];
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];
| Type | Description |
| String | The payloadSchemaUri.
|
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];
| Type | Description |
| ByteString | The bytes for payloadSchemaUri.
|
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this Annotation was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Annotation was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasAnnotationSource()
Output only. The source of the Annotation.
.google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the annotationSource field is set.
|
public boolean hasCreateTime()
Output only. Timestamp when this Annotation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
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];
| Type | Description |
| boolean | Whether the payload field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this Annotation was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public static Annotation.Builder newBuilder()
Returns
public static Annotation.Builder newBuilder(Annotation prototype)
Parameter
Returns
public Annotation.Builder newBuilderForType()
Returns
protected Annotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Annotation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Annotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Annotation parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static Annotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Annotation parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static Annotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Annotation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Annotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Annotation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Annotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Annotation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static Annotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<Annotation> parser()
Returns
public Annotation.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
