Class DataObject.Builder (0.6.0)

public static final class DataObject.Builder extends GeneratedMessage.Builder<DataObject.Builder> implements DataObjectOrBuilder

A dataObject resource in Vector Search.

Protobuf type google.cloud.vectorsearch.v1beta.DataObject

Implements

DataObjectOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public DataObject build()
Returns
Type Description
DataObject

buildPartial()

public DataObject buildPartial()
Returns
Type Description
DataObject

clear()

public DataObject.Builder clear()
Returns
Type Description
DataObject.Builder
Overrides

clearCreateTime()

public DataObject.Builder clearCreateTime()

Output only. Timestamp the dataObject was created at.

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

Returns
Type Description
DataObject.Builder

clearData()

public DataObject.Builder clearData()

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataObject.Builder

clearDataObjectId() (deprecated)

public DataObject.Builder clearDataObjectId()

Deprecated. google.cloud.vectorsearch.v1beta.DataObject.data_object_id is deprecated. See google/cloud/vectorsearch/v1beta/data_object.proto;l=46

Output only. The id of the dataObject.

string data_object_id = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataObject.Builder

This builder for chaining.

clearName()

public DataObject.Builder clearName()

Identifier. The fully qualified resource name of the dataObject.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id} The data_object_id must be 1-63 characters long, and comply with RFC1035.

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

Returns
Type Description
DataObject.Builder

This builder for chaining.

clearUpdateTime()

public DataObject.Builder clearUpdateTime()

Output only. Timestamp the dataObject was last updated.

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

Returns
Type Description
DataObject.Builder

clearVectors()

public DataObject.Builder clearVectors()
Returns
Type Description
DataObject.Builder

containsVectors(String key)

public boolean containsVectors(String key)

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp the dataObject was created at.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp the dataObject was created at.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp the dataObject was created at.

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

Returns
Type Description
TimestampOrBuilder

getData()

public Struct getData()

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The data.

getDataBuilder()

public Struct.Builder getDataBuilder()

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getDataObjectId() (deprecated)

public String getDataObjectId()

Deprecated. google.cloud.vectorsearch.v1beta.DataObject.data_object_id is deprecated. See google/cloud/vectorsearch/v1beta/data_object.proto;l=46

Output only. The id of the dataObject.

string data_object_id = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dataObjectId.

getDataObjectIdBytes() (deprecated)

public ByteString getDataObjectIdBytes()

Deprecated. google.cloud.vectorsearch.v1beta.DataObject.data_object_id is deprecated. See google/cloud/vectorsearch/v1beta/data_object.proto;l=46

Output only. The id of the dataObject.

string data_object_id = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dataObjectId.

getDataOrBuilder()

public StructOrBuilder getDataOrBuilder()

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public DataObject getDefaultInstanceForType()
Returns
Type Description
DataObject

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableVectors() (deprecated)

public Map<String,Vector> getMutableVectors()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Vector>

getName()

public String getName()

Identifier. The fully qualified resource name of the dataObject.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id} The data_object_id must be 1-63 characters long, and comply with RFC1035.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The fully qualified resource name of the dataObject.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id} The data_object_id must be 1-63 characters long, and comply with RFC1035.

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

Returns
Type Description
ByteString

The bytes for name.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp the dataObject was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp the dataObject was last updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp the dataObject was last updated.

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

Returns
Type Description
TimestampOrBuilder

getVectors() (deprecated)

public Map<String,Vector> getVectors()

Use #getVectorsMap() instead.

Returns
Type Description
Map<String,Vector>

getVectorsCount()

public int getVectorsCount()

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVectorsMap()

public Map<String,Vector> getVectorsMap()

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Vector>

getVectorsOrDefault(String key, Vector defaultValue)

public Vector getVectorsOrDefault(String key, Vector defaultValue)

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue Vector
Returns
Type Description
Vector

getVectorsOrThrow(String key)

public Vector getVectorsOrThrow(String key)

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Vector

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp the dataObject was created at.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasData()

public boolean hasData()

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the data field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp the dataObject was last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public DataObject.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp the dataObject was created at.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DataObject.Builder

mergeData(Struct value)

public DataObject.Builder mergeData(Struct value)

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
DataObject.Builder

mergeFrom(DataObject other)

public DataObject.Builder mergeFrom(DataObject other)
Parameter
Name Description
other DataObject
Returns
Type Description
DataObject.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataObject.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataObject.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataObject.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataObject.Builder
Overrides

mergeUpdateTime(Timestamp value)

public DataObject.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp the dataObject was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DataObject.Builder

putAllVectors(Map<String,Vector> values)

public DataObject.Builder putAllVectors(Map<String,Vector> values)

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,Vector>
Returns
Type Description
DataObject.Builder

putVectors(String key, Vector value)

public DataObject.Builder putVectors(String key, Vector value)

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value Vector
Returns
Type Description
DataObject.Builder

putVectorsBuilderIfAbsent(String key)

public Vector.Builder putVectorsBuilderIfAbsent(String key)

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Vector.Builder

removeVectors(String key)

public DataObject.Builder removeVectors(String key)

Optional. The vectors of the dataObject.

map<string, .google.cloud.vectorsearch.v1beta.Vector> vectors = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
DataObject.Builder

setCreateTime(Timestamp value)

public DataObject.Builder setCreateTime(Timestamp value)

Output only. Timestamp the dataObject was created at.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DataObject.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DataObject.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp the dataObject was created at.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataObject.Builder

setData(Struct value)

public DataObject.Builder setData(Struct value)

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
DataObject.Builder

setData(Struct.Builder builderForValue)

public DataObject.Builder setData(Struct.Builder builderForValue)

Optional. The data of the dataObject.

.google.protobuf.Struct data = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataObject.Builder

setDataObjectId(String value) (deprecated)

public DataObject.Builder setDataObjectId(String value)

Deprecated. google.cloud.vectorsearch.v1beta.DataObject.data_object_id is deprecated. See google/cloud/vectorsearch/v1beta/data_object.proto;l=46

Output only. The id of the dataObject.

string data_object_id = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The dataObjectId to set.

Returns
Type Description
DataObject.Builder

This builder for chaining.

setDataObjectIdBytes(ByteString value) (deprecated)

public DataObject.Builder setDataObjectIdBytes(ByteString value)

Deprecated. google.cloud.vectorsearch.v1beta.DataObject.data_object_id is deprecated. See google/cloud/vectorsearch/v1beta/data_object.proto;l=46

Output only. The id of the dataObject.

string data_object_id = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for dataObjectId to set.

Returns
Type Description
DataObject.Builder

This builder for chaining.

setName(String value)

public DataObject.Builder setName(String value)

Identifier. The fully qualified resource name of the dataObject.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id} The data_object_id must be 1-63 characters long, and comply with RFC1035.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DataObject.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataObject.Builder setNameBytes(ByteString value)

Identifier. The fully qualified resource name of the dataObject.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id} The data_object_id must be 1-63 characters long, and comply with RFC1035.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DataObject.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public DataObject.Builder setUpdateTime(Timestamp value)

Output only. Timestamp the dataObject was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DataObject.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DataObject.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp the dataObject was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataObject.Builder