com.google.cloud.aiplatform.v1

Class DataItem

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.DataItem

All Implemented Interfaces:

DataItemOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DataItem
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataItem.Builder A piece of data in a Dataset.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_TIME_FIELD_NUMBER
static int	ETAG_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PAYLOAD_FIELD_NUMBER
static int	SATISFIES_PZI_FIELD_NUMBER
static int	SATISFIES_PZS_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
static DataItem	getDefaultInstance()
DataItem	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEtag() Optional.
com.google.protobuf.ByteString	getEtagBytes() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Parser<DataItem>	getParserForType()
com.google.protobuf.Value	getPayload() Required.
com.google.protobuf.ValueOrBuilder	getPayloadOrBuilder() Required.
boolean	getSatisfiesPzi() Output only.
boolean	getSatisfiesPzs() Output only.
int	getSerializedSize()
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
int	hashCode()
boolean	hasPayload() Required.
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static DataItem.Builder	newBuilder()
static DataItem.Builder	newBuilder(DataItem prototype)
DataItem.Builder	newBuilderForType()
protected DataItem.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DataItem	parseDelimitedFrom(InputStream input)
static DataItem	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataItem	parseFrom(byte[] data)
static DataItem	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataItem	parseFrom(ByteBuffer data)
static DataItem	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataItem	parseFrom(com.google.protobuf.ByteString data)
static DataItem	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataItem	parseFrom(com.google.protobuf.CodedInputStream input)
static DataItem	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataItem	parseFrom(InputStream input)
static DataItem	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DataItem>	parser()
DataItem.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER

See Also:

Constant Field Values

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

See Also:

Constant Field Values

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER

See Also:

Constant Field Values

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Output only. The resource name of the DataItem.
 

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

Specified by:

getName in interface DataItemOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the DataItem.
 

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

Specified by:

getNameBytes in interface DataItemOrBuilder

Returns:

The bytes for name.

hasCreateTime

public boolean hasCreateTime()

 Output only. Timestamp when this DataItem was created.
 

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

Specified by:

hasCreateTime in interface DataItemOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this DataItem was created.
 

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

Specified by:

getCreateTime in interface DataItemOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this DataItem was created.
 

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

Specified by:

getCreateTimeOrBuilder in interface DataItemOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Timestamp when this DataItem was last updated.
 

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

Specified by:

hasUpdateTime in interface DataItemOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp when this DataItem was last updated.
 

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

Specified by:

getUpdateTime in interface DataItemOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when this DataItem was last updated.
 

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

Specified by:

getUpdateTimeOrBuilder in interface DataItemOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: DataItemOrBuilder

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

Specified by:

getLabelsCount in interface DataItemOrBuilder

containsLabels

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

Specified by:

containsLabels in interface DataItemOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface DataItemOrBuilder

getLabelsMap

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

Specified by:

getLabelsMap in interface DataItemOrBuilder

getLabelsOrDefault

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

Specified by:

getLabelsOrDefault in interface DataItemOrBuilder

getLabelsOrThrow

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

Specified by:

getLabelsOrThrow in interface DataItemOrBuilder

hasPayload

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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
 dataItemSchemaUri field.
 

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

Specified by:

hasPayload in interface DataItemOrBuilder

Returns:

Whether the payload field is set.

getPayload

public com.google.protobuf.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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
 dataItemSchemaUri field.
 

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

Specified by:

getPayload in interface DataItemOrBuilder

Returns:

The payload.

getPayloadOrBuilder

public com.google.protobuf.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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
 dataItemSchemaUri field.
 

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

Specified by:

getPayloadOrBuilder in interface DataItemOrBuilder

getEtag

public String getEtag()

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

Specified by:

getEtag in interface DataItemOrBuilder

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 = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEtagBytes in interface DataItemOrBuilder

Returns:

The bytes for etag.

getSatisfiesPzs

public boolean getSatisfiesPzs()

 Output only. Reserved for future use.
 

bool satisfies_pzs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getSatisfiesPzs in interface DataItemOrBuilder

Returns:

The satisfiesPzs.

getSatisfiesPzi

public boolean getSatisfiesPzi()

 Output only. Reserved for future use.
 

bool satisfies_pzi = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getSatisfiesPzi in interface DataItemOrBuilder

Returns:

The satisfiesPzi.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DataItem parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataItem parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataItem parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataItem parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataItem parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataItem parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataItem parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static DataItem parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static DataItem parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static DataItem parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseFrom

public static DataItem parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static DataItem parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

newBuilderForType

public DataItem.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DataItem.Builder newBuilder()

newBuilder

public static DataItem.Builder newBuilder(DataItem prototype)

toBuilder

public DataItem.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DataItem.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DataItem getDefaultInstance()

parser

public static com.google.protobuf.Parser<DataItem> parser()

getParserForType

public com.google.protobuf.Parser<DataItem> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DataItem getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder