Class Collection.Builder (0.1.0)

public static final class Collection.Builder extends GeneratedMessageV3.Builder<Collection.Builder> implements CollectionOrBuilder

Message describing Collection object

Protobuf type google.cloud.vectorsearch.v1beta.Collection

Implements

CollectionOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Collection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Collection.Builder
Overrides

build()

public Collection build()
Returns
Type Description
Collection

buildPartial()

public Collection buildPartial()
Returns
Type Description
Collection

clear()

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

clearCreateTime()

public Collection.Builder clearCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type Description
Collection.Builder

clearDataSchema()

public Collection.Builder clearDataSchema()

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Collection.Builder

clearDescription()

public Collection.Builder clearDescription()

Optional. User-specified description of the collection

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Collection.Builder

This builder for chaining.

clearDisplayName()

public Collection.Builder clearDisplayName()

Optional. User-specified display name of the collection

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Collection.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Collection.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Collection.Builder
Overrides

clearLabels()

public Collection.Builder clearLabels()
Returns
Type Description
Collection.Builder

clearName()

public Collection.Builder clearName()

Identifier. name of resource

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

Returns
Type Description
Collection.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Collection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Collection.Builder
Overrides

clearSchema() (deprecated)

public Collection.Builder clearSchema()

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Collection.Builder

clearUpdateTime()

public Collection.Builder clearUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type Description
Collection.Builder

clearVectorSchema()

public Collection.Builder clearVectorSchema()
Returns
Type Description
Collection.Builder

clone()

public Collection.Builder clone()
Returns
Type Description
Collection.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsVectorSchema(String key)

public boolean containsVectorSchema(String key)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. [Output only] Create time stamp

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp

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

Returns
Type Description
TimestampOrBuilder

getDataSchema()

public Struct getDataSchema()

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The dataSchema.

getDataSchemaBuilder()

public Struct.Builder getDataSchemaBuilder()

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getDataSchemaOrBuilder()

public StructOrBuilder getDataSchemaOrBuilder()

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public Collection getDefaultInstanceForType()
Returns
Type Description
Collection

getDescription()

public String getDescription()

Optional. User-specified description of the collection

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-specified description of the collection

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. User-specified display name of the collection

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User-specified display name of the collection

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableVectorSchema() (deprecated)

public Map<String,VectorField> getMutableVectorSchema()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,VectorField>

getName()

public String getName()

Identifier. name of resource

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. name of resource

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

Returns
Type Description
ByteString

The bytes for name.

getSchema() (deprecated)

public Struct getSchema()

Deprecated. google.cloud.vectorsearch.v1beta.Collection.schema is deprecated. See google/cloud/vectorsearch/v1beta/vectorsearch_service.proto;l=190

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The schema.

getSchemaBuilder() (deprecated)

public Struct.Builder getSchemaBuilder()

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getSchemaOrBuilder() (deprecated)

public StructOrBuilder getSchemaOrBuilder()

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. [Output only] Update time stamp

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp

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

Returns
Type Description
TimestampOrBuilder

getVectorSchema() (deprecated)

public Map<String,VectorField> getVectorSchema()

Use #getVectorSchemaMap() instead.

Returns
Type Description
Map<String,VectorField>

getVectorSchemaCount()

public int getVectorSchemaCount()

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Returns
Type Description
int

getVectorSchemaMap()

public Map<String,VectorField> getVectorSchemaMap()

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Returns
Type Description
Map<String,VectorField>

getVectorSchemaOrDefault(String key, VectorField defaultValue)

public VectorField getVectorSchemaOrDefault(String key, VectorField defaultValue)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Parameters
Name Description
key String
defaultValue VectorField
Returns
Type Description
VectorField

getVectorSchemaOrThrow(String key)

public VectorField getVectorSchemaOrThrow(String key)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Parameter
Name Description
key String
Returns
Type Description
VectorField

hasCreateTime()

public boolean hasCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataSchema()

public boolean hasDataSchema()

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataSchema field is set.

hasSchema() (deprecated)

public boolean hasSchema()

Deprecated. google.cloud.vectorsearch.v1beta.Collection.schema is deprecated. See google/cloud/vectorsearch/v1beta/vectorsearch_service.proto;l=190

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the schema field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Collection.Builder mergeCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Collection.Builder

mergeDataSchema(Struct value)

public Collection.Builder mergeDataSchema(Struct value)

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
Collection.Builder

mergeFrom(Collection other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeSchema(Struct value) (deprecated)

public Collection.Builder mergeSchema(Struct value)

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
Collection.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Collection.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Collection.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Collection.Builder mergeUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Collection.Builder

putAllLabels(Map<String,String> values)

public Collection.Builder putAllLabels(Map<String,String> values)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

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

putAllVectorSchema(Map<String,VectorField> values)

public Collection.Builder putAllVectorSchema(Map<String,VectorField> values)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Parameter
Name Description
values Map<String,VectorField>
Returns
Type Description
Collection.Builder

putLabels(String key, String value)

public Collection.Builder putLabels(String key, String value)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Collection.Builder

putVectorSchema(String key, VectorField value)

public Collection.Builder putVectorSchema(String key, VectorField value)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Parameters
Name Description
key String
value VectorField
Returns
Type Description
Collection.Builder

putVectorSchemaBuilderIfAbsent(String key)

public VectorField.Builder putVectorSchemaBuilderIfAbsent(String key)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Parameter
Name Description
key String
Returns
Type Description
VectorField.Builder

removeLabels(String key)

public Collection.Builder removeLabels(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Collection.Builder

removeVectorSchema(String key)

public Collection.Builder removeVectorSchema(String key)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable.

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

Parameter
Name Description
key String
Returns
Type Description
Collection.Builder

setCreateTime(Timestamp value)

public Collection.Builder setCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Collection.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Collection.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Collection.Builder

setDataSchema(Struct value)

public Collection.Builder setDataSchema(Struct value)

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
Collection.Builder

setDataSchema(Struct.Builder builderForValue)

public Collection.Builder setDataSchema(Struct.Builder builderForValue)

Optional. JSON Schema for data.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Collection.Builder

setDescription(String value)

public Collection.Builder setDescription(String value)

Optional. User-specified description of the collection

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Collection.Builder setDescriptionBytes(ByteString value)

Optional. User-specified description of the collection

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setDisplayName(String value)

public Collection.Builder setDisplayName(String value)

Optional. User-specified display name of the collection

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Collection.Builder setDisplayNameBytes(ByteString value)

Optional. User-specified display name of the collection

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Collection.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Collection.Builder
Overrides

setName(String value)

public Collection.Builder setName(String value)

Identifier. name of resource

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Collection.Builder setNameBytes(ByteString value)

Identifier. name of resource

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Collection.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Collection.Builder
Overrides

setSchema(Struct value) (deprecated)

public Collection.Builder setSchema(Struct value)

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
Collection.Builder

setSchema(Struct.Builder builderForValue) (deprecated)

public Collection.Builder setSchema(Struct.Builder builderForValue)

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Collection.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Collection.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Collection.Builder
Overrides

setUpdateTime(Timestamp value)

public Collection.Builder setUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Collection.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Collection.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Collection.Builder