public final class DataItem extends GeneratedMessageV3 implements DataItemOrBuilder
A piece of data in a Dataset. Could be an image, a video, a document or plain
text.
Protobuf type google.cloud.aiplatform.v1.DataItem
Fields
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 UPDATE_TIME_FIELD_NUMBER
Field Value
Methods
public boolean containsLabels(String key)
Optional. The labels with user-defined metadata to organize your DataItems.
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 DataItem(System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this DataItem was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this DataItem was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public static DataItem getDefaultInstance()
Returns
public DataItem 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 = 7 [(.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
public Map<String,String> getLabels()
Returns
public int getLabelsCount()
Optional. The labels with user-defined metadata to organize your DataItems.
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 DataItem(System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
public Map<String,String> getLabelsMap()
Optional. The labels with user-defined metadata to organize your DataItems.
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 DataItem(System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
public String getLabelsOrDefault(String key, String defaultValue)
Optional. The labels with user-defined metadata to organize your DataItems.
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 DataItem(System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
public String getLabelsOrThrow(String key)
Optional. The labels with user-defined metadata to organize your DataItems.
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 DataItem(System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
Output only. The resource name of the DataItem.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. The resource name of the DataItem.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Parser<DataItem> getParserForType()
Returns
Overrides
public Value getPayload()
Required. The data that the DataItem represents (for example, an image or a text
snippet). The schema of the payload is stored in the parent Dataset's
metadata schema's dataItemSchemaUri field.
.google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| Value | The payload.
|
public ValueOrBuilder getPayloadOrBuilder()
Required. The data that the DataItem represents (for example, an image or a text
snippet). The schema of the payload is stored in the parent Dataset's
metadata schema's dataItemSchemaUri field.
.google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this DataItem was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this DataItem was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this DataItem was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public boolean hasPayload()
Required. The data that the DataItem represents (for example, an image or a text
snippet). The schema of the payload is stored in the parent Dataset's
metadata schema's dataItemSchemaUri field.
.google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the payload field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this DataItem was last updated.
.google.protobuf.Timestamp update_time = 6 [(.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 DataItem.Builder newBuilder()
Returns
public static DataItem.Builder newBuilder(DataItem prototype)
Parameter
Returns
public DataItem.Builder newBuilderForType()
Returns
protected DataItem.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static DataItem parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataItem parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataItem parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static DataItem parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataItem parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static DataItem parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataItem parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DataItem parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataItem parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataItem parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataItem parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static DataItem parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<DataItem> parser()
Returns
public DataItem.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
